cribl-control-plane 0.0.28__py3-none-any.whl → 0.0.30__py3-none-any.whl

cribl_control_plane/models/inputcribllakehttp.py

@@ -174,6 +174,37 @@ class InputCriblLakeHTTPMetadatum(BaseModel):
     r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
 
 
+class InputCriblLakeHTTPAuthTokensExtMetadatumTypedDict(TypedDict):
+    name: str
+    value: str
+    r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
+
+
+class InputCriblLakeHTTPAuthTokensExtMetadatum(BaseModel):
+    name: str
+
+    value: str
+    r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
+
+
+class InputCriblLakeHTTPAuthTokensExtTypedDict(TypedDict):
+    token: str
+    r"""Shared secret to be provided by any client (Authorization: <token>)"""
+    description: NotRequired[str]
+    metadata: NotRequired[List[InputCriblLakeHTTPAuthTokensExtMetadatumTypedDict]]
+    r"""Fields to add to events referencing this token"""
+
+
+class InputCriblLakeHTTPAuthTokensExt(BaseModel):
+    token: str
+    r"""Shared secret to be provided by any client (Authorization: <token>)"""
+
+    description: Optional[str] = None
+
+    metadata: Optional[List[InputCriblLakeHTTPAuthTokensExtMetadatum]] = None
+    r"""Fields to add to events referencing this token"""
+
+
 class InputCriblLakeHTTPTypedDict(TypedDict):
     type: InputCriblLakeHTTPType
     port: float
@@ -221,8 +252,17 @@ class InputCriblLakeHTTPTypedDict(TypedDict):
     r"""Messages from matched IP addresses will be processed, unless also matched by the denylist"""
     ip_denylist_regex: NotRequired[str]
     r"""Messages from matched IP addresses will be ignored. This takes precedence over the allowlist."""
+    cribl_api: NotRequired[str]
+    r"""Absolute path on which to listen for the Cribl HTTP API requests. Only _bulk (default /cribl/_bulk) is available. Use empty string to disable."""
+    elastic_api: NotRequired[str]
+    r"""Absolute path on which to listen for the Elasticsearch API requests. Only _bulk (default /elastic/_bulk) is available. Use empty string to disable."""
+    splunk_hec_api: NotRequired[str]
+    r"""Absolute path on which listen for the Splunk HTTP Event Collector API requests. Use empty string to disable."""
+    splunk_hec_acks: NotRequired[bool]
     metadata: NotRequired[List[InputCriblLakeHTTPMetadatumTypedDict]]
     r"""Fields to add to events from this input"""
+    auth_tokens_ext: NotRequired[List[InputCriblLakeHTTPAuthTokensExtTypedDict]]
+    r"""Shared secrets to be provided by any client (Authorization: <token>). If empty, unauthorized access is permitted."""
     description: NotRequired[str]
 
 
@@ -324,7 +364,30 @@ class InputCriblLakeHTTP(BaseModel):
     ] = "/^$/"
     r"""Messages from matched IP addresses will be ignored. This takes precedence over the allowlist."""
 
+    cribl_api: Annotated[Optional[str], pydantic.Field(alias="criblAPI")] = "/cribl"
+    r"""Absolute path on which to listen for the Cribl HTTP API requests. Only _bulk (default /cribl/_bulk) is available. Use empty string to disable."""
+
+    elastic_api: Annotated[Optional[str], pydantic.Field(alias="elasticAPI")] = (
+        "/elastic"
+    )
+    r"""Absolute path on which to listen for the Elasticsearch API requests. Only _bulk (default /elastic/_bulk) is available. Use empty string to disable."""
+
+    splunk_hec_api: Annotated[Optional[str], pydantic.Field(alias="splunkHecAPI")] = (
+        "/services/collector"
+    )
+    r"""Absolute path on which listen for the Splunk HTTP Event Collector API requests. Use empty string to disable."""
+
+    splunk_hec_acks: Annotated[
+        Optional[bool], pydantic.Field(alias="splunkHecAcks")
+    ] = False
+
     metadata: Optional[List[InputCriblLakeHTTPMetadatum]] = None
     r"""Fields to add to events from this input"""
 
+    auth_tokens_ext: Annotated[
+        Optional[List[InputCriblLakeHTTPAuthTokensExt]],
+        pydantic.Field(alias="authTokensExt"),
+    ] = None
+    r"""Shared secrets to be provided by any client (Authorization: <token>). If empty, unauthorized access is permitted."""
+
     description: Optional[str] = None

cribl_control_plane/models/inputcrowdstrike.py

