cribl-control-plane 0.0.21__py3-none-any.whl → 0.4.0b23__py3-none-any.whl

cribl_control_plane/models/outputsyslog.py

@@ -1,9 +1,13 @@
 """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 List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
@@ -12,14 +16,16 @@ class OutputSyslogType(str, Enum):
     SYSLOG = "syslog"
 
 
-class OutputSyslogProtocol(str, Enum):
+class OutputSyslogProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The network protocol to use for sending out syslog messages"""
 
+    # TCP
     TCP = "tcp"
+    # UDP
     UDP = "udp"
 
 
-class Facility(int, Enum):
+class Facility(int, Enum, metaclass=utils.OpenEnumMeta):
     r"""Default value for message facility. Will be overwritten by value of __facility if set. Defaults to user."""
 
     ZERO = 0
@@ -46,41 +52,101 @@ class Facility(int, Enum):
     TWENTY_ONE = 21
 
 
-class OutputSyslogSeverity(int, Enum):
+class OutputSyslogSeverity(int, Enum, metaclass=utils.OpenEnumMeta):
     r"""Default value for message severity. Will be overwritten by value of __severity if set. Defaults to notice."""
 
+    # emergency
     ZERO = 0
+    # alert
     ONE = 1
+    # critical
     TWO = 2
+    # error
     THREE = 3
+    # warning
     FOUR = 4
+    # notice
     FIVE = 5
+    # info
     SIX = 6
+    # debug
     SEVEN = 7
 
 
-class OutputSyslogMessageFormat(str, Enum):
+class OutputSyslogMessageFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The syslog message format depending on the receiver's support"""
 
+    # RFC3164
     RFC3164 = "rfc3164"
+    # RFC5424
     RFC5424 = "rfc5424"
 
 
-class TimestampFormat(str, Enum):
+class TimestampFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Timestamp format to use when serializing event's time field"""
 
+    # Syslog
     SYSLOG = "syslog"
+    # ISO8601
     ISO8601 = "iso8601"
 
 
