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

cribl_control_plane/models/inputsplunk.py

@@ -1,10 +1,14 @@
 """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 typing import Any, List, Optional
+from pydantic import field_serializer
+from pydantic.functional_validators import PlainValidator
+from typing import List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
 
@@ -23,20 +27,32 @@ class InputSplunkConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputSplunkMode(str, Enum):
+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):
+class InputSplunkPqCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputSplunkPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputSplunkPqControls(BaseModel):
+    pass
+
+
 class InputSplunkPqTypedDict(TypedDict):
     mode: NotRequired[InputSplunkMode]
     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."""
@@ -52,10 +68,13 @@ class InputSplunkPqTypedDict(TypedDict):
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
     compress: NotRequired[InputSplunkPqCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputSplunkPqControlsTypedDict]
 
 
 class InputSplunkPq(BaseModel):
-    mode: Optional[InputSplunkMode] = InputSplunkMode.ALWAYS
+    mode: Annotated[
+        Optional[InputSplunkMode], PlainValidator(validate_open_enum(False))
+    ] = InputSplunkMode.ALWAYS
     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."""
 
     max_buffer_size: Annotated[
@@ -79,18 +98,42 @@ class InputSplunkPq(BaseModel):
     path: Optional[str] = "$CRIBL_HOME/state/queues"
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
 
-    compress: Optional[InputSplunkPqCompression] = InputSplunkPqCompression.NONE
+    compress: Annotated[
+        Optional[InputSplunkPqCompression], PlainValidator(validate_open_enum(False))
+    ] = InputSplunkPqCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputSplunkPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputSplunkMinimumTLSVersion(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkPqCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputSplunkMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputSplunkMaximumTLSVersion(str, Enum):
+class InputSplunkMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -99,6 +142,12 @@ class InputSplunkMaximumTLSVersion(str, Enum):
 
 class InputSplunkTLSSettingsServerSideTypedDict(TypedDict):
     disabled: NotRequired[bool]
+    request_cert: NotRequired[bool]
+    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
+    reject_unauthorized: NotRequired[bool]
+    r"""Reject certificates not authorized by a CA in the CA certificate path or by another trusted CA (such as the system's)"""
+    common_name_regex: NotRequired[str]
+    r"""Regex matching allowable common names in peer certificates' subject attribute"""
     certificate_name: NotRequired[str]
     r"""The name of the predefined certificate"""
     priv_key_path: NotRequired[str]
@@ -109,10 +158,6 @@ class InputSplunkTLSSettingsServerSideTypedDict(TypedDict):
     r"""Path on server containing certificates to use. PEM format. Can reference $ENV_VARS."""
     ca_path: NotRequired[str]
     r"""Path on server containing CA certificates to use. PEM format. Can reference $ENV_VARS."""
-    request_cert: NotRequired[bool]
-    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
-    reject_unauthorized: NotRequired[Any]
-    common_name_regex: NotRequired[Any]
     min_version: NotRequired[InputSplunkMinimumTLSVersion]
     max_version: NotRequired[InputSplunkMaximumTLSVersion]
 
@@ -120,6 +165,19 @@ class InputSplunkTLSSettingsServerSideTypedDict(TypedDict):
 class InputSplunkTLSSettingsServerSide(BaseModel):
     disabled: Optional[bool] = True
 
+    request_cert: Annotated[Optional[bool], pydantic.Field(alias="requestCert")] = False
+    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
+
+    reject_unauthorized: Annotated[
+        Optional[bool], pydantic.Field(alias="rejectUnauthorized")
+    ] = True
+    r"""Reject certificates not authorized by a CA in the CA certificate path or by another trusted CA (such as the system's)"""
+
+    common_name_regex: Annotated[
+        Optional[str], pydantic.Field(alias="commonNameRegex")
+    ] = "/.*/"
+    r"""Regex matching allowable common names in peer certificates' subject attribute"""
+
     certificate_name: Annotated[
         Optional[str], pydantic.Field(alias="certificateName")
     ] = None
@@ -137,25 +195,40 @@ class InputSplunkTLSSettingsServerSide(BaseModel):
     ca_path: Annotated[Optional[str], pydantic.Field(alias="caPath")] = None
     r"""Path on server containing CA certificates to use. PEM format. Can reference $ENV_VARS."""
 
-    request_cert: Annotated[Optional[bool], pydantic.Field(alias="requestCert")] = False
-    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
-
-    reject_unauthorized: Annotated[
-        Optional[Any], pydantic.Field(alias="rejectUnauthorized")
-    ] = None
-
-    common_name_regex: Annotated[
-        Optional[Any], pydantic.Field(alias="commonNameRegex")
-    ] = None
-
     min_version: Annotated[
-        Optional[InputSplunkMinimumTLSVersion], pydantic.Field(alias="minVersion")
+        Annotated[
+            Optional[InputSplunkMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputSplunkMaximumTLSVersion], pydantic.Field(alias="maxVersion")
+        Annotated[
+            Optional[InputSplunkMaximumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="maxVersion"),
     ] = None
 
+    @field_serializer("min_version")
+    def serialize_min_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputSplunkMetadatumTypedDict(TypedDict):
     name: str
@@ -183,27 +256,32 @@ class InputSplunkAuthToken(BaseModel):
     description: Optional[str] = None
 
 
-class InputSplunkMaxS2SVersion(str, Enum):
+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):
+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"
 
 
 class InputSplunkTypedDict(TypedDict):
+    type: InputSplunkType
     port: float
     r"""Port to listen on"""
     id: NotRequired[str]
     r"""Unique ID for this input"""
-    type: NotRequired[InputSplunkType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -255,14 +333,14 @@ class InputSplunkTypedDict(TypedDict):
 
 
 class InputSplunk(BaseModel):
+    type: InputSplunkType
+
     port: float
     r"""Port to listen on"""
 
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
-    type: Optional[InputSplunkType] = None
-
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None
@@ -341,7 +419,11 @@ class InputSplunk(BaseModel):
     r"""Shared secrets to be provided by any Splunk forwarder. If empty, unauthorized access is permitted."""
 
     max_s2_sversion: Annotated[
-        Optional[InputSplunkMaxS2SVersion], pydantic.Field(alias="maxS2Sversion")
+        Annotated[
+            Optional[InputSplunkMaxS2SVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="maxS2Sversion"),
     ] = InputSplunkMaxS2SVersion.V3
     r"""The highest S2S protocol version to advertise during handshake"""
 
@@ -362,5 +444,25 @@ class InputSplunk(BaseModel):
     ] = False
     r"""Extract and process Splunk-generated metrics as Cribl metrics"""
 
-    compress: Optional[InputSplunkCompression] = InputSplunkCompression.DISABLED
+    compress: Annotated[
+        Optional[InputSplunkCompression], PlainValidator(validate_open_enum(False))
+    ] = InputSplunkCompression.DISABLED
     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."""
+
+    @field_serializer("max_s2_sversion")
+    def serialize_max_s2_sversion(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkMaxS2SVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkCompression(value)
+            except ValueError:
+                return value
+        return value

cribl_control_plane/models/inputsplunkhec.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 Any, List, Optional
 from typing_extensions import Annotated, NotRequired, TypedDict
 
@@ -23,20 +27,32 @@ class InputSplunkHecConnection(BaseModel):
     pipeline: Optional[str] = None
 
 
-class InputSplunkHecMode(str, Enum):
+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):
+class InputSplunkHecCompression(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Codec to use to compress the persisted data"""
 
+    # None
     NONE = "none"
+    # Gzip
     GZIP = "gzip"
 
 
+class InputSplunkHecPqControlsTypedDict(TypedDict):
+    pass
+
+
+class InputSplunkHecPqControls(BaseModel):
+    pass
+
+
 class InputSplunkHecPqTypedDict(TypedDict):
     mode: NotRequired[InputSplunkHecMode]
     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."""
@@ -52,10 +68,13 @@ class InputSplunkHecPqTypedDict(TypedDict):
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
     compress: NotRequired[InputSplunkHecCompression]
     r"""Codec to use to compress the persisted data"""
+    pq_controls: NotRequired[InputSplunkHecPqControlsTypedDict]
 
 
 class InputSplunkHecPq(BaseModel):
-    mode: Optional[InputSplunkHecMode] = InputSplunkHecMode.ALWAYS
+    mode: Annotated[
+        Optional[InputSplunkHecMode], PlainValidator(validate_open_enum(False))
+    ] = InputSplunkHecMode.ALWAYS
     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."""
 
     max_buffer_size: Annotated[
@@ -79,11 +98,35 @@ class InputSplunkHecPq(BaseModel):
     path: Optional[str] = "$CRIBL_HOME/state/queues"
     r"""The location for the persistent queue files. To this field's value, the system will append: /<worker-id>/inputs/<input-id>"""
 
-    compress: Optional[InputSplunkHecCompression] = InputSplunkHecCompression.NONE
+    compress: Annotated[
+        Optional[InputSplunkHecCompression], PlainValidator(validate_open_enum(False))
+    ] = InputSplunkHecCompression.NONE
     r"""Codec to use to compress the persisted data"""
 
+    pq_controls: Annotated[
+        Optional[InputSplunkHecPqControls], pydantic.Field(alias="pqControls")
+    ] = None
 
-class InputSplunkHecAuthenticationMethod(str, Enum):
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkHecMode(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("compress")
+    def serialize_compress(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkHecCompression(value)
+            except ValueError:
+                return value
+        return value
+
+
+class InputSplunkHecAuthenticationMethod(str, Enum, metaclass=utils.OpenEnumMeta):
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
 
     MANUAL = "manual"
@@ -104,10 +147,12 @@ class InputSplunkHecAuthTokenMetadatum(BaseModel):
 
 
 class InputSplunkHecAuthTokenTypedDict(TypedDict):
-    token: Any
+    token: str
+    r"""Shared secret to be provided by any client (Authorization: <token>)"""
     auth_type: NotRequired[InputSplunkHecAuthenticationMethod]
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
-    token_secret: NotRequired[Any]
+    token_secret: NotRequired[str]
+    r"""Select or create a stored text secret"""
     enabled: NotRequired[bool]
     description: NotRequired[str]
     r"""Optional token description"""
@@ -118,14 +163,20 @@ class InputSplunkHecAuthTokenTypedDict(TypedDict):
 
 
 class InputSplunkHecAuthToken(BaseModel):
-    token: Any
+    token: str
+    r"""Shared secret to be provided by any client (Authorization: <token>)"""
 
     auth_type: Annotated[
-        Optional[InputSplunkHecAuthenticationMethod], pydantic.Field(alias="authType")
+        Annotated[
+            Optional[InputSplunkHecAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
     ] = InputSplunkHecAuthenticationMethod.MANUAL
     r"""Select Manual to enter an auth token directly, or select Secret to use a text secret to authenticate"""
 
-    token_secret: Annotated[Optional[Any], pydantic.Field(alias="tokenSecret")] = None
+    token_secret: Annotated[Optional[str], pydantic.Field(alias="tokenSecret")] = None
+    r"""Select or create a stored text secret"""
 
     enabled: Optional[bool] = True
 
@@ -140,15 +191,24 @@ class InputSplunkHecAuthToken(BaseModel):
     metadata: Optional[List[InputSplunkHecAuthTokenMetadatum]] = None
     r"""Fields to add to events referencing this token"""
 
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkHecAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
 
-class InputSplunkHecMinimumTLSVersion(str, Enum):
+class InputSplunkHecMinimumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
     TL_SV1_3 = "TLSv1.3"
 
 
-class InputSplunkHecMaximumTLSVersion(str, Enum):
+class InputSplunkHecMaximumTLSVersion(str, Enum, metaclass=utils.OpenEnumMeta):
     TL_SV1 = "TLSv1"
     TL_SV1_1 = "TLSv1.1"
     TL_SV1_2 = "TLSv1.2"
@@ -157,6 +217,12 @@ class InputSplunkHecMaximumTLSVersion(str, Enum):
 
 class InputSplunkHecTLSSettingsServerSideTypedDict(TypedDict):
     disabled: NotRequired[bool]
+    request_cert: NotRequired[bool]
+    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
+    reject_unauthorized: NotRequired[bool]
+    r"""Reject certificates not authorized by a CA in the CA certificate path or by another trusted CA (such as the system's)"""
+    common_name_regex: NotRequired[str]
+    r"""Regex matching allowable common names in peer certificates' subject attribute"""
     certificate_name: NotRequired[str]
     r"""The name of the predefined certificate"""
     priv_key_path: NotRequired[str]
@@ -167,10 +233,6 @@ class InputSplunkHecTLSSettingsServerSideTypedDict(TypedDict):
     r"""Path on server containing certificates to use. PEM format. Can reference $ENV_VARS."""
     ca_path: NotRequired[str]
     r"""Path on server containing CA certificates to use. PEM format. Can reference $ENV_VARS."""
-    request_cert: NotRequired[bool]
-    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
-    reject_unauthorized: NotRequired[Any]
-    common_name_regex: NotRequired[Any]
     min_version: NotRequired[InputSplunkHecMinimumTLSVersion]
     max_version: NotRequired[InputSplunkHecMaximumTLSVersion]
 
@@ -178,6 +240,19 @@ class InputSplunkHecTLSSettingsServerSideTypedDict(TypedDict):
 class InputSplunkHecTLSSettingsServerSide(BaseModel):
     disabled: Optional[bool] = True
 
+    request_cert: Annotated[Optional[bool], pydantic.Field(alias="requestCert")] = False
+    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
+
+    reject_unauthorized: Annotated[
+        Optional[bool], pydantic.Field(alias="rejectUnauthorized")
+    ] = True
+    r"""Reject certificates not authorized by a CA in the CA certificate path or by another trusted CA (such as the system's)"""
+
+    common_name_regex: Annotated[
+        Optional[str], pydantic.Field(alias="commonNameRegex")
+    ] = "/.*/"
+    r"""Regex matching allowable common names in peer certificates' subject attribute"""
+
     certificate_name: Annotated[
         Optional[str], pydantic.Field(alias="certificateName")
     ] = None
@@ -195,25 +270,40 @@ class InputSplunkHecTLSSettingsServerSide(BaseModel):
     ca_path: Annotated[Optional[str], pydantic.Field(alias="caPath")] = None
     r"""Path on server containing CA certificates to use. PEM format. Can reference $ENV_VARS."""
 
-    request_cert: Annotated[Optional[bool], pydantic.Field(alias="requestCert")] = False
-    r"""Require clients to present their certificates. Used to perform client authentication using SSL certs."""
-
-    reject_unauthorized: Annotated[
-        Optional[Any], pydantic.Field(alias="rejectUnauthorized")
-    ] = None
-
-    common_name_regex: Annotated[
-        Optional[Any], pydantic.Field(alias="commonNameRegex")
-    ] = None
-
     min_version: Annotated[
-        Optional[InputSplunkHecMinimumTLSVersion], pydantic.Field(alias="minVersion")
+        Annotated[
+            Optional[InputSplunkHecMinimumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="minVersion"),
     ] = None
 
     max_version: Annotated[
-        Optional[InputSplunkHecMaximumTLSVersion], pydantic.Field(alias="maxVersion")
+        Annotated[
+            Optional[InputSplunkHecMaximumTLSVersion],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="maxVersion"),
     ] = None
 
+    @field_serializer("min_version")
+    def serialize_min_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkHecMinimumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("max_version")
+    def serialize_max_version(self, value):
+        if isinstance(value, str):
+            try:
+                return models.InputSplunkHecMaximumTLSVersion(value)
+            except ValueError:
+                return value
+        return value
+
 
 class InputSplunkHecMetadatumTypedDict(TypedDict):
     name: str
@@ -229,11 +319,11 @@ class InputSplunkHecMetadatum(BaseModel):
 
 
 class InputSplunkHecTypedDict(TypedDict):
+    type: InputSplunkHecType
     port: float
     r"""Port to listen on"""
     id: NotRequired[str]
     r"""Unique ID for this input"""
-    type: NotRequired[InputSplunkHecType]
     disabled: NotRequired[bool]
     pipeline: NotRequired[str]
     r"""Pipeline to process data from this Source before sending it through the Routes"""
@@ -302,14 +392,14 @@ class InputSplunkHecTypedDict(TypedDict):
 
 
 class InputSplunkHec(BaseModel):
+    type: InputSplunkHecType
+
     port: float
     r"""Port to listen on"""
 
     id: Optional[str] = None
     r"""Unique ID for this input"""
 
-    type: Optional[InputSplunkHecType] = None
-
     disabled: Optional[bool] = False
 
     pipeline: Optional[str] = None