cribl-control-plane 0.2.1rc11__py3-none-any.whl → 0.4.0a6__py3-none-any.whl

cribl_control_plane/models/inputcloudflarehec.py

@@ -0,0 +1,513 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane import models, utils
+from cribl_control_plane.types import BaseModel
+from cribl_control_plane.utils import validate_open_enum
+from enum import Enum
+import pydantic
+from pydantic import field_serializer
+from pydantic.functional_validators import PlainValidator
+from typing import Any, List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class InputCloudflareHecType(str, Enum):
+    CLOUDFLARE_HEC = "cloudflare_hec"
+
+
+class InputCloudflareHecConnectionTypedDict(TypedDict):
+    output: str
+    pipeline: NotRequired[str]
+
+
+class InputCloudflareHecConnection(BaseModel):
+    output: str
+
+    pipeline: Optional[str] = None
+
+
+class InputCloudflareHecMode(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
+
+    # Smart
+    SMART = "smart"
+    # Always On
+    ALWAYS = "always"
+
+
+class InputCloudflareHecCompression(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Codec to use to compress the persisted data"""
+
+    # None
+    NONE = "none"
+    # Gzip
+    GZIP = "gzip"
+
+
+class InputCloudflareHecPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputCloudflareHecPqControls(BaseModel):
+    pass
+
+
+class InputCloudflareHecPqTypedDict(TypedDict):
+    mode: NotRequired[InputCloudflareHecMode]
+    r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
+    max_buffer_size: NotRequired[float]
+    r"""The maximum number of events to hold in memory before writing the events to disk"""
+    commit_frequency: NotRequired[float]
+    r"""The number of events to send downstream before committing that Stream has read them"""
+    max_file_size: NotRequired[str]
+    r"""The maximum size to store in each queue file before closing and optionally compressing. Enter a numeral with units of KB, MB, etc."""
+    max_size: NotRequired[str]
+    r"""The maximum disk space that the queue can consume (as an average per Worker Process) before queueing stops. Enter a numeral with units of KB, MB, etc."""
+    path: NotRequired[str]
+    r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
+    compress: NotRequired[InputCloudflareHecCompression]
+    r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputCloudflareHecPqControlsTypedDict]
+
+
+class InputCloudflareHecPq(BaseModel):
+    mode: Annotated[
+        Optional[InputCloudflareHecMode], PlainValidator(validate_open_enum(False))
+    ] = InputCloudflareHecMode.ALWAYS
+    r"""With Smart mode, PQ will write events to the filesystem only when it detects backpressure from the processing engine. With Always On mode, PQ will always write events directly to the queue before forwarding them to the processing engine."""
+
+    max_buffer_size: Annotated[
+        Optional[float], pydantic.Field(alias="maxBufferSize")
+    ] = 1000
+    r"""The maximum number of events to hold in memory before writing the events to disk"""
+
+    commit_frequency: Annotated[
+        Optional[float], pydantic.Field(alias="commitFrequency")
+    ] = 42
+    r"""The number of events to send downstream before committing that Stream has read them"""
+
+    max_file_size: Annotated[Optional[str], pydantic.Field(alias="maxFileSize")] = (
+        "1 MB"
+    )
+    r"""The maximum size to store in each queue file before closing and optionally compressing. Enter a numeral with units of KB, MB, etc."""
+
+    max_size: Annotated[Optional[str], pydantic.Field(alias="maxSize")] = "5GB"
+    r"""The maximum disk space that the queue can consume (as an average per Worker Process) before queueing stops. Enter a numeral with units of KB, MB, etc."""
+
+    path: Optional[str] = "$CRIBL_HOME/state/queues"
+    r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
+
+    compress: Annotated[
+        Optional[InputCloudflareHecCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputCloudflareHecCompression.NONE
+    r"""Codec to use to compress the persisted data"""
+
+    pq_controls: Annotated[
+        Optional[InputCloudflareHecPqControls], pydantic.Field(alias="pqControls")
+    ] = None
+
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputCloudflareHecMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputCloudflareHecCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputCloudflareHecAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Select Secret to use a text secret to authenticate"""
+
+    SECRET = "secret"
+
+
+class InputCloudflareHecAuthTokenMetadatumTypedDict(TypedDict):
+    name: str
+    value: str
+    r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
+
+
+class InputCloudflareHecAuthTokenMetadatum(BaseModel):
+    name: str
+
+    value: str
+    r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
+
+
+class InputCloudflareHecAuthTokenTypedDict(TypedDict):
+    auth_type: NotRequired[InputCloudflareHecAuthenticationMethod]
+    r"""Select Secret to use a text secret to authenticate"""
+    token_secret: NotRequired[Any]
+    token: NotRequired[Any]
+    enabled: NotRequired[bool]
+    description: NotRequired[str]
+    allowed_indexes_at_token: NotRequired[List[str]]
+    r"""Enter the values you want to allow in the HEC event index field at the token level. Supports wildcards. To skip validation, leave blank."""
+    metadata: NotRequired[List[InputCloudflareHecAuthTokenMetadatumTypedDict]]
+    r"""Fields to add to events referencing this token"""
+
+
+class InputCloudflareHecAuthToken(BaseModel):
+    auth_type: Annotated[
+        Annotated[
+            Optional[InputCloudflareHecAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
+    ] = InputCloudflareHecAuthenticationMethod.SECRET
+    r"""Select Secret to use a text secret to authenticate"""
+
+    token_secret: Annotated[Optional[Any], pydantic.Field(alias="tokenSecret")] = None
+
+    token: Optional[Any] = None
+
+    enabled: Optional[bool] = True
+
+    description: Optional[str] = None
+
+    allowed_indexes_at_token: Annotated[
+        Optional[List[str]], pydantic.Field(alias="allowedIndexesAtToken")
+    ] = None
+    r"""Enter the values you want to allow in the HEC event index field at the token level. Supports wildcards. To skip validation, leave blank."""
+
+    metadata: Optional[List[InputCloudflareHecAuthTokenMetadatum]] = None
+    r"""Fields to add to events referencing this token"""
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputCloudflareHecAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputCloudflareHecMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
+    TL_SV1 = "TLSv1"
+    TL_SV1_1 = "TLSv1.1"
+    TL_SV1_2 = "TLSv1.2"
+    TL_SV1_3 = "TLSv1.3"
+
+
+class InputCloudflareHecMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
+    TL_SV1 = "TLSv1"
+    TL_SV1_1 = "TLSv1.1"
+    TL_SV1_2 = "TLSv1.2"
+    TL_SV1_3 = "TLSv1.3"
+
+
+class InputCloudflareHecTLSSettingsServerSideTypedDict(TypedDict):
+    disabled: NotRequired[bool]
+    request_cert: NotRequired[bool]
+    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
+    reject_unauthorized: NotRequired[bool]
+    r"""Reject certificates not authorized by a CA in the CA certificate path or by another trusted CA (such as the system's)"""
+    common_name_regex: NotRequired[str]
+    r"""Regex matching allowable common names in peer certificates' subject attribute"""
+    certificate_name: NotRequired[str]
+    r"""The name of the predefined certificate"""
+    priv_key_path: NotRequired[str]
+    r"""Path on server containing the private key to use. PEM format. Can reference $ENV_VARS."""
+    passphrase: NotRequired[str]
+    r"""Passphrase to use to decrypt private key"""
+    cert_path: NotRequired[str]
+    r"""Path on server containing certificates to use. PEM format. Can reference $ENV_VARS."""
+    ca_path: NotRequired[str]
+    r"""Path on server containing CA certificates to use. PEM format. Can reference $ENV_VARS."""
+    min_version: NotRequired[InputCloudflareHecMinimumTLSVersion]
+    max_version: NotRequired[InputCloudflareHecMaximumTLSVersion]
+
+
+class InputCloudflareHecTLSSettingsServerSide(BaseModel):
+    disabled: Optional[bool] = True
+
+    request_cert: Annotated[Optional[bool], pydantic.Field(alias="requestCert")] = False
+    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
+
+    reject_unauthorized: Annotated[
+        Optional[bool], pydantic.Field(alias="rejectUnauthorized")
+    ] = True
+    r"""Reject certificates not authorized by a CA in the CA certificate path or by another trusted CA (such as the system's)"""
+
+    common_name_regex: Annotated[
+        Optional[str], pydantic.Field(alias="commonNameRegex")
+    ] = "/.*/"
+    r"""Regex matching allowable common names in peer certificates' subject attribute"""
+
+    certificate_name: Annotated[
+        Optional[str], pydantic.Field(alias="certificateName")
+    ] = None
+    r"""The name of the predefined certificate"""
+
+    priv_key_path: Annotated[Optional[str], pydantic.Field(alias="privKeyPath")] = None
+    r"""Path on server containing the private key to use. PEM format. Can reference $ENV_VARS."""
+
+    passphrase: Optional[str] = None
+    r"""Passphrase to use to decrypt private key"""
+
+    cert_path: Annotated[Optional[str], pydantic.Field(alias="certPath")] = None
+    r"""Path on server containing certificates to use. PEM format. Can reference $ENV_VARS."""
+
+    ca_path: Annotated[Optional[str], pydantic.Field(alias="caPath")] = None
+    r"""Path on server containing CA certificates to use. PEM format. Can reference $ENV_VARS."""
+
+    min_version: Annotated[
+        Annotated[
+            Optional[InputCloudflareHecMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="minVersion"),
+    ] = None
+
+    max_version: Annotated[
+        Annotated[
+            Optional[InputCloudflareHecMaximumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="maxVersion"),
+    ] = None
+
+    @field_serializer("min_version")
+    def serialize_min_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputCloudflareHecMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputCloudflareHecMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputCloudflareHecMetadatumTypedDict(TypedDict):
+    name: str
+    value: str
+    r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
+
+
+class InputCloudflareHecMetadatum(BaseModel):
+    name: str
+
+    value: str
+    r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
+
+
+class InputCloudflareHecTypedDict(TypedDict):
+    type: InputCloudflareHecType
+    port: float
+    r"""Port to listen on"""
+    hec_api: str
+    r"""Absolute path on which to listen for the Cloudflare HTTP Event Collector API requests. This input supports the /event endpoint."""
+    id: NotRequired[str]
+    r"""Unique ID for this input"""
+    disabled: NotRequired[bool]
+    pipeline: NotRequired[str]
+    r"""Pipeline to process data from this Source before sending it through the Routes"""
+    send_to_routes: NotRequired[bool]
+    r"""Select whether to send data to Routes, or directly to Destinations."""
+    environment: NotRequired[str]
+    r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
+    pq_enabled: NotRequired[bool]
+    r"""Use a disk queue to minimize data loss when connected services block. See [Cribl Docs](https://docs.cribl.io/stream/persistent-queues) for PQ defaults (Cribl-managed Cloud Workers) and configuration options (on-prem and hybrid Workers)."""
+    streamtags: NotRequired[List[str]]
+    r"""Tags for filtering and grouping in @{product}"""
+    connections: NotRequired[List[InputCloudflareHecConnectionTypedDict]]
+    r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
+    pq: NotRequired[InputCloudflareHecPqTypedDict]
+    host: NotRequired[str]
+    r"""Address to bind on. Defaults to 0.0.0.0 (all addresses)."""
+    auth_tokens: NotRequired[List[InputCloudflareHecAuthTokenTypedDict]]
+    r"""Shared secrets to be provided by any client (Authorization: <token>). If empty, unauthorized access is permitted."""
+    tls: NotRequired[InputCloudflareHecTLSSettingsServerSideTypedDict]
+    max_active_req: NotRequired[float]
+    r"""Maximum number of active requests allowed per Worker Process. Set to 0 for unlimited. Caution: Increasing the limit above the default value, or setting it to unlimited, may degrade performance and reduce throughput."""
+    max_requests_per_socket: NotRequired[int]
+    r"""Maximum number of requests per socket before @{product} instructs the client to close the connection. Default is 0 (unlimited)."""
+    enable_proxy_header: NotRequired[bool]
+    r"""Extract the client IP and port from PROXY protocol v1/v2. When enabled, the X-Forwarded-For header is ignored. Disable to use the X-Forwarded-For header for client IP extraction."""
+    capture_headers: NotRequired[bool]
+    r"""Add request headers to events, in the __headers field"""
+    activity_log_sample_rate: NotRequired[float]
+    r"""How often request activity is logged at the `info` level. A value of 1 would log every request, 10 every 10th request, etc."""
+    request_timeout: NotRequired[float]
+    r"""How long to wait for an incoming request to complete before aborting it. Use 0 to disable."""
+    socket_timeout: NotRequired[float]
+    r"""How long @{product} should wait before assuming that an inactive socket has timed out. To wait forever, set to 0."""
+    keep_alive_timeout: NotRequired[float]
+    r"""After the last response is sent, @{product} will wait this long for additional data before closing the socket connection. Minimum 1 second, maximum 600 seconds (10 minutes)."""
+    enable_health_check: NotRequired[Any]
+    ip_allowlist_regex: NotRequired[str]
+    r"""Messages from matched IP addresses will be processed, unless also matched by the denylist"""
+    ip_denylist_regex: NotRequired[str]
+    r"""Messages from matched IP addresses will be ignored. This takes precedence over the allowlist."""
+    metadata: NotRequired[List[InputCloudflareHecMetadatumTypedDict]]
+    r"""Fields to add to every event. May be overridden by fields added at the token or request level."""
+    allowed_indexes: NotRequired[List[str]]
+    r"""List values allowed in HEC event index field. Leave blank to skip validation. Supports wildcards. The values here can expand index validation at the token level."""
+    breaker_rulesets: NotRequired[List[str]]
+    r"""A list of event-breaking rulesets that will be applied, in order, to the input data stream"""
+    stale_channel_flush_ms: NotRequired[float]
+    r"""How long (in milliseconds) the Event Breaker will wait for new data to be sent to a specific channel before flushing the data stream out, as is, to the Pipelines"""
+    access_control_allow_origin: NotRequired[List[str]]
+    r"""HTTP origins to which @{product} should send CORS (cross-origin resource sharing) Access-Control-Allow-* headers. Supports wildcards."""
+    access_control_allow_headers: NotRequired[List[str]]
+    r"""HTTP headers that @{product} will send to allowed origins as \"Access-Control-Allow-Headers\" in a CORS preflight response. Use \"*\" to allow all headers."""
+    emit_token_metrics: NotRequired[bool]
+    r"""Emit per-token (<prefix>.http.perToken) and summary (<prefix>.http.summary) request metrics"""
+    description: NotRequired[str]
+
+
+class InputCloudflareHec(BaseModel):
+    type: InputCloudflareHecType
+
+    port: float
+    r"""Port to listen on"""
+
+    hec_api: Annotated[str, pydantic.Field(alias="hecAPI")]
+    r"""Absolute path on which to listen for the Cloudflare HTTP Event Collector API requests. This input supports the /event endpoint."""
+
+    id: Optional[str] = None
+    r"""Unique ID for this input"""
+
+    disabled: Optional[bool] = False
+
+    pipeline: Optional[str] = None
+    r"""Pipeline to process data from this Source before sending it through the Routes"""
+
+    send_to_routes: Annotated[Optional[bool], pydantic.Field(alias="sendToRoutes")] = (
+        True
+    )
+    r"""Select whether to send data to Routes, or directly to Destinations."""
+
+    environment: Optional[str] = None
+    r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
+
+    pq_enabled: Annotated[Optional[bool], pydantic.Field(alias="pqEnabled")] = False
+    r"""Use a disk queue to minimize data loss when connected services block. See [Cribl Docs](https://docs.cribl.io/stream/persistent-queues) for PQ defaults (Cribl-managed Cloud Workers) and configuration options (on-prem and hybrid Workers)."""
+
+    streamtags: Optional[List[str]] = None
+    r"""Tags for filtering and grouping in @{product}"""
+
+    connections: Optional[List[InputCloudflareHecConnection]] = None
+    r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
+
+    pq: Optional[InputCloudflareHecPq] = None
+
+    host: Optional[str] = "0.0.0.0"
+    r"""Address to bind on. Defaults to 0.0.0.0 (all addresses)."""
+
+    auth_tokens: Annotated[
+        Optional[List[InputCloudflareHecAuthToken]], pydantic.Field(alias="authTokens")
+    ] = None
+    r"""Shared secrets to be provided by any client (Authorization: <token>). If empty, unauthorized access is permitted."""
+
+    tls: Optional[InputCloudflareHecTLSSettingsServerSide] = None
+
+    max_active_req: Annotated[Optional[float], pydantic.Field(alias="maxActiveReq")] = (
+        256
+    )
+    r"""Maximum number of active requests allowed per Worker Process. Set to 0 for unlimited. Caution: Increasing the limit above the default value, or setting it to unlimited, may degrade performance and reduce throughput."""
+
+    max_requests_per_socket: Annotated[
+        Optional[int], pydantic.Field(alias="maxRequestsPerSocket")
+    ] = 0
+    r"""Maximum number of requests per socket before @{product} instructs the client to close the connection. Default is 0 (unlimited)."""
+
+    enable_proxy_header: Annotated[
+        Optional[bool], pydantic.Field(alias="enableProxyHeader")
+    ] = False
+    r"""Extract the client IP and port from PROXY protocol v1/v2. When enabled, the X-Forwarded-For header is ignored. Disable to use the X-Forwarded-For header for client IP extraction."""
+
+    capture_headers: Annotated[
+        Optional[bool], pydantic.Field(alias="captureHeaders")
+    ] = False
+    r"""Add request headers to events, in the __headers field"""
+
+    activity_log_sample_rate: Annotated[
+        Optional[float], pydantic.Field(alias="activityLogSampleRate")
+    ] = 100
+    r"""How often request activity is logged at the `info` level. A value of 1 would log every request, 10 every 10th request, etc."""
+
+    request_timeout: Annotated[
+        Optional[float], pydantic.Field(alias="requestTimeout")
+    ] = 0
+    r"""How long to wait for an incoming request to complete before aborting it. Use 0 to disable."""
+
+    socket_timeout: Annotated[
+        Optional[float], pydantic.Field(alias="socketTimeout")
+    ] = 0
+    r"""How long @{product} should wait before assuming that an inactive socket has timed out. To wait forever, set to 0."""
+
+    keep_alive_timeout: Annotated[
+        Optional[float], pydantic.Field(alias="keepAliveTimeout")
+    ] = 5
+    r"""After the last response is sent, @{product} will wait this long for additional data before closing the socket connection. Minimum 1 second, maximum 600 seconds (10 minutes)."""
+
+    enable_health_check: Annotated[
+        Optional[Any], pydantic.Field(alias="enableHealthCheck")
+    ] = None
+
+    ip_allowlist_regex: Annotated[
+        Optional[str], pydantic.Field(alias="ipAllowlistRegex")
+    ] = "/.*/"
+    r"""Messages from matched IP addresses will be processed, unless also matched by the denylist"""
+
+    ip_denylist_regex: Annotated[
+        Optional[str], pydantic.Field(alias="ipDenylistRegex")
+    ] = "/^$/"
+    r"""Messages from matched IP addresses will be ignored. This takes precedence over the allowlist."""
+
+    metadata: Optional[List[InputCloudflareHecMetadatum]] = None
+    r"""Fields to add to every event. May be overridden by fields added at the token or request level."""
+
+    allowed_indexes: Annotated[
+        Optional[List[str]], pydantic.Field(alias="allowedIndexes")
+    ] = None
+    r"""List values allowed in HEC event index field. Leave blank to skip validation. Supports wildcards. The values here can expand index validation at the token level."""
+
+    breaker_rulesets: Annotated[
+        Optional[List[str]], pydantic.Field(alias="breakerRulesets")
+    ] = None
+    r"""A list of event-breaking rulesets that will be applied, in order, to the input data stream"""
+
+    stale_channel_flush_ms: Annotated[
+        Optional[float], pydantic.Field(alias="staleChannelFlushMs")
+    ] = 10000
+    r"""How long (in milliseconds) the Event Breaker will wait for new data to be sent to a specific channel before flushing the data stream out, as is, to the Pipelines"""
+
+    access_control_allow_origin: Annotated[
+        Optional[List[str]], pydantic.Field(alias="accessControlAllowOrigin")
+    ] = None
+    r"""HTTP origins to which @{product} should send CORS (cross-origin resource sharing) Access-Control-Allow-* headers. Supports wildcards."""
+
+    access_control_allow_headers: Annotated[
+        Optional[List[str]], pydantic.Field(alias="accessControlAllowHeaders")
+    ] = None
+    r"""HTTP headers that @{product} will send to allowed origins as \"Access-Control-Allow-Headers\" in a CORS preflight response. Use \"*\" to allow all headers."""
+
+    emit_token_metrics: Annotated[
+        Optional[bool], pydantic.Field(alias="emitTokenMetrics")
+    ] = False
+    r"""Emit per-token (<prefix>.http.perToken) and summary (<prefix>.http.summary) request metrics"""
+
+    description: Optional[str] = None

cribl_control_plane/models/inputfile.py

@@ -172,6 +172,8 @@ class InputFileTypedDict(TypedDict):
     r"""Time, in seconds, between scanning for files"""
     filenames: NotRequired[List[str]]
     r"""The full path of discovered files are matched against this wildcard list"""
+    filter_archived_files: NotRequired[bool]
+    r"""Apply filename allowlist to file entries in archive file types, like tar or zip."""
     tail_only: NotRequired[bool]
     r"""Read only new entries at the end of all files discovered at next startup. @{product} will then read newly discovered files from the head. Disable this to resume reading all files from head."""
     idle_timeout: NotRequired[float]
@@ -245,6 +247,11 @@ class InputFile(BaseModel):
     filenames: Optional[List[str]] = None
     r"""The full path of discovered files are matched against this wildcard list"""
 
+    filter_archived_files: Annotated[
+        Optional[bool], pydantic.Field(alias="filterArchivedFiles")
+    ] = False
+    r"""Apply filename allowlist to file entries in archive file types, like tar or zip."""
+
     tail_only: Annotated[Optional[bool], pydantic.Field(alias="tailOnly")] = True
     r"""Read only new entries at the end of all files discovered at next startup. @{product} will then read newly discovered files from the head. Disable this to resume reading all files from head."""
 

cribl_control_plane/models/listconfiggroupbyproductop.py

@@ -1,6 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .configgroup import ConfigGroup, ConfigGroupTypedDict
 from .productscore import ProductsCore
 from cribl_control_plane import models
 from cribl_control_plane.types import BaseModel
@@ -12,7 +13,7 @@ from cribl_control_plane.utils import (
 )
 from pydantic import field_serializer
 from pydantic.functional_validators import PlainValidator
-from typing import Optional
+from typing import List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
@@ -44,3 +45,20 @@ class ListConfigGroupByProductRequest(BaseModel):
             except ValueError:
                 return value
         return value
+
+
+class ListConfigGroupByProductResponseTypedDict(TypedDict):
+    r"""a list of ConfigGroup objects"""
+
+    count: NotRequired[int]
+    r"""number of items present in the items array"""
+    items: NotRequired[List[ConfigGroupTypedDict]]
+
+
+class ListConfigGroupByProductResponse(BaseModel):
+    r"""a list of ConfigGroup objects"""
+
+    count: Optional[int] = None
+    r"""number of items present in the items array"""
+
+    items: Optional[List[ConfigGroup]] = None

cribl_control_plane/models/{countedlistinput.py → listinputop.py}

@@ -7,13 +7,17 @@ from typing import List, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-class CountedListInputTypedDict(TypedDict):
+class ListInputResponseTypedDict(TypedDict):
+    r"""a list of Source objects"""
+
     count: NotRequired[int]
     r"""number of items present in the items array"""
     items: NotRequired[List[InputTypedDict]]
 
 
-class CountedListInput(BaseModel):
+class ListInputResponse(BaseModel):
+    r"""a list of Source objects"""
+
     count: Optional[int] = None
     r"""number of items present in the items array"""
 

cribl_control_plane/models/listmasterworkerentryop.py

@@ -1,10 +1,11 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
+from .masterworkerentry import MasterWorkerEntry, MasterWorkerEntryTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, QueryParamMetadata
 import pydantic
-from typing import Optional
+from typing import List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
@@ -62,3 +63,20 @@ class ListMasterWorkerEntryRequest(BaseModel):
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
     r"""Starting point from which to retrieve results for this request. Use with <code>limit</code> to paginate the response into manageable batches."""
+
+
+class ListMasterWorkerEntryResponseTypedDict(TypedDict):
+    r"""a list of MasterWorkerEntry objects"""
+
+    count: NotRequired[int]
+    r"""number of items present in the items array"""
+    items: NotRequired[List[MasterWorkerEntryTypedDict]]
+
+
+class ListMasterWorkerEntryResponse(BaseModel):
+    r"""a list of MasterWorkerEntry objects"""
+
+    count: Optional[int] = None
+    r"""number of items present in the items array"""
+
+    items: Optional[List[MasterWorkerEntry]] = None

cribl_control_plane/models/{countedlistoutput.py → listoutputop.py}

@@ -7,13 +7,17 @@ from typing import List, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-class CountedListOutputTypedDict(TypedDict):
+class ListOutputResponseTypedDict(TypedDict):
+    r"""a list of Destination objects"""
+
     count: NotRequired[int]
     r"""number of items present in the items array"""
     items: NotRequired[List[OutputTypedDict]]
 
 
-class CountedListOutput(BaseModel):
+class ListOutputResponse(BaseModel):
+    r"""a list of Destination objects"""
+
     count: Optional[int] = None
     r"""number of items present in the items array"""
 

cribl_control_plane/models/{countedlistpipeline.py → listpipelineop.py}

@@ -7,13 +7,17 @@ from typing import List, Optional
 from typing_extensions import NotRequired, TypedDict
 
 
-class CountedListPipelineTypedDict(TypedDict):
+class ListPipelineResponseTypedDict(TypedDict):
+    r"""a list of Pipeline objects"""
+
     count: NotRequired[int]
     r"""number of items present in the items array"""
     items: NotRequired[List[PipelineTypedDict]]
 
 
-class CountedListPipeline(BaseModel):
+class ListPipelineResponse(BaseModel):
+    r"""a list of Pipeline objects"""
+
     count: Optional[int] = None
     r"""number of items present in the items array"""