-class OutputSyslogMinimumTLSVersion(str, Enum):
+class OutputSyslogTLS(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""Whether to inherit TLS configs from group setting or disable TLS"""
+
+    INHERIT = "inherit"
+    OFF = "off"
+
+
+class OutputSyslogHostTypedDict(TypedDict):
+    host: str
+    r"""The hostname of the receiver"""
+    port: float
+    r"""The port to connect to on the provided host"""
+    tls: NotRequired[OutputSyslogTLS]
+    r"""Whether to inherit TLS configs from group setting or disable TLS"""
+    servername: NotRequired[str]
+    r"""Servername to use if establishing a TLS connection. If not specified, defaults to connection host (if not an IP); otherwise, uses the global TLS settings."""
+    weight: NotRequired[float]
+    r"""Assign a weight (>0) to each endpoint to indicate its traffic-handling capability"""
+
+
+class OutputSyslogHost(BaseModel):
+    host: str
+    r"""The hostname of the receiver"""
+
+    port: float
+    r"""The port to connect to on the provided host"""
+
+    tls: Annotated[
+        Optional[OutputSyslogTLS], PlainValidator(validate_open_enum(False))
+    ] = OutputSyslogTLS.INHERIT
+    r"""Whether to inherit TLS configs from group setting or disable TLS"""
+
+    servername: Optional[str] = None
+    r"""Servername to use if establishing a TLS connection. If not specified, defaults to connection host (if not an IP); otherwise, uses the global TLS settings."""
+
+    weight: Optional[float] = 1
+    r"""Assign a weight (>0) to each endpoint to indicate its traffic-handling capability"""
+
+    @field_serializer("tls")
+    def serialize_tls(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSyslogTLS(value)
+            except ValueError:
+                return value
+        return value
+
+
+class OutputSyslogMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class OutputSyslogMaximumTLSVersion(str, Enum):
+class OutputSyslogMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -140,44 +206,80 @@ class OutputSyslogTLSSettingsClientSide(BaseModel):
     r"""Passphrase to use to decrypt private key"""
 
     min_version: Annotated[
-        Optional[OutputSyslogMinimumTLSVersion], pydantic.Field(alias="minVersion")
+        Annotated[
+            Optional[OutputSyslogMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[OutputSyslogMaximumTLSVersion], pydantic.Field(alias="maxVersion")
+        Annotated[
+            Optional[OutputSyslogMaximumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="maxVersion"),
     ] = None
 
-
-class OutputSyslogBackpressureBehavior(str, Enum):
+    @field_serializer("min_version")
+    def serialize_min_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSyslogMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSyslogMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+
+class OutputSyslogBackpressureBehavior(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to handle events when all receivers are exerting backpressure"""
 
+    # Block
     BLOCK = "block"
+    # Drop
     DROP = "drop"
+    # Persistent Queue
     QUEUE = "queue"
 
 
-class OutputSyslogCompression(str, Enum):
+class OutputSyslogMode(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 = "error"
+    # Backpressure
+    ALWAYS = "always"
+    # Always On
+    BACKPRESSURE = "backpressure"
+
+
+class OutputSyslogCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
-class OutputSyslogQueueFullBehavior(str, Enum):
+class OutputSyslogQueueFullBehavior(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 = "block"
+    # Drop new data
     DROP = "drop"
 
 
-class OutputSyslogMode(str, Enum):
-    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 OutputSyslogPqControlsTypedDict(TypedDict):
     pass
 
@@ -187,9 +289,9 @@ class OutputSyslogPqControls(BaseModel):
 
 
 class OutputSyslogTypedDict(TypedDict):
-    id: str
-    r"""Unique ID for this output"""
     type: OutputSyslogType
+    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]]
@@ -219,6 +321,20 @@ class OutputSyslogTypedDict(TypedDict):
     description: NotRequired[str]
     load_balanced: NotRequired[bool]
     r"""For optimal performance, enable load balancing even if you have one hostname, as it can expand to multiple IPs.  If this setting is disabled, consider enabling round-robin DNS."""
+    host: NotRequired[str]
+    r"""The hostname of the receiver"""
+    port: NotRequired[float]
+    r"""The port to connect to on the provided host"""
+    exclude_self: NotRequired[bool]
+    r"""Exclude all IPs of the current host from the list of any resolved hostnames"""
+    hosts: NotRequired[List[OutputSyslogHostTypedDict]]
+    r"""Set of hosts to load-balance data to"""
+    dns_resolve_period_sec: NotRequired[float]
+    r"""The interval in which to re-resolve any hostnames and pick up destinations from A records"""
+    load_balance_stats_period_sec: NotRequired[float]
+    r"""How far back in time to keep traffic stats for load balancing purposes"""
+    max_concurrent_senders: NotRequired[float]
+    r"""Maximum number of concurrent connections (per Worker Process). A random set of IPs will be picked on every DNS resolution period. Use 0 for unlimited."""
     connection_timeout: NotRequired[float]
     r"""Amount of time (milliseconds) to wait for the connection to establish before retrying"""
     write_timeout: NotRequired[float]
@@ -226,14 +342,22 @@ class OutputSyslogTypedDict(TypedDict):
     tls: NotRequired[OutputSyslogTLSSettingsClientSideTypedDict]
     on_backpressure: NotRequired[OutputSyslogBackpressureBehavior]
     r"""How to handle events when all receivers are exerting backpressure"""
-    host: NotRequired[str]
-    r"""The hostname of the receiver"""
-    port: NotRequired[float]
-    r"""The port to connect to on the provided host"""
     max_record_size: NotRequired[float]
     r"""Maximum size of syslog messages. Make sure this value is less than or equal to the MTU to avoid UDP packet fragmentation."""
     udp_dns_resolve_period_sec: NotRequired[float]
     r"""How often to resolve the destination hostname to an IP address. Ignored if the destination is an IP address. A value of 0 means every message sent will incur a DNS lookup."""
+    enable_ip_spoofing: NotRequired[bool]
+    r"""Send Syslog traffic using the original event's Source IP and port. To enable this, you must install the external `udp-sender` helper binary at `/usr/bin/udp-sender` on all Worker Nodes and grant it the `CAP_NET_RAW` capability."""
+    pq_strict_ordering: NotRequired[bool]
+    r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
+    pq_rate_per_sec: NotRequired[float]
+    r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
+    pq_mode: NotRequired[OutputSyslogMode]
+    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_max_buffer_size: NotRequired[float]
+    r"""The maximum number of events to hold in memory before writing the events to disk"""
+    pq_max_backpressure_sec: NotRequired[float]
+    r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
     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]
@@ -244,17 +368,15 @@ class OutputSyslogTypedDict(TypedDict):
     r"""Codec to use to compress the persisted data"""
     pq_on_backpressure: NotRequired[OutputSyslogQueueFullBehavior]
     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[OutputSyslogMode]
