cribl-control-plane 0.2.0a1__py3-none-any.whl → 0.2.0b1__py3-none-any.whl

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"
 
 

cribl_control_plane/models/inputsystemmetrics.py

@@ -29,14 +29,18 @@ class InputSystemMetricsConnection(BaseModel):
 class InputSystemMetricsPqMode(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 InputSystemMetricsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -107,18 +111,26 @@ class InputSystemMetricsPq(BaseModel):
 class InputSystemMetricsHostMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select level of detail for host metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
 class InputSystemMetricsSystemMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of detail for system metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -143,9 +155,13 @@ class InputSystemMetricsSystem(BaseModel):
 class InputSystemMetricsCPUMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of detail for CPU metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -179,9 +195,13 @@ class InputSystemMetricsCPU(BaseModel):
 class InputSystemMetricsMemoryMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of detail for memory metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -206,9 +226,13 @@ class InputSystemMetricsMemory(BaseModel):
 class InputSystemMetricsNetworkMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of detail for network metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -245,9 +269,13 @@ class InputSystemMetricsNetwork(BaseModel):
 class InputSystemMetricsDiskMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of detail for disk metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -352,9 +380,13 @@ class InputSystemMetricsProcess(BaseModel):
 class ContainerMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of detail for container metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 

cribl_control_plane/models/inputsystemstate.py

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

cribl_control_plane/models/inputtcp.py

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

cribl_control_plane/models/inputtcpjson.py

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

cribl_control_plane/models/inputwef.py

@@ -29,14 +29,18 @@ class InputWefConnection(BaseModel):
 class InputWefMode(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 InputWefCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -106,7 +110,9 @@ class InputWefPq(BaseModel):
 class InputWefAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""How to authenticate incoming client connections"""
 
+    # Client certificate
     CLIENT_CERT = "clientCert"
+    # Kerberos
     KERBEROS = "kerberos"
 
 

cribl_control_plane/models/inputwindowsmetrics.py

@@ -29,14 +29,18 @@ class InputWindowsMetricsConnection(BaseModel):
 class InputWindowsMetricsPqMode(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 InputWindowsMetricsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -107,18 +111,26 @@ class InputWindowsMetricsPq(BaseModel):
 class InputWindowsMetricsHostMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select level of detail for host metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
 class InputWindowsMetricsSystemMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for system metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -143,9 +155,13 @@ class InputWindowsMetricsSystem(BaseModel):
 class InputWindowsMetricsCPUMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for CPU metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -179,9 +195,13 @@ class InputWindowsMetricsCPU(BaseModel):
 class InputWindowsMetricsMemoryMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for memory metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -206,9 +226,13 @@ class InputWindowsMetricsMemory(BaseModel):
 class InputWindowsMetricsNetworkMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for network metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 
@@ -245,9 +269,13 @@ class InputWindowsMetricsNetwork(BaseModel):
 class InputWindowsMetricsDiskMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select the level of details for disk metrics"""
 
+    # Basic
     BASIC = "basic"
+    # All
     ALL = "all"
+    # Custom
     CUSTOM = "custom"
+    # Disabled
     DISABLED = "disabled"
 
 

cribl_control_plane/models/inputwineventlogs.py

@@ -29,14 +29,18 @@ class InputWinEventLogsConnection(BaseModel):
 class InputWinEventLogsMode(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 InputWinEventLogsCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
@@ -107,14 +111,18 @@ class InputWinEventLogsPq(BaseModel):
 class ReadMode(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Read all stored and future event logs, or only future events"""
 
+    # Entire log
     OLDEST = "oldest"
+    # From last entry
     NEWEST = "newest"
 
 
 class EventFormat(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Format of individual events"""
 
+    # JSON
     JSON = "json"
+    # XML
     XML = "xml"