@@ -200,6 +200,8 @@ class InputCrowdstrikeTypedDict(TypedDict):
     r"""Socket inactivity timeout (in seconds). Increase this value if timeouts occur due to backpressure."""
     skip_on_error: NotRequired[bool]
     r"""Skip files that trigger a processing error. Disabled by default, which allows retries after processing errors."""
+    include_sqs_metadata: NotRequired[bool]
+    r"""Include metadata from SQS notifications on outgoing events"""
     enable_assume_role: NotRequired[bool]
     r"""Use Assume Role credentials to access Amazon S3"""
     assume_role_arn: NotRequired[str]
@@ -333,6 +335,11 @@ class InputCrowdstrike(BaseModel):
     )
     r"""Skip files that trigger a processing error. Disabled by default, which allows retries after processing errors."""
 
+    include_sqs_metadata: Annotated[
+        Optional[bool], pydantic.Field(alias="includeSqsMetadata")
+    ] = False
+    r"""Include metadata from SQS notifications on outgoing events"""
+
     enable_assume_role: Annotated[
         Optional[bool], pydantic.Field(alias="enableAssumeRole")
     ] = True

cribl_control_plane/models/inputs3.py

@@ -195,6 +195,8 @@ class InputS3TypedDict(TypedDict):
     r"""Socket inactivity timeout (in seconds). Increase this value if timeouts occur due to backpressure."""
     skip_on_error: NotRequired[bool]
     r"""Skip files that trigger a processing error. Disabled by default, which allows retries after processing errors."""
+    include_sqs_metadata: NotRequired[bool]
+    r"""Include metadata from SQS notifications on outgoing events"""
     enable_assume_role: NotRequired[bool]
     r"""Use Assume Role credentials to access Amazon S3"""
     assume_role_arn: NotRequired[str]
@@ -332,6 +334,11 @@ class InputS3(BaseModel):
     )
     r"""Skip files that trigger a processing error. Disabled by default, which allows retries after processing errors."""
 
+    include_sqs_metadata: Annotated[
+        Optional[bool], pydantic.Field(alias="includeSqsMetadata")
+    ] = False
+    r"""Include metadata from SQS notifications on outgoing events"""
+
     enable_assume_role: Annotated[
         Optional[bool], pydantic.Field(alias="enableAssumeRole")
     ] = True

cribl_control_plane/models/inputs3inventory.py

@@ -200,6 +200,8 @@ class InputS3InventoryTypedDict(TypedDict):
     r"""Socket inactivity timeout (in seconds). Increase this value if timeouts occur due to backpressure."""
     skip_on_error: NotRequired[bool]
     r"""Skip files that trigger a processing error. Disabled by default, which allows retries after processing errors."""
+    include_sqs_metadata: NotRequired[bool]
+    r"""Include metadata from SQS notifications on outgoing events"""
     enable_assume_role: NotRequired[bool]
     r"""Use Assume Role credentials to access Amazon S3"""
     assume_role_arn: NotRequired[str]
@@ -341,6 +343,11 @@ class InputS3Inventory(BaseModel):
     )
     r"""Skip files that trigger a processing error. Disabled by default, which allows retries after processing errors."""
 
+    include_sqs_metadata: Annotated[
+        Optional[bool], pydantic.Field(alias="includeSqsMetadata")
+    ] = False
+    r"""Include metadata from SQS notifications on outgoing events"""
+
     enable_assume_role: Annotated[
         Optional[bool], pydantic.Field(alias="enableAssumeRole")
     ] = True

cribl_control_plane/models/inputsecuritylake.py

@@ -200,6 +200,8 @@ class InputSecurityLakeTypedDict(TypedDict):
     r"""Socket inactivity timeout (in seconds). Increase this value if timeouts occur due to backpressure."""
     skip_on_error: NotRequired[bool]
     r"""Skip files that trigger a processing error. Disabled by default, which allows retries after processing errors."""
+    include_sqs_metadata: NotRequired[bool]
+    r"""Include metadata from SQS notifications on outgoing events"""
     enable_assume_role: NotRequired[bool]
     r"""Use Assume Role credentials to access Amazon S3"""
     assume_role_arn: NotRequired[str]
@@ -337,6 +339,11 @@ class InputSecurityLake(BaseModel):
     )
     r"""Skip files that trigger a processing error. Disabled by default, which allows retries after processing errors."""
 
+    include_sqs_metadata: Annotated[
+        Optional[bool], pydantic.Field(alias="includeSqsMetadata")
+    ] = False
+    r"""Include metadata from SQS notifications on outgoing events"""
+
     enable_assume_role: Annotated[
         Optional[bool], pydantic.Field(alias="enableAssumeRole")
     ] = True

