cribl-control-plane 0.0.13__py3-none-any.whl

cribl_control_plane/models/inputoffice365msgtrace.py

@@ -0,0 +1,449 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane import 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.functional_validators import PlainValidator
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class InputOffice365MsgTraceType(str, Enum, metaclass=utils.OpenEnumMeta):
+    OFFICE365_MSG_TRACE = "office365_msg_trace"
+
+
+class InputOffice365MsgTraceConnectionTypedDict(TypedDict):
+    output: str
+    pipeline: NotRequired[str]
+
+
+class InputOffice365MsgTraceConnection(BaseModel):
+    output: str
+
+    pipeline: Optional[str] = None
+
+
+class InputOffice365MsgTraceMode(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"
+    ALWAYS = "always"
+
+
+class InputOffice365MsgTraceCompression(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Codec to use to compress the persisted data"""
+
+    NONE = "none"
+    GZIP = "gzip"
+
+
+class InputOffice365MsgTracePqTypedDict(TypedDict):
+    mode: NotRequired[InputOffice365MsgTraceMode]
+    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[InputOffice365MsgTraceCompression]
+    r"""Codec to use to compress the persisted data"""
+
+
+class InputOffice365MsgTracePq(BaseModel):
+    mode: Annotated[
+        Optional[InputOffice365MsgTraceMode], PlainValidator(validate_open_enum(False))
+    ] = InputOffice365MsgTraceMode.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[InputOffice365MsgTraceCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputOffice365MsgTraceCompression.NONE
+    r"""Codec to use to compress the persisted data"""
+
+
+class InputOffice365MsgTraceAuthenticationMethod(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
+    r"""Select authentication method."""
+
+    MANUAL = "manual"
+    SECRET = "secret"
+    OAUTH = "oauth"
+    OAUTH_SECRET = "oauthSecret"
+    OAUTH_CERT = "oauthCert"
+
+
+class InputOffice365MsgTraceLogLevel(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Log Level (verbosity) for collection runtime behavior."""
+
+    ERROR = "error"
+    WARN = "warn"
+    INFO = "info"
+    DEBUG = "debug"
+    SILLY = "silly"
+
+
+class InputOffice365MsgTraceMetadatumTypedDict(TypedDict):
+    name: str
+    value: str
+    r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
+
+
+class InputOffice365MsgTraceMetadatum(BaseModel):
+    name: str
+
+    value: str
+    r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
+
+
+class InputOffice365MsgTraceRetryType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The algorithm to use when performing HTTP retries"""
+
+    NONE = "none"
+    BACKOFF = "backoff"
+    STATIC = "static"
+
+
+class InputOffice365MsgTraceRetryRulesTypedDict(TypedDict):
+    type: NotRequired[InputOffice365MsgTraceRetryType]
+    r"""The algorithm to use when performing HTTP retries"""
+    interval: NotRequired[float]
+    r"""Time interval between failed request and first retry (kickoff). Maximum allowed value is 20,000 ms (1/3 minute)."""
+    limit: NotRequired[float]
+    r"""The maximum number of times to retry a failed HTTP request"""
+    multiplier: NotRequired[float]
+    r"""Base for exponential backoff, e.g., base 2 means that retries will occur after 2, then 4, then 8 seconds, and so on"""
+    codes: NotRequired[List[float]]
+    r"""List of http codes that trigger a retry. Leave empty to use the default list of 429, 500, and 503."""
+    enable_header: NotRequired[bool]
+    r"""Honor any Retry-After header that specifies a delay (in seconds) or a timestamp after which to retry the request. The delay is limited to 20 seconds, even if the Retry-After header specifies a longer delay. When disabled, all Retry-After headers are ignored."""
+    retry_connect_timeout: NotRequired[bool]
+    r"""Make a single retry attempt when a connection timeout (ETIMEDOUT) error occurs"""
+    retry_connect_reset: NotRequired[bool]
+    r"""Retry request when a connection reset (ECONNRESET) error occurs"""
+
+
+class InputOffice365MsgTraceRetryRules(BaseModel):
+    type: Annotated[
+        Optional[InputOffice365MsgTraceRetryType],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputOffice365MsgTraceRetryType.BACKOFF
+    r"""The algorithm to use when performing HTTP retries"""
+
+    interval: Optional[float] = 1000
+    r"""Time interval between failed request and first retry (kickoff). Maximum allowed value is 20,000 ms (1/3 minute)."""
+
+    limit: Optional[float] = 5
+    r"""The maximum number of times to retry a failed HTTP request"""
+
+    multiplier: Optional[float] = 2
+    r"""Base for exponential backoff, e.g., base 2 means that retries will occur after 2, then 4, then 8 seconds, and so on"""
+
+    codes: Optional[List[float]] = None
+    r"""List of http codes that trigger a retry. Leave empty to use the default list of 429, 500, and 503."""
+
+    enable_header: Annotated[Optional[bool], pydantic.Field(alias="enableHeader")] = (
+        True
+    )
+    r"""Honor any Retry-After header that specifies a delay (in seconds) or a timestamp after which to retry the request. The delay is limited to 20 seconds, even if the Retry-After header specifies a longer delay. When disabled, all Retry-After headers are ignored."""
+
+    retry_connect_timeout: Annotated[
+        Optional[bool], pydantic.Field(alias="retryConnectTimeout")
+    ] = False
+    r"""Make a single retry attempt when a connection timeout (ETIMEDOUT) error occurs"""
+
+    retry_connect_reset: Annotated[
+        Optional[bool], pydantic.Field(alias="retryConnectReset")
+    ] = False
+    r"""Retry request when a connection reset (ECONNRESET) error occurs"""
+
+
+class InputOffice365MsgTraceSubscriptionPlan(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Office 365 subscription plan for your organization, typically Office 365 Enterprise"""
+
+    ENTERPRISE_GCC = "enterprise_gcc"
+    GCC = "gcc"
+    GCC_HIGH = "gcc_high"
+    DOD = "dod"
+
+
+class CertOptionsTypedDict(TypedDict):
+    priv_key_path: str
+    r"""Path to the private key to use. Key should be in PEM format. Can reference $ENV_VARS."""
+    cert_path: str
+    r"""Path to the certificate to use. Certificate should be in PEM format. Can reference $ENV_VARS."""
+    certificate_name: NotRequired[str]
+    r"""The name of the predefined certificate."""
+    passphrase: NotRequired[str]
+    r"""Passphrase to use to decrypt the private key."""
+
+
+class CertOptions(BaseModel):
+    priv_key_path: Annotated[str, pydantic.Field(alias="privKeyPath")]
+    r"""Path to the private key to use. Key should be in PEM format. Can reference $ENV_VARS."""
+
+    cert_path: Annotated[str, pydantic.Field(alias="certPath")]
+    r"""Path to the certificate to use. Certificate should be in PEM format. Can reference $ENV_VARS."""
+
+    certificate_name: Annotated[
+        Optional[str], pydantic.Field(alias="certificateName")
+    ] = None
+    r"""The name of the predefined certificate."""
+
+    passphrase: Optional[str] = None
+    r"""Passphrase to use to decrypt the private key."""
+
+
+class InputOffice365MsgTraceTypedDict(TypedDict):
+    type: InputOffice365MsgTraceType
+    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[InputOffice365MsgTraceConnectionTypedDict]]
+    r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
+    pq: NotRequired[InputOffice365MsgTracePqTypedDict]
+    url: NotRequired[str]
+    r"""URL to use when retrieving report data."""
+    interval: NotRequired[float]
+    r"""How often (in minutes) to run the report. Must divide evenly into 60 minutes to create a predictable schedule, or Save will fail."""
+    start_date: NotRequired[str]
+    r"""Backward offset for the search range's head. (E.g.: -3h@h) Message Trace data is delayed; this parameter (with Date range end) compensates for delay and gaps."""
+    end_date: NotRequired[str]
+    r"""Backward offset for the search range's tail. (E.g.: -2h@h) Message Trace data is delayed; this parameter (with Date range start) compensates for delay and gaps."""
+    timeout: NotRequired[float]
+    r"""HTTP request inactivity timeout. Maximum is 2400 (40 minutes); enter 0 to wait indefinitely."""
+    disable_time_filter: NotRequired[bool]
+    r"""Disables time filtering of events when a date range is specified."""
+    auth_type: NotRequired[InputOffice365MsgTraceAuthenticationMethod]
+    r"""Select authentication method."""
+    reschedule_dropped_tasks: NotRequired[bool]
+    r"""Reschedule tasks that failed with non-fatal errors"""
+    max_task_reschedule: NotRequired[float]
+    r"""Maximum number of times a task can be rescheduled"""
+    log_level: NotRequired[InputOffice365MsgTraceLogLevel]
+    r"""Log Level (verbosity) for collection runtime behavior."""
+    job_timeout: NotRequired[str]
+    r"""Maximum time the job is allowed to run (e.g., 30, 45s or 15m). Units are seconds, if not specified. Enter 0 for unlimited time."""
+    keep_alive_time: NotRequired[float]
+    r"""How often workers should check in with the scheduler to keep job subscription alive"""
+    max_missed_keep_alives: NotRequired[float]
+    r"""The number of Keep Alive Time periods before an inactive worker will have its job subscription revoked."""
+    ttl: NotRequired[str]
+    r"""Time to keep the job's artifacts on disk after job completion. This also affects how long a job is listed in the Job Inspector."""
+    ignore_group_jobs_limit: NotRequired[bool]
+    r"""When enabled, this job's artifacts are not counted toward the Worker Group's finished job artifacts limit. Artifacts will be removed only after the Collector's configured time to live."""
+    metadata: NotRequired[List[InputOffice365MsgTraceMetadatumTypedDict]]
+    r"""Fields to add to events from this input"""
+    retry_rules: NotRequired[InputOffice365MsgTraceRetryRulesTypedDict]
+    description: NotRequired[str]
+    username: NotRequired[str]
+    r"""Username to run Message Trace API call."""
+    password: NotRequired[str]
+    r"""Password to run Message Trace API call."""
+    credentials_secret: NotRequired[str]
+    r"""Select or create a secret that references your credentials."""
+    client_secret: NotRequired[str]
+    r"""client_secret to pass in the OAuth request parameter."""
+    tenant_id: NotRequired[str]
+    r"""Directory ID (tenant identifier) in Azure Active Directory."""
+    client_id: NotRequired[str]
+    r"""client_id to pass in the OAuth request parameter."""
+    resource: NotRequired[str]
+    r"""Resource to pass in the OAuth request parameter."""
+    plan_type: NotRequired[InputOffice365MsgTraceSubscriptionPlan]
+    r"""Office 365 subscription plan for your organization, typically Office 365 Enterprise"""
+    text_secret: NotRequired[str]
+    r"""Select or create a secret that references your client_secret to pass in the OAuth request parameter."""
+    cert_options: NotRequired[CertOptionsTypedDict]
+
+
+class InputOffice365MsgTrace(BaseModel):
+    type: Annotated[
+        InputOffice365MsgTraceType, PlainValidator(validate_open_enum(False))
+    ]
+
+    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[InputOffice365MsgTraceConnection]] = None
+    r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
+
+    pq: Optional[InputOffice365MsgTracePq] = None
+
+    url: Optional[str] = (
+        "https://reports.office365.com/ecp/reportingwebservice/reporting.svc/MessageTrace"
+    )
+    r"""URL to use when retrieving report data."""
+
+    interval: Optional[float] = 60
+    r"""How often (in minutes) to run the report. Must divide evenly into 60 minutes to create a predictable schedule, or Save will fail."""
+
+    start_date: Annotated[Optional[str], pydantic.Field(alias="startDate")] = None
+    r"""Backward offset for the search range's head. (E.g.: -3h@h) Message Trace data is delayed; this parameter (with Date range end) compensates for delay and gaps."""
+
+    end_date: Annotated[Optional[str], pydantic.Field(alias="endDate")] = None
+    r"""Backward offset for the search range's tail. (E.g.: -2h@h) Message Trace data is delayed; this parameter (with Date range start) compensates for delay and gaps."""
+
+    timeout: Optional[float] = 300
+    r"""HTTP request inactivity timeout. Maximum is 2400 (40 minutes); enter 0 to wait indefinitely."""
+
+    disable_time_filter: Annotated[
+        Optional[bool], pydantic.Field(alias="disableTimeFilter")
+    ] = True
+    r"""Disables time filtering of events when a date range is specified."""
+
+    auth_type: Annotated[
+        Annotated[
+            Optional[InputOffice365MsgTraceAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
+    ] = InputOffice365MsgTraceAuthenticationMethod.OAUTH
+    r"""Select authentication method."""
+
+    reschedule_dropped_tasks: Annotated[
+        Optional[bool], pydantic.Field(alias="rescheduleDroppedTasks")
+    ] = True
+    r"""Reschedule tasks that failed with non-fatal errors"""
+
+    max_task_reschedule: Annotated[
+        Optional[float], pydantic.Field(alias="maxTaskReschedule")
+    ] = 1
+    r"""Maximum number of times a task can be rescheduled"""
+
+    log_level: Annotated[
+        Annotated[
+            Optional[InputOffice365MsgTraceLogLevel],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="logLevel"),
+    ] = InputOffice365MsgTraceLogLevel.INFO
+    r"""Log Level (verbosity) for collection runtime behavior."""
+
+    job_timeout: Annotated[Optional[str], pydantic.Field(alias="jobTimeout")] = "0"
+    r"""Maximum time the job is allowed to run (e.g., 30, 45s or 15m). Units are seconds, if not specified. Enter 0 for unlimited time."""
+
+    keep_alive_time: Annotated[
+        Optional[float], pydantic.Field(alias="keepAliveTime")
+    ] = 30
+    r"""How often workers should check in with the scheduler to keep job subscription alive"""
+
+    max_missed_keep_alives: Annotated[
+        Optional[float], pydantic.Field(alias="maxMissedKeepAlives")
+    ] = 3
+    r"""The number of Keep Alive Time periods before an inactive worker will have its job subscription revoked."""
+
+    ttl: Optional[str] = "4h"
+    r"""Time to keep the job's artifacts on disk after job completion. This also affects how long a job is listed in the Job Inspector."""
+
+    ignore_group_jobs_limit: Annotated[
+        Optional[bool], pydantic.Field(alias="ignoreGroupJobsLimit")
+    ] = False
+    r"""When enabled, this job's artifacts are not counted toward the Worker Group's finished job artifacts limit. Artifacts will be removed only after the Collector's configured time to live."""
+
+    metadata: Optional[List[InputOffice365MsgTraceMetadatum]] = None
+    r"""Fields to add to events from this input"""
+
+    retry_rules: Annotated[
+        Optional[InputOffice365MsgTraceRetryRules], pydantic.Field(alias="retryRules")
+    ] = None
+
+    description: Optional[str] = None
+
+    username: Optional[str] = None
+    r"""Username to run Message Trace API call."""
+
+    password: Optional[str] = None
+    r"""Password to run Message Trace API call."""
+
+    credentials_secret: Annotated[
+        Optional[str], pydantic.Field(alias="credentialsSecret")
+    ] = None
+    r"""Select or create a secret that references your credentials."""
+
+    client_secret: Annotated[Optional[str], pydantic.Field(alias="clientSecret")] = None
+    r"""client_secret to pass in the OAuth request parameter."""
+
+    tenant_id: Annotated[Optional[str], pydantic.Field(alias="tenantId")] = None
+    r"""Directory ID (tenant identifier) in Azure Active Directory."""
+
+    client_id: Annotated[Optional[str], pydantic.Field(alias="clientId")] = None
+    r"""client_id to pass in the OAuth request parameter."""
+
+    resource: Optional[str] = "https://outlook.office365.com"
+    r"""Resource to pass in the OAuth request parameter."""
+
+    plan_type: Annotated[
+        Annotated[
+            Optional[InputOffice365MsgTraceSubscriptionPlan],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="planType"),
+    ] = InputOffice365MsgTraceSubscriptionPlan.ENTERPRISE_GCC
+    r"""Office 365 subscription plan for your organization, typically Office 365 Enterprise"""
+
+    text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
+    r"""Select or create a secret that references your client_secret to pass in the OAuth request parameter."""
+
+    cert_options: Annotated[
+        Optional[CertOptions], pydantic.Field(alias="certOptions")
+    ] = None