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

cribl_control_plane/models/outputgooglepubsub.py

@@ -0,0 +1,274 @@
+"""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 OutputGooglePubsubType(str, Enum, metaclass=utils.OpenEnumMeta):
+    GOOGLE_PUBSUB = "google_pubsub"
+
+
+class OutputGooglePubsubGoogleAuthenticationMethod(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
+    r"""Choose Auto to use Google Application Default Credentials (ADC), Manual to enter Google service account credentials directly, or Secret to select or create a stored secret that references Google service account credentials."""
+
+    AUTO = "auto"
+    MANUAL = "manual"
+    SECRET = "secret"
+
+
+class FlushPeriodSecType(str, Enum, metaclass=utils.OpenEnumMeta):
+    NUMBER = "number"
+
+
+class FlushPeriodSecTypedDict(TypedDict):
+    r"""Maximum time to wait before sending a batch (when batch size limit is not reached)."""
+
+    type: NotRequired[FlushPeriodSecType]
+    default: NotRequired[float]
+
+
+class FlushPeriodSec(BaseModel):
+    r"""Maximum time to wait before sending a batch (when batch size limit is not reached)."""
+
+    type: Annotated[
+        Optional[FlushPeriodSecType], PlainValidator(validate_open_enum(False))
+    ] = None
+
+    default: Optional[float] = None
+
+
+class OutputGooglePubsubBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""How to handle events when all receivers are exerting backpressure"""
+
+    BLOCK = "block"
+    DROP = "drop"
+    QUEUE = "queue"
+
+
+class OutputGooglePubsubCompression(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Codec to use to compress the persisted data"""
+
+    NONE = "none"
+    GZIP = "gzip"
+
+
+class OutputGooglePubsubQueueFullBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
+
+    BLOCK = "block"
+    DROP = "drop"
+
+
+class OutputGooglePubsubMode(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
+
+    ERROR = "error"
+    BACKPRESSURE = "backpressure"
+    ALWAYS = "always"
+
+
+class OutputGooglePubsubPqControlsTypedDict(TypedDict):
+    pass
+
+
+class OutputGooglePubsubPqControls(BaseModel):
+    pass
+
+
+class OutputGooglePubsubTypedDict(TypedDict):
+    type: OutputGooglePubsubType
+    topic_name: str
+    r"""ID of the topic to send events to."""
+    id: NotRequired[str]
+    r"""Unique ID for this output"""
+    pipeline: NotRequired[str]
+    r"""Pipeline to process data before sending out to this output"""
+    system_fields: NotRequired[List[str]]
+    r"""Fields to automatically add to events, such as cribl_pipe. Supports wildcards."""
+    environment: NotRequired[str]
+    r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
+    streamtags: NotRequired[List[str]]
+    r"""Tags for filtering and grouping in @{product}"""
+    create_topic: NotRequired[bool]
+    r"""If enabled, create topic if it does not exist."""
+    ordered_delivery: NotRequired[bool]
+    r"""If enabled, send events in the order they were added to the queue. For this to work correctly, the process receiving events must have ordering enabled."""
+    region: NotRequired[str]
+    r"""Region to publish messages to. Select 'default' to allow Google to auto-select the nearest region. When using ordered delivery, the selected region must be allowed by message storage policy."""
+    google_auth_method: NotRequired[OutputGooglePubsubGoogleAuthenticationMethod]
+    r"""Choose Auto to use Google Application Default Credentials (ADC), Manual to enter Google service account credentials directly, or Secret to select or create a stored secret that references Google service account credentials."""
+    service_account_credentials: NotRequired[str]
+    r"""Contents of service account credentials (JSON keys) file downloaded from Google Cloud. To upload a file, click the upload button at this field's upper right."""
+    secret: NotRequired[str]
+    r"""Select or create a stored text secret"""
+    batch_size: NotRequired[float]
+    r"""The maximum number of items the Google API should batch before it sends them to the topic."""
+    batch_timeout: NotRequired[float]
+    r"""The maximum amount of time, in milliseconds, that the Google API should wait to send a batch (if the Batch size is not reached)."""
+    max_queue_size: NotRequired[float]
+    r"""Maximum number of queued batches before blocking."""
+    max_record_size_kb: NotRequired[float]
+    r"""Maximum size (KB) of batches to send."""
+    flush_period_sec: NotRequired[FlushPeriodSecTypedDict]
+    r"""Maximum time to wait before sending a batch (when batch size limit is not reached)."""
+    max_in_progress: NotRequired[float]
+    r"""The maximum number of in-progress API requests before backpressure is applied."""
+    on_backpressure: NotRequired[OutputGooglePubsubBackpressureBehavior]
+    r"""How to handle events when all receivers are exerting backpressure"""
+    description: NotRequired[str]
+    pq_max_file_size: NotRequired[str]
+    r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
+    pq_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."""
+    pq_path: NotRequired[str]
+    r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/<output-id>."""
+    pq_compress: NotRequired[OutputGooglePubsubCompression]
+    r"""Codec to use to compress the persisted data"""
+    pq_on_backpressure: NotRequired[OutputGooglePubsubQueueFullBehavior]
+    r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
+    pq_mode: NotRequired[OutputGooglePubsubMode]
+    r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
+    pq_controls: NotRequired[OutputGooglePubsubPqControlsTypedDict]
+
+
+class OutputGooglePubsub(BaseModel):
+    type: Annotated[OutputGooglePubsubType, PlainValidator(validate_open_enum(False))]
+
+    topic_name: Annotated[str, pydantic.Field(alias="topicName")]
+    r"""ID of the topic to send events to."""
+
+    id: Optional[str] = None
+    r"""Unique ID for this output"""
+
+    pipeline: Optional[str] = None
+    r"""Pipeline to process data before sending out to this output"""
+
+    system_fields: Annotated[
+        Optional[List[str]], pydantic.Field(alias="systemFields")
+    ] = None
+    r"""Fields to automatically add to events, such as cribl_pipe. Supports wildcards."""
+
+    environment: Optional[str] = None
+    r"""Optionally, enable this config only on a specified Git branch. If empty, will be enabled everywhere."""
+
+    streamtags: Optional[List[str]] = None
+    r"""Tags for filtering and grouping in @{product}"""
+
+    create_topic: Annotated[Optional[bool], pydantic.Field(alias="createTopic")] = False
+    r"""If enabled, create topic if it does not exist."""
+
+    ordered_delivery: Annotated[
+        Optional[bool], pydantic.Field(alias="orderedDelivery")
+    ] = False
+    r"""If enabled, send events in the order they were added to the queue. For this to work correctly, the process receiving events must have ordering enabled."""
+
+    region: Optional[str] = None
+    r"""Region to publish messages to. Select 'default' to allow Google to auto-select the nearest region. When using ordered delivery, the selected region must be allowed by message storage policy."""
+
+    google_auth_method: Annotated[
+        Annotated[
+            Optional[OutputGooglePubsubGoogleAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="googleAuthMethod"),
+    ] = OutputGooglePubsubGoogleAuthenticationMethod.MANUAL
+    r"""Choose Auto to use Google Application Default Credentials (ADC), Manual to enter Google service account credentials directly, or Secret to select or create a stored secret that references Google service account credentials."""
+
+    service_account_credentials: Annotated[
+        Optional[str], pydantic.Field(alias="serviceAccountCredentials")
+    ] = None
+    r"""Contents of service account credentials (JSON keys) file downloaded from Google Cloud. To upload a file, click the upload button at this field's upper right."""
+
+    secret: Optional[str] = None
+    r"""Select or create a stored text secret"""
+
+    batch_size: Annotated[Optional[float], pydantic.Field(alias="batchSize")] = 1000
+    r"""The maximum number of items the Google API should batch before it sends them to the topic."""
+
+    batch_timeout: Annotated[Optional[float], pydantic.Field(alias="batchTimeout")] = (
+        100
+    )
+    r"""The maximum amount of time, in milliseconds, that the Google API should wait to send a batch (if the Batch size is not reached)."""
+
+    max_queue_size: Annotated[Optional[float], pydantic.Field(alias="maxQueueSize")] = (
+        100
+    )
+    r"""Maximum number of queued batches before blocking."""
+
+    max_record_size_kb: Annotated[
+        Optional[float], pydantic.Field(alias="maxRecordSizeKB")
+    ] = 256
+    r"""Maximum size (KB) of batches to send."""
+
+    flush_period_sec: Annotated[
+        Optional[FlushPeriodSec], pydantic.Field(alias="flushPeriodSec")
+    ] = None
+    r"""Maximum time to wait before sending a batch (when batch size limit is not reached)."""
+
+    max_in_progress: Annotated[
+        Optional[float], pydantic.Field(alias="maxInProgress")
+    ] = 10
+    r"""The maximum number of in-progress API requests before backpressure is applied."""
+
+    on_backpressure: Annotated[
+        Annotated[
+            Optional[OutputGooglePubsubBackpressureBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="onBackpressure"),
+    ] = OutputGooglePubsubBackpressureBehavior.BLOCK
+    r"""How to handle events when all receivers are exerting backpressure"""
+
+    description: Optional[str] = None
+
+    pq_max_file_size: Annotated[
+        Optional[str], pydantic.Field(alias="pqMaxFileSize")
+    ] = "1 MB"
+    r"""The maximum size to store in each queue file before closing and optionally compressing (KB, MB, etc.)"""
+
+    pq_max_size: Annotated[Optional[str], pydantic.Field(alias="pqMaxSize")] = "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."""
+
+    pq_path: Annotated[Optional[str], pydantic.Field(alias="pqPath")] = (
+        "$CRIBL_HOME/state/queues"
+    )
+    r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/<output-id>."""
+
+    pq_compress: Annotated[
+        Annotated[
+            Optional[OutputGooglePubsubCompression],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="pqCompress"),
+    ] = OutputGooglePubsubCompression.NONE
+    r"""Codec to use to compress the persisted data"""
+
+    pq_on_backpressure: Annotated[
+        Annotated[
+            Optional[OutputGooglePubsubQueueFullBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="pqOnBackpressure"),
+    ] = OutputGooglePubsubQueueFullBehavior.BLOCK
+    r"""How to handle events when the queue is exerting backpressure (full capacity or low disk). 'Block' is the same behavior as non-PQ blocking. 'Drop new data' throws away incoming data, while leaving the contents of the PQ unchanged."""
+
+    pq_mode: Annotated[
+        Annotated[
+            Optional[OutputGooglePubsubMode], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="pqMode"),
+    ] = OutputGooglePubsubMode.ERROR
+    r"""In Error mode, PQ writes events to the filesystem if the Destination is unavailable. In Backpressure mode, PQ writes events to the filesystem when it detects backpressure from the Destination. In Always On mode, PQ always writes events to the filesystem."""
+
+    pq_controls: Annotated[
+        Optional[OutputGooglePubsubPqControls], pydantic.Field(alias="pqControls")
+    ] = None