cribl-control-plane 0.0.22__py3-none-any.whl → 0.0.24__py3-none-any.whl

cribl_control_plane/models/createpipelineop.py

@@ -8,7 +8,7 @@ from typing_extensions import NotRequired, TypedDict
 
 
 class CreatePipelineResponseTypedDict(TypedDict):
-    r"""a list of Pipeline objects"""
+    r"""a list of Pipelines objects"""
 
     count: NotRequired[int]
     r"""number of items present in the items array"""
@@ -16,7 +16,7 @@ class CreatePipelineResponseTypedDict(TypedDict):
 
 
 class CreatePipelineResponse(BaseModel):
-    r"""a list of Pipeline objects"""
+    r"""a list of Pipelines objects"""
 
     count: Optional[int] = None
     r"""number of items present in the items array"""

cribl_control_plane/models/input.py

@@ -20,7 +20,7 @@ from .inputexec import InputExec, InputExecTypedDict
 from .inputfile import InputFile, InputFileTypedDict
 from .inputfirehose import InputFirehose, InputFirehoseTypedDict
 from .inputgooglepubsub import InputGooglePubsub, InputGooglePubsubTypedDict
-from .inputgrafana_union import InputGrafanaUnion, InputGrafanaUnionTypedDict
+from .inputgrafana import InputGrafana, InputGrafanaTypedDict
 from .inputhttp import InputHTTP, InputHTTPTypedDict
 from .inputhttpraw import InputHTTPRaw, InputHTTPRawTypedDict
 from .inputjournalfiles import InputJournalFiles, InputJournalFilesTypedDict
@@ -55,7 +55,7 @@ from .inputsplunk import InputSplunk, InputSplunkTypedDict
 from .inputsplunkhec import InputSplunkHec, InputSplunkHecTypedDict
 from .inputsplunksearch import InputSplunkSearch, InputSplunkSearchTypedDict
 from .inputsqs import InputSqs, InputSqsTypedDict
-from .inputsyslog_union import InputSyslogUnion, InputSyslogUnionTypedDict
+from .inputsyslog import InputSyslog, InputSyslogTypedDict
 from .inputsystemmetrics import InputSystemMetrics, InputSystemMetricsTypedDict
 from .inputsystemstate import InputSystemState, InputSystemStateTypedDict
 from .inputtcp import InputTCP, InputTCPTypedDict
@@ -128,8 +128,8 @@ InputTypedDict = TypeAliasType(
         InputS3InventoryTypedDict,
         InputMskTypedDict,
         InputSplunkSearchTypedDict,
-        InputSyslogUnionTypedDict,
-        InputGrafanaUnionTypedDict,
+        InputSyslogTypedDict,
+        InputGrafanaTypedDict,
     ],
 )
 
@@ -193,7 +193,7 @@ Input = TypeAliasType(
         InputS3Inventory,
         InputMsk,
         InputSplunkSearch,
-        InputSyslogUnion,
-        InputGrafanaUnion,
+        InputSyslog,
+        InputGrafana,
     ],
 )

cribl_control_plane/models/inputedgeprometheus.py

@@ -155,7 +155,7 @@ class InputEdgePrometheusAuthTypeAuthenticationMethod(str, Enum):
     KUBERNETES = "kubernetes"
 
 
-class InputEdgePrometheusTargetProtocol(str, Enum):
+class TargetProtocol(str, Enum):
     r"""Protocol to use when collecting metrics"""
 
     HTTP = "http"
@@ -165,7 +165,7 @@ class InputEdgePrometheusTargetProtocol(str, Enum):
 class TargetTypedDict(TypedDict):
     host: str
     r"""Name of host from which to pull metrics."""
-    protocol: NotRequired[InputEdgePrometheusTargetProtocol]
+    protocol: NotRequired[TargetProtocol]
     r"""Protocol to use when collecting metrics"""
     port: NotRequired[float]
     r"""The port number in the metrics URL for discovered targets."""
@@ -177,9 +177,7 @@ class Target(BaseModel):
     host: str
     r"""Name of host from which to pull metrics."""
 