cribl_control_plane/models/{getproductsgroupsbyproductop.py → listconfiggroupbyproductop.py}

@@ -13,35 +13,35 @@ from typing import List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class GetProductsGroupsByProductProduct(str, Enum):
-    r"""Cribl Product"""
+class ListConfigGroupByProductProduct(str, Enum):
+    r"""Name of the Cribl product to get the Worker Groups or Edge Fleets for."""
 
     STREAM = "stream"
     EDGE = "edge"
 
 
-class GetProductsGroupsByProductRequestTypedDict(TypedDict):
-    product: GetProductsGroupsByProductProduct
-    r"""Cribl Product"""
+class ListConfigGroupByProductRequestTypedDict(TypedDict):
+    product: ListConfigGroupByProductProduct
+    r"""Name of the Cribl product to get the Worker Groups or Edge Fleets for."""
     fields: NotRequired[str]
-    r"""fields to add to results: git.commit, git.localChanges, git.log"""
+    r"""Comma-separated list of additional properties to include in the response. Available values are <code>git.commit</code>, <code>git.localChanges</code>, and <code>git.log</code>."""
 
 
-class GetProductsGroupsByProductRequest(BaseModel):
+class ListConfigGroupByProductRequest(BaseModel):
     product: Annotated[
-        GetProductsGroupsByProductProduct,
+        ListConfigGroupByProductProduct,
         FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
     ]
-    r"""Cribl Product"""
+    r"""Name of the Cribl product to get the Worker Groups or Edge Fleets for."""
 
     fields: Annotated[
         Optional[str],
         FieldMetadata(query=QueryParamMetadata(style="form", explode=True)),
     ] = None
-    r"""fields to add to results: git.commit, git.localChanges, git.log"""
+    r"""Comma-separated list of additional properties to include in the response. Available values are <code>git.commit</code>, <code>git.localChanges</code>, and <code>git.log</code>."""
 
 
-class GetProductsGroupsByProductResponseTypedDict(TypedDict):
+class ListConfigGroupByProductResponseTypedDict(TypedDict):
     r"""a list of ConfigGroup objects"""
 
     count: NotRequired[int]
@@ -49,7 +49,7 @@ class GetProductsGroupsByProductResponseTypedDict(TypedDict):
     items: NotRequired[List[ConfigGroupTypedDict]]
 
 
-class GetProductsGroupsByProductResponse(BaseModel):
+class ListConfigGroupByProductResponse(BaseModel):
     r"""a list of ConfigGroup objects"""
 
     count: Optional[int] = None

cribl_control_plane/models/{getworkersop.py → listmasterworkerentryop.py}

@@ -9,7 +9,7 @@ from typing import List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class GetWorkersRequestTypedDict(TypedDict):
+class ListMasterWorkerEntryRequestTypedDict(TypedDict):
     filter_exp: NotRequired[str]
     r"""Filter expression evaluated against nodes"""
     sort: NotRequired[str]
@@ -24,7 +24,7 @@ class GetWorkersRequestTypedDict(TypedDict):
     r"""Filter object (JSON stringified) to select nodes"""
 
 