-    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[OutputSyslogPqControlsTypedDict]
 
 
 class OutputSyslog(BaseModel):
-    id: str
-    r"""Unique ID for this output"""
-
     type: OutputSyslogType
 
+    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"""
 
@@ -269,25 +391,36 @@ class OutputSyslog(BaseModel):
     streamtags: Optional[List[str]] = None
     r"""Tags for filtering and grouping in @{product}"""
 
-    protocol: Optional[OutputSyslogProtocol] = OutputSyslogProtocol.TCP
+    protocol: Annotated[
+        Optional[OutputSyslogProtocol], PlainValidator(validate_open_enum(False))
+    ] = OutputSyslogProtocol.TCP
     r"""The network protocol to use for sending out syslog messages"""
 
-    facility: Optional[Facility] = Facility.ONE
+    facility: Annotated[
+        Optional[Facility], PlainValidator(validate_open_enum(True))
+    ] = Facility.ONE
     r"""Default value for message facility. Will be overwritten by value of __facility if set. Defaults to user."""
 
-    severity: Optional[OutputSyslogSeverity] = OutputSyslogSeverity.FIVE
+    severity: Annotated[
+        Optional[OutputSyslogSeverity], PlainValidator(validate_open_enum(True))
+    ] = OutputSyslogSeverity.FIVE
     r"""Default value for message severity. Will be overwritten by value of __severity if set. Defaults to notice."""
 
     app_name: Annotated[Optional[str], pydantic.Field(alias="appName")] = "Cribl"
     r"""Default name for device or application that originated the message. Defaults to Cribl, but will be overwritten by value of __appname if set."""
 
     message_format: Annotated[
-        Optional[OutputSyslogMessageFormat], pydantic.Field(alias="messageFormat")
+        Annotated[
+            Optional[OutputSyslogMessageFormat],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="messageFormat"),
     ] = OutputSyslogMessageFormat.RFC3164
     r"""The syslog message format depending on the receiver's support"""
 
     timestamp_format: Annotated[
-        Optional[TimestampFormat], pydantic.Field(alias="timestampFormat")
+        Annotated[Optional[TimestampFormat], PlainValidator(validate_open_enum(False))],
+        pydantic.Field(alias="timestampFormat"),
     ] = TimestampFormat.SYSLOG
     r"""Timestamp format to use when serializing event's time field"""
 
@@ -313,6 +446,33 @@ class OutputSyslog(BaseModel):
     )
     r"""For optimal performance, enable load balancing even if you have one hostname, as it can expand to multiple IPs.  If this setting is disabled, consider enabling round-robin DNS."""
 
+    host: Optional[str] = None
+    r"""The hostname of the receiver"""
+
+    port: Optional[float] = None
+    r"""The port to connect to on the provided host"""
+
+    exclude_self: Annotated[Optional[bool], pydantic.Field(alias="excludeSelf")] = False
+    r"""Exclude all IPs of the current host from the list of any resolved hostnames"""
+
+    hosts: Optional[List[OutputSyslogHost]] = None
+    r"""Set of hosts to load-balance data to"""
+
+    dns_resolve_period_sec: Annotated[
+        Optional[float], pydantic.Field(alias="dnsResolvePeriodSec")
+    ] = 600
+    r"""The interval in which to re-resolve any hostnames and pick up destinations from A records"""
+
+    load_balance_stats_period_sec: Annotated[
+        Optional[float], pydantic.Field(alias="loadBalanceStatsPeriodSec")
+    ] = 300
+    r"""How far back in time to keep traffic stats for load balancing purposes"""
+
+    max_concurrent_senders: Annotated[
+        Optional[float], pydantic.Field(alias="maxConcurrentSenders")
+    ] = 0
+    r"""Maximum number of concurrent connections (per Worker Process). A random set of IPs will be picked on every DNS resolution period. Use 0 for unlimited."""
+
     connection_timeout: Annotated[
         Optional[float], pydantic.Field(alias="connectionTimeout")
     ] = 10000