-    protocol: Optional[InputEdgePrometheusTargetProtocol] = (
-        InputEdgePrometheusTargetProtocol.HTTP
-    )
+    protocol: Optional[TargetProtocol] = TargetProtocol.HTTP
     r"""Protocol to use when collecting metrics"""
 
     port: Optional[float] = 9090
@@ -197,7 +195,7 @@ class InputEdgePrometheusRecordType(str, Enum):
     AAAA = "AAAA"
 
 
-class InputEdgePrometheusScrapeProtocolProtocol(str, Enum):
+class ScrapeProtocolProtocol(str, Enum):
     r"""Protocol to use when collecting metrics"""
 
     HTTP = "http"
@@ -286,7 +284,7 @@ class InputEdgePrometheusTypedDict(TypedDict):
     r"""List of DNS names to resolve"""
     record_type: NotRequired[InputEdgePrometheusRecordType]
     r"""DNS Record type to resolve"""
-    scrape_protocol: NotRequired[InputEdgePrometheusScrapeProtocolProtocol]
+    scrape_protocol: NotRequired[ScrapeProtocolProtocol]
     r"""Protocol to use when collecting metrics"""
     scrape_path: NotRequired[str]
     r"""Path to use when collecting metrics from discovered targets"""
@@ -410,9 +408,8 @@ class InputEdgePrometheus(BaseModel):
     r"""DNS Record type to resolve"""
 
     scrape_protocol: Annotated[
-        Optional[InputEdgePrometheusScrapeProtocolProtocol],
-        pydantic.Field(alias="scrapeProtocol"),
-    ] = InputEdgePrometheusScrapeProtocolProtocol.HTTP
+        Optional[ScrapeProtocolProtocol], pydantic.Field(alias="scrapeProtocol")
+    ] = ScrapeProtocolProtocol.HTTP
     r"""Protocol to use when collecting metrics"""
 
     scrape_path: Annotated[Optional[str], pydantic.Field(alias="scrapePath")] = (

cribl_control_plane/models/{inputgrafana_union.py → inputgrafana.py}

@@ -1194,12 +1194,12 @@ class InputGrafanaGrafana1(BaseModel):
     description: Optional[str] = None
 
 
-InputGrafanaUnionTypedDict = TypeAliasType(
-    "InputGrafanaUnionTypedDict",
+InputGrafanaTypedDict = TypeAliasType(
+    "InputGrafanaTypedDict",
     Union[InputGrafanaGrafana1TypedDict, InputGrafanaGrafana2TypedDict],
 )
 
 
-InputGrafanaUnion = TypeAliasType(
-    "InputGrafanaUnion", Union[InputGrafanaGrafana1, InputGrafanaGrafana2]
+InputGrafana = TypeAliasType(
+    "InputGrafana", Union[InputGrafanaGrafana1, InputGrafanaGrafana2]
 )

cribl_control_plane/models/{inputsyslog_union.py → inputsyslog.py}

@@ -724,12 +724,12 @@ class InputSyslogSyslog1(BaseModel):
     r"""When enabled, parses PROXY protocol headers during the TLS handshake. Disable if compatibility issues arise."""
 
 
-InputSyslogUnionTypedDict = TypeAliasType(
-    "InputSyslogUnionTypedDict",
+InputSyslogTypedDict = TypeAliasType(
+    "InputSyslogTypedDict",
     Union[InputSyslogSyslog1TypedDict, InputSyslogSyslog2TypedDict],
 )
 
 
-InputSyslogUnion = TypeAliasType(
-    "InputSyslogUnion", Union[InputSyslogSyslog1, InputSyslogSyslog2]
+InputSyslog = TypeAliasType(
+    "InputSyslog", Union[InputSyslogSyslog1, InputSyslogSyslog2]
 )

cribl_control_plane/models/inputwef.py

@@ -200,13 +200,13 @@ class QueryBuilderMode(str, Enum):
     XML = "xml"
 
 
-class InputWefSubscriptionMetadatumTypedDict(TypedDict):
+class SubscriptionMetadatumTypedDict(TypedDict):
     name: str
     value: str
     r"""JavaScript expression to compute field's value, enclosed in quotes or backticks. (Can evaluate to a constant.)"""
 
 
-class InputWefSubscriptionMetadatum(BaseModel):
+class SubscriptionMetadatum(BaseModel):
     name: str
 
     value: str
@@ -234,7 +234,7 @@ class SubscriptionTypedDict(TypedDict):
     locale: NotRequired[str]
     r"""The RFC-3066 locale the Windows clients should use when sending events. Defaults to \"en-US\"."""
     query_selector: NotRequired[QueryBuilderMode]
-    metadata: NotRequired[List[InputWefSubscriptionMetadatumTypedDict]]
+    metadata: NotRequired[List[SubscriptionMetadatumTypedDict]]
     r"""Fields to add to events ingested under this subscription"""
 
 
@@ -280,7 +280,7 @@ class Subscription(BaseModel):
         Optional[QueryBuilderMode], pydantic.Field(alias="querySelector")
     ] = QueryBuilderMode.SIMPLE
 
-    metadata: Optional[List[InputWefSubscriptionMetadatum]] = None
+    metadata: Optional[List[SubscriptionMetadatum]] = None
     r"""Fields to add to events ingested under this subscription"""
 
 

cribl_control_plane/models/outputgooglepubsub.py

@@ -20,21 +20,21 @@ class OutputGooglePubsubGoogleAuthenticationMethod(str, Enum):
     SECRET = "secret"
 
 
-class OutputGooglePubsubFlushPeriodSecType(str, Enum):
+class FlushPeriodSecType(str, Enum):
     NUMBER = "number"
 
 
 class FlushPeriodSecTypedDict(TypedDict):
     r"""Maximum time to wait before sending a batch (when batch size limit is not reached)."""
 
-    type: NotRequired[OutputGooglePubsubFlushPeriodSecType]
+    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: Optional[OutputGooglePubsubFlushPeriodSecType] = None
+    type: Optional[FlushPeriodSecType] = None
 
     default: Optional[float] = None
 

cribl_control_plane/models/outputsplunklb.py

@@ -124,7 +124,7 @@ class OutputSplunkLbCompressCompression(str, Enum):
     ALWAYS = "always"
 
 
-class OutputSplunkLbAuthTokenAuthenticationMethod(str, Enum):
+class IndexerDiscoveryConfigsAuthTokenAuthenticationMethod(str, Enum):
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
 
     MANUAL = "manual"
@@ -132,19 +132,19 @@ class OutputSplunkLbAuthTokenAuthenticationMethod(str, Enum):
 
 
 class OutputSplunkLbAuthTokenTypedDict(TypedDict):
-    auth_type: NotRequired[OutputSplunkLbAuthTokenAuthenticationMethod]
+    auth_type: NotRequired[IndexerDiscoveryConfigsAuthTokenAuthenticationMethod]
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
 
 
 class OutputSplunkLbAuthToken(BaseModel):
     auth_type: Annotated[
-        Optional[OutputSplunkLbAuthTokenAuthenticationMethod],
+        Optional[IndexerDiscoveryConfigsAuthTokenAuthenticationMethod],
         pydantic.Field(alias="authType"),
-    ] = OutputSplunkLbAuthTokenAuthenticationMethod.MANUAL
+    ] = IndexerDiscoveryConfigsAuthTokenAuthenticationMethod.MANUAL
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
 
 
-class OutputSplunkLbIndexerDiscoveryConfigsAuthenticationMethod(str, Enum):
+class IndexerDiscoveryConfigsAuthenticationMethod(str, Enum):
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
 
     MANUAL = "manual"
@@ -164,7 +164,7 @@ class IndexerDiscoveryConfigsTypedDict(TypedDict):
     r"""During indexer discovery, reject cluster manager certificates that are not authorized by the system's CA. Disable to allow untrusted (for example, self-signed) certificates."""
     auth_tokens: NotRequired[List[OutputSplunkLbAuthTokenTypedDict]]
     r"""Tokens required to authenticate to cluster manager for indexer discovery"""
-    auth_type: NotRequired[OutputSplunkLbIndexerDiscoveryConfigsAuthenticationMethod]
+    auth_type: NotRequired[IndexerDiscoveryConfigsAuthenticationMethod]
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
     auth_token: NotRequired[str]
     r"""Shared secret to be provided by any client (in authToken header field). If empty, unauthorized access is permitted."""
@@ -197,9 +197,9 @@ class IndexerDiscoveryConfigs(BaseModel):
     r"""Tokens required to authenticate to cluster manager for indexer discovery"""
 
     auth_type: Annotated[
-        Optional[OutputSplunkLbIndexerDiscoveryConfigsAuthenticationMethod],
+        Optional[IndexerDiscoveryConfigsAuthenticationMethod],
         pydantic.Field(alias="authType"),
-    ] = OutputSplunkLbIndexerDiscoveryConfigsAuthenticationMethod.MANUAL
+    ] = IndexerDiscoveryConfigsAuthenticationMethod.MANUAL
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
 
     auth_token: Annotated[Optional[str], pydantic.Field(alias="authToken")] = ""

cribl_control_plane/models/routes.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 from .routesroute import RoutesRoute, RoutesRouteTypedDict
-from .routesroute_input import RoutesRouteInput, RoutesRouteInputTypedDict
 from cribl_control_plane.types import BaseModel
 import pydantic
 from pydantic import ConfigDict
@@ -72,26 +71,3 @@ class Routes(BaseModel):
 
     comments: Optional[List[Comment]] = None
     r"""Comments"""
-
-
-class RoutesInputTypedDict(TypedDict):
-    routes: List[RoutesRouteInputTypedDict]
-    r"""Pipeline routing rules"""
-    id: NotRequired[str]
-    r"""Routes ID"""
-    groups: NotRequired[Dict[str, RoutesGroupsTypedDict]]
-    comments: NotRequired[List[CommentTypedDict]]
-    r"""Comments"""
-
-
-class RoutesInput(BaseModel):
-    routes: List[RoutesRouteInput]
-    r"""Pipeline routing rules"""
-
-    id: Optional[str] = None
-    r"""Routes ID"""
-
-    groups: Optional[Dict[str, RoutesGroups]] = None
-
-    comments: Optional[List[Comment]] = None
-    r"""Comments"""

cribl_control_plane/models/updateinputbyidop.py

@@ -12,7 +12,7 @@ class UpdateInputByIDRequestTypedDict(TypedDict):
     id: str
     r"""Unique ID to PATCH"""
     input: InputTypedDict
-    r"""Source object to be updated"""
+    r"""Input object"""
 
 
 class UpdateInputByIDRequest(BaseModel):
@@ -24,7 +24,7 @@ class UpdateInputByIDRequest(BaseModel):
     input: Annotated[
         Input, FieldMetadata(request=RequestMetadata(media_type="application/json"))
     ]
-    r"""Source object to be updated"""
+    r"""Input object"""
 
 
 class UpdateInputByIDResponseTypedDict(TypedDict):

cribl_control_plane/models/updateoutputbyidop.py

@@ -12,7 +12,7 @@ class UpdateOutputByIDRequestTypedDict(TypedDict):
     id: str
     r"""Unique ID to PATCH"""
     output: OutputTypedDict
-    r"""Destination object to be updated"""
+    r"""Output object"""
 
 
 class UpdateOutputByIDRequest(BaseModel):
@@ -24,7 +24,7 @@ class UpdateOutputByIDRequest(BaseModel):
     output: Annotated[
         Output, FieldMetadata(request=RequestMetadata(media_type="application/json"))
     ]
-    r"""Destination object to be updated"""
+    r"""Output object"""
 
 
 class UpdateOutputByIDResponseTypedDict(TypedDict):

cribl_control_plane/models/updatepipelinebyidop.py

@@ -31,7 +31,7 @@ class UpdatePipelineByIDRequest(BaseModel):
 
 
 class UpdatePipelineByIDResponseTypedDict(TypedDict):
-    r"""a list of Pipeline objects"""
+    r"""a list of any objects"""
 
     count: NotRequired[int]
     r"""number of items present in the items array"""
@@ -39,7 +39,7 @@ class UpdatePipelineByIDResponseTypedDict(TypedDict):
 
 
 class UpdatePipelineByIDResponse(BaseModel):
-    r"""a list of Pipeline objects"""
+    r"""a list of any objects"""
 
     count: Optional[int] = None
     r"""number of items present in the items array"""

cribl_control_plane/models/updateroutesbyidop.py

@@ -1,7 +1,7 @@
 """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
 
 from __future__ import annotations
-from .routes import Routes, RoutesInput, RoutesInputTypedDict, RoutesTypedDict
+from .routes import Routes, RoutesTypedDict
 from cribl_control_plane.types import BaseModel
 from cribl_control_plane.utils import FieldMetadata, PathParamMetadata, RequestMetadata
 import pydantic
@@ -12,8 +12,8 @@ from typing_extensions import Annotated, NotRequired, TypedDict
 class UpdateRoutesByIDRequestTypedDict(TypedDict):
     id_param: str
     r"""Unique ID to PATCH"""
-    routes: RoutesInputTypedDict
-    r"""Routes object to be updated"""
+    routes: RoutesTypedDict
+    r"""Routes object"""
 
 
 class UpdateRoutesByIDRequest(BaseModel):
@@ -25,10 +25,9 @@ class UpdateRoutesByIDRequest(BaseModel):
     r"""Unique ID to PATCH"""
 
     routes: Annotated[
-        RoutesInput,
-        FieldMetadata(request=RequestMetadata(media_type="application/json")),
+        Routes, FieldMetadata(request=RequestMetadata(media_type="application/json"))
     ]
-    r"""Routes object to be updated"""
+    r"""Routes object"""
 
 
 class UpdateRoutesByIDResponseTypedDict(TypedDict):

cribl_control_plane/{workers_sdk.py → nodes.py}

@@ -9,10 +9,8 @@ from cribl_control_plane.utils.unmarshal_json_response import unmarshal_json_res
 from typing import Any, Mapping, Optional
 
 
-class WorkersSDK(BaseSDK):
-    r"""Actions related to Workers"""
-
-    def get_summary_workers(
+class Nodes(BaseSDK):
+    def get_count(
         self,
         *,
         filter_exp: Optional[str] = None,
@@ -21,7 +19,7 @@ class WorkersSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetSummaryWorkersResponse:
-        r"""get worker and edge nodes count
+        r"""Retrieve a count of Worker and Edge Nodes
 
         get worker and edge nodes count
 
@@ -99,7 +97,7 @@ class WorkersSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def get_summary_workers_async(
+    async def get_count_async(
         self,
         *,
         filter_exp: Optional[str] = None,
@@ -108,7 +106,7 @@ class WorkersSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetSummaryWorkersResponse:
-        r"""get worker and edge nodes count
+        r"""Retrieve a count of Worker and Edge Nodes
 
         get worker and edge nodes count
 
@@ -186,7 +184,7 @@ class WorkersSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def get_workers(
+    def list(
         self,
         *,
         filter_exp: Optional[str] = None,
@@ -200,7 +198,7 @@ class WorkersSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetWorkersResponse:
-        r"""get worker and edge nodes
+        r"""Retrieve detailed metadata for Worker and Edge Nodes
 
         get worker and edge nodes
 
@@ -288,7 +286,7 @@ class WorkersSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def get_workers_async(
+    async def list_async(
         self,
         *,
         filter_exp: Optional[str] = None,
@@ -302,7 +300,7 @@ class WorkersSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.GetWorkersResponse:
-        r"""get worker and edge nodes
+        r"""Retrieve detailed metadata for Worker and Edge Nodes
 
         get worker and edge nodes
 
@@ -390,7 +388,7 @@ class WorkersSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    def update_workers_restart(
+    def restart(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -398,7 +396,7 @@ class WorkersSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdateWorkersRestartResponse:
-        r"""restarts worker nodes
+        r"""Restart Worker and Edge Nodes
 
         restarts worker nodes
 
@@ -472,7 +470,7 @@ class WorkersSDK(BaseSDK):
 
         raise errors.APIError("Unexpected response received", http_res)
 
-    async def update_workers_restart_async(
+    async def restart_async(
         self,
         *,
         retries: OptionalNullable[utils.RetryConfig] = UNSET,
@@ -480,7 +478,7 @@ class WorkersSDK(BaseSDK):
         timeout_ms: Optional[int] = None,
         http_headers: Optional[Mapping[str, str]] = None,
     ) -> models.UpdateWorkersRestartResponse:
-        r"""restarts worker nodes
+        r"""Restart Worker and Edge Nodes
 
         restarts worker nodes