-class GetWorkersRequest(BaseModel):
+class ListMasterWorkerEntryRequest(BaseModel):
     filter_exp: Annotated[
         Optional[str],
         pydantic.Field(alias="filterExp"),
@@ -65,7 +65,7 @@ class GetWorkersRequest(BaseModel):
     r"""Filter object (JSON stringified) to select nodes"""
 
 
-class GetWorkersResponseTypedDict(TypedDict):
+class ListMasterWorkerEntryResponseTypedDict(TypedDict):
     r"""a list of MasterWorkerEntry objects"""
 
     count: NotRequired[int]
@@ -73,7 +73,7 @@ class GetWorkersResponseTypedDict(TypedDict):
     items: NotRequired[List[MasterWorkerEntryTypedDict]]
 
 
-class GetWorkersResponse(BaseModel):
+class ListMasterWorkerEntryResponse(BaseModel):
     r"""a list of MasterWorkerEntry objects"""
 
     count: Optional[int] = None

cribl_control_plane/models/{updategroupsbyidop.py → updateconfiggroupbyproductandidop.py}

@@ -4,25 +4,41 @@ from __future__ import annotations
 from .configgroup import ConfigGroup, ConfigGroupTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
+from enum import Enum
 import pydantic
 from typing import List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class UpdateGroupsByIDRequestTypedDict(TypedDict):
+class UpdateConfigGroupByProductAndIDProduct(str, Enum):
+    r"""Name of the Cribl product to get the Worker Groups or Edge Fleets for."""
+
+    STREAM = "stream"
+    EDGE = "edge"
+
+
+class UpdateConfigGroupByProductAndIDRequestTypedDict(TypedDict):
+    product: UpdateConfigGroupByProductAndIDProduct
+    r"""Name of the Cribl product to get the Worker Groups or Edge Fleets for."""
     id_param: str
-    r"""Group ID"""
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to update."""
     config_group: ConfigGroupTypedDict
     r"""ConfigGroup object"""
 
 
-class UpdateGroupsByIDRequest(BaseModel):
+class UpdateConfigGroupByProductAndIDRequest(BaseModel):
+    product: Annotated[
+        UpdateConfigGroupByProductAndIDProduct,
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""Name of the Cribl product to get the Worker Groups or Edge Fleets for."""
+
     id_param: Annotated[
         str,
         pydantic.Field(alias="id"),
         FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
     ]
-    r"""Group ID"""
+    r"""The <code>id</code> of the Worker Group or Edge Fleet to update."""
 
     config_group: Annotated[
         ConfigGroup,
@@ -31,7 +47,7 @@ class UpdateGroupsByIDRequest(BaseModel):
     r"""ConfigGroup object"""
 
 
-class UpdateGroupsByIDResponseTypedDict(TypedDict):
+class UpdateConfigGroupByProductAndIDResponseTypedDict(TypedDict):
     r"""a list of ConfigGroup objects"""
 
     count: NotRequired[int]
@@ -39,7 +55,7 @@ class UpdateGroupsByIDResponseTypedDict(TypedDict):
     items: NotRequired[List[ConfigGroupTypedDict]]
 
 
-class UpdateGroupsByIDResponse(BaseModel):
+class UpdateConfigGroupByProductAndIDResponse(BaseModel):
     r"""a list of ConfigGroup objects"""
 
     count: Optional[int] = None

cribl_control_plane/models/{updategroupsdeploybyidop.py → updateconfiggroupdeploybyproductandidop.py}

@@ -5,22 +5,38 @@ from .configgroup import ConfigGroup, ConfigGroupTypedDict
 from .deployrequest import DeployRequest, DeployRequestTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
+from enum import Enum
 from typing import List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
-class UpdateGroupsDeployByIDRequestTypedDict(TypedDict):
+class UpdateConfigGroupDeployByProductAndIDProduct(str, Enum):
+    r"""Name of the Cribl product to get the Worker Groups or Edge Fleets for."""
+
+    STREAM = "stream"
+    EDGE = "edge"
+
+
+class UpdateConfigGroupDeployByProductAndIDRequestTypedDict(TypedDict):
+    product: UpdateConfigGroupDeployByProductAndIDProduct
+    r"""Name of the Cribl product to get the Worker Groups or Edge Fleets for."""
     id: str
-    r"""Group ID"""
+    r"""The <code>id</code> of the target Worker Group or Edge Fleet for commit deployment."""
     deploy_request: DeployRequestTypedDict
     r"""DeployRequest object"""
 
 
-class UpdateGroupsDeployByIDRequest(BaseModel):
+class UpdateConfigGroupDeployByProductAndIDRequest(BaseModel):
+    product: Annotated[
+        UpdateConfigGroupDeployByProductAndIDProduct,
+        FieldMetadata(path=PathParamMetadata(style="simple", explode=False)),
+    ]
+    r"""Name of the Cribl product to get the Worker Groups or Edge Fleets for."""
+
     id: Annotated[
         str, FieldMetadata(path=PathParamMetadata(style="simple", explode=False))
     ]
-    r"""Group ID"""
+    r"""The <code>id</code> of the target Worker Group or Edge Fleet for commit deployment."""
 
     deploy_request: Annotated[
         DeployRequest,
@@ -29,7 +45,7 @@ class UpdateGroupsDeployByIDRequest(BaseModel):
     r"""DeployRequest object"""
 
 
-class UpdateGroupsDeployByIDResponseTypedDict(TypedDict):
+class UpdateConfigGroupDeployByProductAndIDResponseTypedDict(TypedDict):
     r"""a list of ConfigGroup objects"""
 
     count: NotRequired[int]
@@ -37,7 +53,7 @@ class UpdateGroupsDeployByIDResponseTypedDict(TypedDict):
     items: NotRequired[List[ConfigGroupTypedDict]]
 
 
-class UpdateGroupsDeployByIDResponse(BaseModel):
+class UpdateConfigGroupDeployByProductAndIDResponse(BaseModel):
     r"""a list of ConfigGroup objects"""
 
     count: Optional[int] = None