@@ -326,17 +486,14 @@ class OutputSyslog(BaseModel):
     tls: Optional[OutputSyslogTLSSettingsClientSide] = None
 
     on_backpressure: Annotated[
-        Optional[OutputSyslogBackpressureBehavior],
+        Annotated[
+            Optional[OutputSyslogBackpressureBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="onBackpressure"),
     ] = OutputSyslogBackpressureBehavior.BLOCK
     r"""How to handle events when all receivers are exerting backpressure"""
 
-    host: Optional[str] = None
-    r"""The hostname of the receiver"""
-
-    port: Optional[float] = None
-    r"""The port to connect to on the provided host"""
-
     max_record_size: Annotated[
         Optional[float], pydantic.Field(alias="maxRecordSize")
     ] = 1500
@@ -347,6 +504,39 @@ class OutputSyslog(BaseModel):
     ] = 0
     r"""How often to resolve the destination hostname to an IP address. Ignored if the destination is an IP address. A value of 0 means every message sent will incur a DNS lookup."""
 
+    enable_ip_spoofing: Annotated[
+        Optional[bool], pydantic.Field(alias="enableIpSpoofing")
+    ] = False
+    r"""Send Syslog traffic using the original event's Source IP and port. To enable this, you must install the external `udp-sender` helper binary at `/usr/bin/udp-sender` on all Worker Nodes and grant it the `CAP_NET_RAW` capability."""
+
+    pq_strict_ordering: Annotated[
+        Optional[bool], pydantic.Field(alias="pqStrictOrdering")
+    ] = True
+    r"""Use FIFO (first in, first out) processing. Disable to forward new events to receivers before queue is flushed."""
+
+    pq_rate_per_sec: Annotated[
+        Optional[float], pydantic.Field(alias="pqRatePerSec")
+    ] = 0
+    r"""Throttling rate (in events per second) to impose while writing to Destinations from PQ. Defaults to 0, which disables throttling."""
+
+    pq_mode: Annotated[
+        Annotated[
+            Optional[OutputSyslogMode], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="pqMode"),
+    ] = OutputSyslogMode.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_max_buffer_size: Annotated[
+        Optional[float], pydantic.Field(alias="pqMaxBufferSize")
+    ] = 42
+    r"""The maximum number of events to hold in memory before writing the events to disk"""
+
+    pq_max_backpressure_sec: Annotated[
+        Optional[float], pydantic.Field(alias="pqMaxBackpressureSec")
+    ] = 30
+    r"""How long (in seconds) to wait for backpressure to resolve before engaging the queue"""
+
     pq_max_file_size: Annotated[
         Optional[str], pydantic.Field(alias="pqMaxFileSize")
     ] = "1 MB"
@@ -361,21 +551,103 @@ class OutputSyslog(BaseModel):
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/<output-id>."""
 
     pq_compress: Annotated[
-        Optional[OutputSyslogCompression], pydantic.Field(alias="pqCompress")
+        Annotated[
+            Optional[OutputSyslogCompression], PlainValidator(validate_open_enum(False))
+        ],
+        pydantic.Field(alias="pqCompress"),
     ] = OutputSyslogCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
     pq_on_backpressure: Annotated[
-        Optional[OutputSyslogQueueFullBehavior],
+        Annotated[
+            Optional[OutputSyslogQueueFullBehavior],
+            PlainValidator(validate_open_enum(False)),
+        ],
         pydantic.Field(alias="pqOnBackpressure"),
     ] = OutputSyslogQueueFullBehavior.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[Optional[OutputSyslogMode], pydantic.Field(alias="pqMode")] = (
-        OutputSyslogMode.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[OutputSyslogPqControls], pydantic.Field(alias="pqControls")
     ] = None
+
+    @field_serializer("protocol")
+    def serialize_protocol(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSyslogProtocol(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("facility")
+    def serialize_facility(self, value):
+        if isinstance(value, str):
+            try:
+                return models.Facility(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("severity")
+    def serialize_severity(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSyslogSeverity(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("message_format")
+    def serialize_message_format(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSyslogMessageFormat(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("timestamp_format")
+    def serialize_timestamp_format(self, value):
+        if isinstance(value, str):
+            try:
+                return models.TimestampFormat(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("on_backpressure")
+    def serialize_on_backpressure(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSyslogBackpressureBehavior(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("pq_mode")
+    def serialize_pq_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSyslogMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("pq_compress")
+    def serialize_pq_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSyslogCompression(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("pq_on_backpressure")
+    def serialize_pq_on_backpressure(self, value):
+        if isinstance(value, str):
+            try:
+                return models.OutputSyslogQueueFullBehavior(value)
+            except ValueError:
+                return value
+        return value