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

cribl_control_plane/models/inputoffice365service.py

@@ -0,0 +1,377 @@
+"""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 InputOffice365ServiceType(str, Enum, metaclass=utils.OpenEnumMeta):
+    OFFICE365_SERVICE = "office365_service"
+
+
+class InputOffice365ServiceConnectionTypedDict(TypedDict):
+    output: str
+    pipeline: NotRequired[str]
+
+
+class InputOffice365ServiceConnection(BaseModel):
+    output: str
+
+    pipeline: Optional[str] = None
+
+
+class InputOffice365ServiceMode(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 InputOffice365ServiceCompression(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Codec to use to compress the persisted data"""
+
+    NONE = "none"
+    GZIP = "gzip"
+
+
+class InputOffice365ServicePqTypedDict(TypedDict):
+    mode: NotRequired[InputOffice365ServiceMode]
+    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[InputOffice365ServiceCompression]
+    r"""Codec to use to compress the persisted data"""
+
+
+class InputOffice365ServicePq(BaseModel):
+    mode: Annotated[
+        Optional[InputOffice365ServiceMode], PlainValidator(validate_open_enum(False))
+    ] = InputOffice365ServiceMode.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[InputOffice365ServiceCompression],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputOffice365ServiceCompression.NONE
+    r"""Codec to use to compress the persisted data"""
+
+
+class InputOffice365ServiceSubscriptionPlan(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 InputOffice365ServiceMetadatumTypedDict(TypedDict):
+    name: str
+    value: str
+    r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
+
+
+class InputOffice365ServiceMetadatum(BaseModel):
+    name: str
+
+    value: str
+    r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
+
+
+class InputOffice365ServiceLogLevel(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Collector runtime Log Level"""
+
+    ERROR = "error"
+    WARN = "warn"
+    INFO = "info"
+    DEBUG = "debug"
+
+
+class InputOffice365ServiceContentConfigTypedDict(TypedDict):
+    content_type: NotRequired[str]
+    r"""Office 365 Services API Content Type"""
+    description: NotRequired[str]
+    r"""If interval type is minutes the value entered must evenly divisible by 60 or save will fail"""
+    interval: NotRequired[float]
+    log_level: NotRequired[InputOffice365ServiceLogLevel]
+    r"""Collector runtime Log Level"""
+    enabled: NotRequired[bool]
+
+
+class InputOffice365ServiceContentConfig(BaseModel):
+    content_type: Annotated[Optional[str], pydantic.Field(alias="contentType")] = None
+    r"""Office 365 Services API Content Type"""
+
+    description: Optional[str] = None
+    r"""If interval type is minutes the value entered must evenly divisible by 60 or save will fail"""
+
+    interval: Optional[float] = None
+
+    log_level: Annotated[
+        Annotated[
+            Optional[InputOffice365ServiceLogLevel],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="logLevel"),
+    ] = None
+    r"""Collector runtime Log Level"""
+
+    enabled: Optional[bool] = None
+
+
+class InputOffice365ServiceRetryType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""The algorithm to use when performing HTTP retries"""
+
+    NONE = "none"
+    BACKOFF = "backoff"
+    STATIC = "static"
+
+
+class InputOffice365ServiceRetryRulesTypedDict(TypedDict):
+    type: NotRequired[InputOffice365ServiceRetryType]
+    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 InputOffice365ServiceRetryRules(BaseModel):
+    type: Annotated[
+        Optional[InputOffice365ServiceRetryType],
+        PlainValidator(validate_open_enum(False)),
+    ] = InputOffice365ServiceRetryType.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 InputOffice365ServiceAuthenticationMethod(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
+    r"""Enter client secret directly, or select a stored secret"""
+
+    MANUAL = "manual"
+    SECRET = "secret"
+
+
+class InputOffice365ServiceTypedDict(TypedDict):
+    type: InputOffice365ServiceType
+    tenant_id: str
+    r"""Office 365 Azure Tenant ID"""
+    app_id: str
+    r"""Office 365 Azure Application ID"""
+    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[InputOffice365ServiceConnectionTypedDict]]
+    r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
+    pq: NotRequired[InputOffice365ServicePqTypedDict]
+    plan_type: NotRequired[InputOffice365ServiceSubscriptionPlan]
+    r"""Office 365 subscription plan for your organization, typically Office 365 Enterprise"""
+    timeout: NotRequired[float]
+    r"""HTTP request inactivity timeout, use 0 to disable"""
+    keep_alive_time: NotRequired[float]
+    r"""How often workers should check in with the scheduler to keep job subscription alive"""
+    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."""
+    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[InputOffice365ServiceMetadatumTypedDict]]
+    r"""Fields to add to events from this input"""
+    content_config: NotRequired[List[InputOffice365ServiceContentConfigTypedDict]]
+    r"""Enable Office 365 Service Communication API content types and polling intervals. Polling intervals are used to set up search date range and cron schedule, e.g.: */${interval} * * * *. Because of this, intervals entered for current and historical status must be evenly divisible by 60 to give a predictable schedule."""
+    retry_rules: NotRequired[InputOffice365ServiceRetryRulesTypedDict]
+    auth_type: NotRequired[InputOffice365ServiceAuthenticationMethod]
+    r"""Enter client secret directly, or select a stored secret"""
+    description: NotRequired[str]
+    client_secret: NotRequired[str]
+    r"""Office 365 Azure client secret"""
+    text_secret: NotRequired[str]
+    r"""Select or create a stored text secret"""
+
+
+class InputOffice365Service(BaseModel):
+    type: Annotated[
+        InputOffice365ServiceType, PlainValidator(validate_open_enum(False))
+    ]
+
+    tenant_id: Annotated[str, pydantic.Field(alias="tenantId")]
+    r"""Office 365 Azure Tenant ID"""
+
+    app_id: Annotated[str, pydantic.Field(alias="appId")]
+    r"""Office 365 Azure Application ID"""
+
+    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[InputOffice365ServiceConnection]] = None
+    r"""Direct connections to Destinations, and optionally via a Pipeline or a Pack"""
+
+    pq: Optional[InputOffice365ServicePq] = None
+
+    plan_type: Annotated[
+        Annotated[
+            Optional[InputOffice365ServiceSubscriptionPlan],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="planType"),
+    ] = InputOffice365ServiceSubscriptionPlan.ENTERPRISE_GCC
+    r"""Office 365 subscription plan for your organization, typically Office 365 Enterprise"""
+
+    timeout: Optional[float] = 300
+    r"""HTTP request inactivity timeout, use 0 to disable"""
+
+    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"""
+
+    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."""
+
+    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[InputOffice365ServiceMetadatum]] = None
+    r"""Fields to add to events from this input"""
+
+    content_config: Annotated[
+        Optional[List[InputOffice365ServiceContentConfig]],
+        pydantic.Field(alias="contentConfig"),
+    ] = None
+    r"""Enable Office 365 Service Communication API content types and polling intervals. Polling intervals are used to set up search date range and cron schedule, e.g.: */${interval} * * * *. Because of this, intervals entered for current and historical status must be evenly divisible by 60 to give a predictable schedule."""
+
+    retry_rules: Annotated[
+        Optional[InputOffice365ServiceRetryRules], pydantic.Field(alias="retryRules")
+    ] = None
+
+    auth_type: Annotated[
+        Annotated[
+            Optional[InputOffice365ServiceAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
+    ] = InputOffice365ServiceAuthenticationMethod.MANUAL
+    r"""Enter client secret directly, or select a stored secret"""
+
+    description: Optional[str] = None
+
+    client_secret: Annotated[Optional[str], pydantic.Field(alias="clientSecret")] = None
+    r"""Office 365 Azure client secret"""
+
+    text_secret: Annotated[Optional[str], pydantic.Field(alias="textSecret")] = None
+    r"""Select or create a stored text secret"""