cribl-control-plane 0.2.1__py3-none-any.whl → 0.2.1rc2__py3-none-any.whl

cribl_control_plane/models/inputmsk.py

@@ -29,14 +29,18 @@ class InputMskConnection(BaseModel):
 class InputMskMode(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 InputMskCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -116,13 +120,6 @@ class InputMskMetadatum(BaseModel):
     r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
 
 
-class InputMskSchemaType(str, Enum, metaclass=utils.OpenEnumMeta):
-    r"""The schema format used to encode and decode event data"""
-
-    AVRO = "avro"
-    JSON = "json"
-
-
 class InputMskAuthTypedDict(TypedDict):
     r"""Credentials to use when authenticating with the schema registry using basic HTTP authentication"""
 
@@ -233,8 +230,6 @@ class InputMskKafkaSchemaRegistryAuthenticationTypedDict(TypedDict):
     disabled: NotRequired[bool]
     schema_registry_url: NotRequired[str]
     r"""URL for accessing the Confluent Schema Registry. Example: http://localhost:8081. To connect over TLS, use https instead of http."""
-    schema_type: NotRequired[InputMskSchemaType]
-    r"""The schema format used to encode and decode event data"""
     connection_timeout: NotRequired[float]
     r"""Maximum time to wait for a Schema Registry connection to complete successfully"""
     request_timeout: NotRequired[float]
@@ -254,14 +249,6 @@ class InputMskKafkaSchemaRegistryAuthentication(BaseModel):
     ] = "http://localhost:8081"
     r"""URL for accessing the Confluent Schema Registry. Example: http://localhost:8081. To connect over TLS, use https instead of http."""
 
-    schema_type: Annotated[
-        Annotated[
-            Optional[InputMskSchemaType], PlainValidator(validate_open_enum(False))
-        ],
-        pydantic.Field(alias="schemaType"),
-    ] = InputMskSchemaType.AVRO
-    r"""The schema format used to encode and decode event data"""
-
     connection_timeout: Annotated[
         Optional[float], pydantic.Field(alias="connectionTimeout")
     ] = 30000
@@ -284,8 +271,11 @@ class InputMskKafkaSchemaRegistryAuthentication(BaseModel):
 class InputMskAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""AWS authentication method. Choose Auto to use IAM roles."""
 
+    # Auto
     AUTO = "auto"
+    # Manual
     MANUAL = "manual"
+    # Secret Key pair
     SECRET = "secret"
 
 

cribl_control_plane/models/inputnetflow.py

@@ -29,14 +29,18 @@ class InputNetflowConnection(BaseModel):
 class InputNetflowMode(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 InputNetflowCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 

cribl_control_plane/models/inputoffice365mgmt.py

@@ -29,14 +29,18 @@ class InputOffice365MgmtConnection(BaseModel):
 class InputOffice365MgmtMode(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 InputOffice365MgmtCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -107,9 +111,13 @@ class InputOffice365MgmtPq(BaseModel):
 class InputOffice365MgmtSubscriptionPlan(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Office 365 subscription plan for your organization, typically Office 365 Enterprise"""
 
+    # Office 365 Enterprise
     ENTERPRISE_GCC = "enterprise_gcc"
+    # Office 365 GCC
     GCC = "gcc"
+    # Office 365 GCC High
     GCC_HIGH = "gcc_high"
+    # Office 365 DoD
     DOD = "dod"
 
 
@@ -170,8 +178,11 @@ class InputOffice365MgmtContentConfig(BaseModel):
 class InputOffice365MgmtRetryType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The algorithm to use when performing HTTP retries"""
 
+    # Disabled
     NONE = "none"
+    # Backoff
     BACKOFF = "backoff"
+    # Static
     STATIC = "static"
 
 

cribl_control_plane/models/inputoffice365msgtrace.py

@@ -29,14 +29,18 @@ class InputOffice365MsgTraceConnection(BaseModel):
 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 = "smart"
+    # Always On
     ALWAYS = "always"
 
 
 class InputOffice365MsgTraceCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -142,8 +146,11 @@ class InputOffice365MsgTraceMetadatum(BaseModel):
 class InputOffice365MsgTraceRetryType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The algorithm to use when performing HTTP retries"""
 
+    # Disabled
     NONE = "none"
+    # Backoff
     BACKOFF = "backoff"
+    # Static
     STATIC = "static"
 
 
@@ -204,9 +211,13 @@ class InputOffice365MsgTraceRetryRules(BaseModel):
 class InputOffice365MsgTraceSubscriptionPlan(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Office 365 subscription plan for your organization, typically Office 365 Enterprise"""
 
+    # Office 365 Enterprise
     ENTERPRISE_GCC = "enterprise_gcc"
+    # Office 365 GCC
     GCC = "gcc"
+    # Office 365 GCC High
     GCC_HIGH = "gcc_high"
+    # Office 365 DoD
     DOD = "dod"
 
 

cribl_control_plane/models/inputoffice365service.py

@@ -29,14 +29,18 @@ class InputOffice365ServiceConnection(BaseModel):
 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 = "smart"
+    # Always On
     ALWAYS = "always"
 
 
 class InputOffice365ServiceCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -107,9 +111,13 @@ class InputOffice365ServicePq(BaseModel):
 class InputOffice365ServiceSubscriptionPlan(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Office 365 subscription plan for your organization, typically Office 365 Enterprise"""
 
+    # Office 365 Enterprise
     ENTERPRISE_GCC = "enterprise_gcc"
+    # Office 365 GCC
     GCC = "gcc"
+    # Office 365 GCC High
     GCC_HIGH = "gcc_high"
+    # Office 365 DoD
     DOD = "dod"
 
 
@@ -170,8 +178,11 @@ class InputOffice365ServiceContentConfig(BaseModel):
 class InputOffice365ServiceRetryType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The algorithm to use when performing HTTP retries"""
 
+    # Disabled
     NONE = "none"
+    # Backoff
     BACKOFF = "backoff"
+    # Static
     STATIC = "static"
 
 

cribl_control_plane/models/inputopentelemetry.py

@@ -29,14 +29,18 @@ class InputOpenTelemetryConnection(BaseModel):
 class InputOpenTelemetryMode(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 InputOpenTelemetryCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -189,14 +193,18 @@ class InputOpenTelemetryTLSSettingsServerSide(BaseModel):
 class InputOpenTelemetryProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select whether to leverage gRPC or HTTP for OpenTelemetry"""
 
+    # gRPC
     GRPC = "grpc"
+    # HTTP
     HTTP = "http"
 
 
 class InputOpenTelemetryOTLPVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The version of OTLP Protobuf definitions to use when interpreting received data"""
 
+    # 0.10.0
     ZERO_DOT_10_DOT_0 = "0.10.0"
+    # 1.3.1
     ONE_DOT_3_DOT_1 = "1.3.1"
 
 

cribl_control_plane/models/inputprometheus.py

@@ -29,14 +29,18 @@ class InputPrometheusConnection(BaseModel):
 class InputPrometheusMode(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 InputPrometheusCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -106,8 +110,11 @@ class InputPrometheusPq(BaseModel):
 class InputPrometheusDiscoveryType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Target discovery mechanism. Use static to manually enter a list of targets."""
 
+    # Static
     STATIC = "static"
+    # DNS
     DNS = "dns"
+    # AWS EC2
     EC2 = "ec2"
 
 
@@ -177,8 +184,11 @@ class InputPrometheusAwsAuthenticationMethodAuthenticationMethod(
 ):
     r"""AWS authentication method. Choose Auto to use IAM roles."""
 
+    # Auto
     AUTO = "auto"
+    # Manual
     MANUAL = "manual"
+    # Secret Key pair
     SECRET = "secret"
 
 

cribl_control_plane/models/inputprometheusrw.py

@@ -29,14 +29,18 @@ class InputPrometheusRwConnection(BaseModel):
 class InputPrometheusRwMode(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 InputPrometheusRwCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 

cribl_control_plane/models/inputrawudp.py

@@ -29,14 +29,18 @@ class InputRawUDPConnection(BaseModel):
 class InputRawUDPMode(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 InputRawUDPCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 

cribl_control_plane/models/inputs3.py

@@ -29,14 +29,18 @@ class InputS3Connection(BaseModel):
 class InputS3Mode(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 InputS3Compression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -106,8 +110,11 @@ class InputS3Pq(BaseModel):
 class InputS3AuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""AWS authentication method. Choose Auto to use IAM roles."""
 
+    # Auto
     AUTO = "auto"
+    # Manual
     MANUAL = "manual"
+    # Secret Key pair
     SECRET = "secret"
 
 

cribl_control_plane/models/inputs3inventory.py

@@ -29,14 +29,18 @@ class InputS3InventoryConnection(BaseModel):
 class InputS3InventoryMode(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 InputS3InventoryCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -106,8 +110,11 @@ class InputS3InventoryPq(BaseModel):
 class InputS3InventoryAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""AWS authentication method. Choose Auto to use IAM roles."""
 
+    # Auto
     AUTO = "auto"
+    # Manual
     MANUAL = "manual"
+    # Secret Key pair
     SECRET = "secret"
 
 

cribl_control_plane/models/inputsecuritylake.py

@@ -29,14 +29,18 @@ class InputSecurityLakeConnection(BaseModel):
 class InputSecurityLakeMode(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 InputSecurityLakeCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -107,8 +111,11 @@ class InputSecurityLakePq(BaseModel):
 class InputSecurityLakeAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""AWS authentication method. Choose Auto to use IAM roles."""
 
+    # Auto
     AUTO = "auto"
+    # Manual
     MANUAL = "manual"
+    # Secret Key pair
     SECRET = "secret"
 
 

cribl_control_plane/models/inputsnmp.py

@@ -29,14 +29,18 @@ class InputSnmpConnection(BaseModel):
 class InputSnmpMode(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 InputSnmpCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -104,12 +108,19 @@ class InputSnmpPq(BaseModel):
 
 
 class AuthenticationProtocol(str, Enum, metaclass=utils.OpenEnumMeta):
+    # None
     NONE = "none"
+    # MD5
     MD5 = "md5"
+    # SHA1
     SHA = "sha"
+    # SHA224
     SHA224 = "sha224"
+    # SHA256
     SHA256 = "sha256"
+    # SHA384
     SHA384 = "sha384"
+    # SHA512
     SHA512 = "sha512"
 
 

cribl_control_plane/models/inputsplunk.py

@@ -29,14 +29,18 @@ class InputSplunkConnection(BaseModel):
 class InputSplunkMode(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 InputSplunkPqCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -214,15 +218,20 @@ class InputSplunkAuthToken(BaseModel):
 class InputSplunkMaxS2SVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The highest S2S protocol version to advertise during handshake"""
 
+    # v3
     V3 = "v3"
+    # v4
     V4 = "v4"
 
 
 class InputSplunkCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Controls whether to support reading compressed data from a forwarder. Select 'Automatic' to match the forwarder's configuration, or 'Disabled' to reject compressed connections."""
 
+    # Disabled
     DISABLED = "disabled"
+    # Automatic
     AUTO = "auto"
+    # Always
     ALWAYS = "always"
 
 

cribl_control_plane/models/inputsplunkhec.py

@@ -29,14 +29,18 @@ class InputSplunkHecConnection(BaseModel):
 class InputSplunkHecMode(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 InputSplunkHecCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 

cribl_control_plane/models/inputsplunksearch.py

@@ -29,14 +29,18 @@ class InputSplunkSearchConnection(BaseModel):
 class InputSplunkSearchMode(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 InputSplunkSearchCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -162,8 +166,11 @@ class InputSplunkSearchMetadatum(BaseModel):
 class InputSplunkSearchRetryType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The algorithm to use when performing HTTP retries"""
 
+    # Disabled
     NONE = "none"
+    # Backoff
     BACKOFF = "backoff"
+    # Static
     STATIC = "static"
 
 

cribl_control_plane/models/inputsqs.py

@@ -29,14 +29,18 @@ class InputSqsConnection(BaseModel):
 class InputSqsMode(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 InputSqsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -106,15 +110,20 @@ class InputSqsPq(BaseModel):
 class InputSqsQueueType(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""The queue type used (or created)"""
 
+    # Standard
     STANDARD = "standard"
+    # FIFO
     FIFO = "fifo"
 
 
 class InputSqsAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""AWS authentication method. Choose Auto to use IAM roles."""
 
+    # Auto
     AUTO = "auto"
+    # Manual
     MANUAL = "manual"
+    # Secret Key pair
     SECRET = "secret"
 
 

cribl_control_plane/models/inputsyslog.py

@@ -29,14 +29,18 @@ class InputSyslogConnection2(BaseModel):
 class InputSyslogMode2(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 InputSyslogCompression2(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -412,14 +416,18 @@ class InputSyslogConnection1(BaseModel):
 class InputSyslogMode1(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 InputSyslogCompression1(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"