cribl-control-plane 0.0.39__py3-none-any.whl → 0.5.0b3__py3-none-any.whl

cribl_control_plane/models/pipelinefunctionredis.py

@@ -0,0 +1,165 @@
+"""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 List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionRedisID(str, Enum):
+    r"""Function ID"""
+
+    REDIS = "redis"
+
+
+class PipelineFunctionRedisCommandTypedDict(TypedDict):
+    command: str
+    r"""Redis command to perform. For a complete list visit: https://redis.io/commands"""
+    key_expr: str
+    r"""A JavaScript expression to compute the value of the key to operate on. Can also be a constant such as 'username'."""
+    out_field: NotRequired[str]
+    r"""Name of the field in which to store the returned value. Leave blank to discard returned value."""
+    args_expr: NotRequired[str]
+    r"""A JavaScript expression to compute arguments to the operation. Can return an array."""
+
+
+class PipelineFunctionRedisCommand(BaseModel):
+    command: str
+    r"""Redis command to perform. For a complete list visit: https://redis.io/commands"""
+
+    key_expr: Annotated[str, pydantic.Field(alias="keyExpr")]
+    r"""A JavaScript expression to compute the value of the key to operate on. Can also be a constant such as 'username'."""
+
+    out_field: Annotated[Optional[str], pydantic.Field(alias="outField")] = None
+    r"""Name of the field in which to store the returned value. Leave blank to discard returned value."""
+
+    args_expr: Annotated[Optional[str], pydantic.Field(alias="argsExpr")] = None
+    r"""A JavaScript expression to compute arguments to the operation. Can return an array."""
+
+
+class PipelineFunctionRedisDeploymentType(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""How the Redis server is configured. Defaults to Standalone"""
+
+    # Standalone
+    STANDALONE = "standalone"
+    # Cluster
+    CLUSTER = "cluster"
+    # Sentinel
+    SENTINEL = "sentinel"
+
+
+class PipelineFunctionRedisAuthenticationMethod(
+    str, Enum, metaclass=utils.OpenEnumMeta
+):
+    # None
+    NONE = "none"
+    # Manual
+    MANUAL = "manual"
+    # User Secret
+    CREDENTIALS_SECRET = "credentialsSecret"
+    # Admin Secret
+    TEXT_SECRET = "textSecret"
+
+
+class PipelineFunctionRedisConfTypedDict(TypedDict):
+    commands: List[PipelineFunctionRedisCommandTypedDict]
+    deployment_type: NotRequired[PipelineFunctionRedisDeploymentType]
+    r"""How the Redis server is configured. Defaults to Standalone"""
+    auth_type: NotRequired[PipelineFunctionRedisAuthenticationMethod]
+    max_block_secs: NotRequired[float]
+    r"""Maximum amount of time (seconds) to wait before assuming that Redis is down and passing events through. Use 0 to disable."""
+    enable_client_side_caching: NotRequired[bool]
+    r"""Enable client-side cache. Redundant when using Redis write operations. See more options at Settings > General > Limits > Redis Cache."""
+
+
+class PipelineFunctionRedisConf(BaseModel):
+    commands: List[PipelineFunctionRedisCommand]
+
+    deployment_type: Annotated[
+        Annotated[
+            Optional[PipelineFunctionRedisDeploymentType],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="deploymentType"),
+    ] = PipelineFunctionRedisDeploymentType.STANDALONE
+    r"""How the Redis server is configured. Defaults to Standalone"""
+
+    auth_type: Annotated[
+        Annotated[
+            Optional[PipelineFunctionRedisAuthenticationMethod],
+            PlainValidator(validate_open_enum(False)),
+        ],
+        pydantic.Field(alias="authType"),
+    ] = PipelineFunctionRedisAuthenticationMethod.NONE
+
+    max_block_secs: Annotated[Optional[float], pydantic.Field(alias="maxBlockSecs")] = (
+        60
+    )
+    r"""Maximum amount of time (seconds) to wait before assuming that Redis is down and passing events through. Use 0 to disable."""
+
+    enable_client_side_caching: Annotated[
+        Optional[bool], pydantic.Field(alias="enableClientSideCaching")
+    ] = None
+    r"""Enable client-side cache. Redundant when using Redis write operations. See more options at Settings > General > Limits > Redis Cache."""
+
+    @field_serializer("deployment_type")
+    def serialize_deployment_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.PipelineFunctionRedisDeploymentType(value)
+            except ValueError:
+                return value
+        return value
+
+    @field_serializer("auth_type")
+    def serialize_auth_type(self, value):
+        if isinstance(value, str):
+            try:
+                return models.PipelineFunctionRedisAuthenticationMethod(value)
+            except ValueError:
+                return value
+        return value
+
+
+class PipelineFunctionRedisTypedDict(TypedDict):
+    id: PipelineFunctionRedisID
+    r"""Function ID"""
+    conf: PipelineFunctionRedisConfTypedDict
+    filter_: NotRequired[str]
+    r"""Filter that selects data to be fed through this Function"""
+    description: NotRequired[str]
+    r"""Simple description of this step"""
+    disabled: NotRequired[bool]
+    r"""If true, data will not be pushed through this function"""
+    final: NotRequired[bool]
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+    group_id: NotRequired[str]
+    r"""Group ID"""
+
+
+class PipelineFunctionRedis(BaseModel):
+    id: PipelineFunctionRedisID
+    r"""Function ID"""
+
+    conf: PipelineFunctionRedisConf
+
+    filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = "true"
+    r"""Filter that selects data to be fed through this Function"""
+
+    description: Optional[str] = None
+    r"""Simple description of this step"""
+
+    disabled: Optional[bool] = None
+    r"""If true, data will not be pushed through this function"""
+
+    final: Optional[bool] = None
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+
+    group_id: Annotated[Optional[str], pydantic.Field(alias="groupId")] = None
+    r"""Group ID"""

cribl_control_plane/models/pipelinefunctionregexextract.py

@@ -0,0 +1,100 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from cribl_control_plane.types import BaseModel
+from enum import Enum
+import pydantic
+from typing import List, Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionRegexExtractID(str, Enum):
+    r"""Function ID"""
+
+    REGEX_EXTRACT = "regex_extract"
+
+
+class PipelineFunctionRegexExtractRegexListTypedDict(TypedDict):
+    regex: str
+    r"""Regex literal with named capturing groups, such as (?<foo>bar), or _NAME_ and _VALUE_ capturing groups, such as (?<_NAME_0>[^ =]+)=(?<_VALUE_0>[^,]+)"""
+
+
+class PipelineFunctionRegexExtractRegexList(BaseModel):
+    regex: str
+    r"""Regex literal with named capturing groups, such as (?<foo>bar), or _NAME_ and _VALUE_ capturing groups, such as (?<_NAME_0>[^ =]+)=(?<_VALUE_0>[^,]+)"""
+
+
+class PipelineFunctionRegexExtractConfTypedDict(TypedDict):
+    regex: str
+    r"""Regex literal with named capturing groups, such as (?<foo>bar), or _NAME_ and _VALUE_ capturing groups, such as (?<_NAME_0>[^ =]+)=(?<_VALUE_0>[^,]+)"""
+    regex_list: NotRequired[List[PipelineFunctionRegexExtractRegexListTypedDict]]
+    source: NotRequired[str]
+    r"""Field on which to perform regex field extraction"""
+    iterations: NotRequired[float]
+    r"""The maximum number of times to apply regex to source field when the global flag is set, or when using _NAME_ and _VALUE_ capturing groups"""
+    field_name_expression: NotRequired[str]
+    r"""JavaScript expression to format field names when _NAME_n and _VALUE_n capturing groups are used. Original field name is in global variable 'name'. Example: To append XX to all field names, use `${name}_XX` (backticks are literal). If empty, names will be sanitized using this regex: /^[_0-9]+|[^a-zA-Z0-9_]+/g. You can access other fields values via __e.<fieldName>."""
+    overwrite: NotRequired[bool]
+    r"""Overwrite existing event fields with extracted values. If disabled, existing fields will be converted to an array."""
+
+
+class PipelineFunctionRegexExtractConf(BaseModel):
+    regex: str
+    r"""Regex literal with named capturing groups, such as (?<foo>bar), or _NAME_ and _VALUE_ capturing groups, such as (?<_NAME_0>[^ =]+)=(?<_VALUE_0>[^,]+)"""
+
+    regex_list: Annotated[
+        Optional[List[PipelineFunctionRegexExtractRegexList]],
+        pydantic.Field(alias="regexList"),
+    ] = None
+
+    source: Optional[str] = "_raw"
+    r"""Field on which to perform regex field extraction"""
+
+    iterations: Optional[float] = 100
+    r"""The maximum number of times to apply regex to source field when the global flag is set, or when using _NAME_ and _VALUE_ capturing groups"""
+
+    field_name_expression: Annotated[
+        Optional[str], pydantic.Field(alias="fieldNameExpression")
+    ] = None
+    r"""JavaScript expression to format field names when _NAME_n and _VALUE_n capturing groups are used. Original field name is in global variable 'name'. Example: To append XX to all field names, use `${name}_XX` (backticks are literal). If empty, names will be sanitized using this regex: /^[_0-9]+|[^a-zA-Z0-9_]+/g. You can access other fields values via __e.<fieldName>."""
+
+    overwrite: Optional[bool] = False
+    r"""Overwrite existing event fields with extracted values. If disabled, existing fields will be converted to an array."""
+
+
+class PipelineFunctionRegexExtractTypedDict(TypedDict):
+    id: PipelineFunctionRegexExtractID
+    r"""Function ID"""
+    conf: PipelineFunctionRegexExtractConfTypedDict
+    filter_: NotRequired[str]
+    r"""Filter that selects data to be fed through this Function"""
+    description: NotRequired[str]
+    r"""Simple description of this step"""
+    disabled: NotRequired[bool]
+    r"""If true, data will not be pushed through this function"""
+    final: NotRequired[bool]
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+    group_id: NotRequired[str]
+    r"""Group ID"""
+
+
+class PipelineFunctionRegexExtract(BaseModel):
+    id: PipelineFunctionRegexExtractID
+    r"""Function ID"""
+
+    conf: PipelineFunctionRegexExtractConf
+
+    filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = "true"
+    r"""Filter that selects data to be fed through this Function"""
+
+    description: Optional[str] = None
+    r"""Simple description of this step"""
+
+    disabled: Optional[bool] = None
+    r"""If true, data will not be pushed through this function"""
+
+    final: Optional[bool] = None
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+
+    group_id: Annotated[Optional[str], pydantic.Field(alias="groupId")] = None
+    r"""Group ID"""

cribl_control_plane/models/pipelinefunctionregexfilter.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .functionconfschemaregexfilter import (
+    FunctionConfSchemaRegexFilter,
+    FunctionConfSchemaRegexFilterTypedDict,
+)
+from cribl_control_plane.types import BaseModel
+from enum import Enum
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionRegexFilterID(str, Enum):
+    r"""Function ID"""
+
+    REGEX_FILTER = "regex_filter"
+
+
+class PipelineFunctionRegexFilterTypedDict(TypedDict):
+    id: PipelineFunctionRegexFilterID
+    r"""Function ID"""
+    conf: FunctionConfSchemaRegexFilterTypedDict
+    filter_: NotRequired[str]
+    r"""Filter that selects data to be fed through this Function"""
+    description: NotRequired[str]
+    r"""Simple description of this step"""
+    disabled: NotRequired[bool]
+    r"""If true, data will not be pushed through this function"""
+    final: NotRequired[bool]
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+    group_id: NotRequired[str]
+    r"""Group ID"""
+
+
+class PipelineFunctionRegexFilter(BaseModel):
+    id: PipelineFunctionRegexFilterID
+    r"""Function ID"""
+
+    conf: FunctionConfSchemaRegexFilter
+
+    filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = "true"
+    r"""Filter that selects data to be fed through this Function"""
+
+    description: Optional[str] = None
+    r"""Simple description of this step"""
+
+    disabled: Optional[bool] = None
+    r"""If true, data will not be pushed through this function"""
+
+    final: Optional[bool] = None
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+
+    group_id: Annotated[Optional[str], pydantic.Field(alias="groupId")] = None
+    r"""Group ID"""

cribl_control_plane/models/pipelinefunctionrename.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .functionconfschemarename import (
+    FunctionConfSchemaRename,
+    FunctionConfSchemaRenameTypedDict,
+)
+from cribl_control_plane.types import BaseModel
+from enum import Enum
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionRenameID(str, Enum):
+    r"""Function ID"""
+
+    RENAME = "rename"
+
+
+class PipelineFunctionRenameTypedDict(TypedDict):
+    id: PipelineFunctionRenameID
+    r"""Function ID"""
+    conf: FunctionConfSchemaRenameTypedDict
+    filter_: NotRequired[str]
+    r"""Filter that selects data to be fed through this Function"""
+    description: NotRequired[str]
+    r"""Simple description of this step"""
+    disabled: NotRequired[bool]
+    r"""If true, data will not be pushed through this function"""
+    final: NotRequired[bool]
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+    group_id: NotRequired[str]
+    r"""Group ID"""
+
+
+class PipelineFunctionRename(BaseModel):
+    id: PipelineFunctionRenameID
+    r"""Function ID"""
+
+    conf: FunctionConfSchemaRename
+
+    filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = "true"
+    r"""Filter that selects data to be fed through this Function"""
+
+    description: Optional[str] = None
+    r"""Simple description of this step"""
+
+    disabled: Optional[bool] = None
+    r"""If true, data will not be pushed through this function"""
+
+    final: Optional[bool] = None
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+
+    group_id: Annotated[Optional[str], pydantic.Field(alias="groupId")] = None
+    r"""Group ID"""

cribl_control_plane/models/pipelinefunctionrollupmetrics.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .functionconfschemarollupmetrics import (
+    FunctionConfSchemaRollupMetrics,
+    FunctionConfSchemaRollupMetricsTypedDict,
+)
+from cribl_control_plane.types import BaseModel
+from enum import Enum
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionRollupMetricsID(str, Enum):
+    r"""Function ID"""
+
+    ROLLUP_METRICS = "rollup_metrics"
+
+
+class PipelineFunctionRollupMetricsTypedDict(TypedDict):
+    id: PipelineFunctionRollupMetricsID
+    r"""Function ID"""
+    conf: FunctionConfSchemaRollupMetricsTypedDict
+    filter_: NotRequired[str]
+    r"""Filter that selects data to be fed through this Function"""
+    description: NotRequired[str]
+    r"""Simple description of this step"""
+    disabled: NotRequired[bool]
+    r"""If true, data will not be pushed through this function"""
+    final: NotRequired[bool]
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+    group_id: NotRequired[str]
+    r"""Group ID"""
+
+
+class PipelineFunctionRollupMetrics(BaseModel):
+    id: PipelineFunctionRollupMetricsID
+    r"""Function ID"""
+
+    conf: FunctionConfSchemaRollupMetrics
+
+    filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = "true"
+    r"""Filter that selects data to be fed through this Function"""
+
+    description: Optional[str] = None
+    r"""Simple description of this step"""
+
+    disabled: Optional[bool] = None
+    r"""If true, data will not be pushed through this function"""
+
+    final: Optional[bool] = None
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+
+    group_id: Annotated[Optional[str], pydantic.Field(alias="groupId")] = None
+    r"""Group ID"""

cribl_control_plane/models/pipelinefunctionsampling.py

@@ -0,0 +1,56 @@
+"""Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT."""
+
+from __future__ import annotations
+from .functionconfschemasampling import (
+    FunctionConfSchemaSampling,
+    FunctionConfSchemaSamplingTypedDict,
+)
+from cribl_control_plane.types import BaseModel
+from enum import Enum
+import pydantic
+from typing import Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionSamplingID(str, Enum):
+    r"""Function ID"""
+
+    SAMPLING = "sampling"
+
+
+class PipelineFunctionSamplingTypedDict(TypedDict):
+    id: PipelineFunctionSamplingID
+    r"""Function ID"""
+    conf: FunctionConfSchemaSamplingTypedDict
+    filter_: NotRequired[str]
+    r"""Filter that selects data to be fed through this Function"""
+    description: NotRequired[str]
+    r"""Simple description of this step"""
+    disabled: NotRequired[bool]
+    r"""If true, data will not be pushed through this function"""
+    final: NotRequired[bool]
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+    group_id: NotRequired[str]
+    r"""Group ID"""
+
+
+class PipelineFunctionSampling(BaseModel):
+    id: PipelineFunctionSamplingID
+    r"""Function ID"""
+
+    conf: FunctionConfSchemaSampling
+
+    filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = "true"
+    r"""Filter that selects data to be fed through this Function"""
+
+    description: Optional[str] = None
+    r"""Simple description of this step"""
+
+    disabled: Optional[bool] = None
+    r"""If true, data will not be pushed through this function"""
+
+    final: Optional[bool] = None
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+
+    group_id: Annotated[Optional[str], pydantic.Field(alias="groupId")] = None
+    r"""Group ID"""

cribl_control_plane/models/pipelinefunctionsend.py

@@ -0,0 +1,128 @@
+"""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 Optional
+from typing_extensions import Annotated, NotRequired, TypedDict
+
+
+class PipelineFunctionSendID(str, Enum):
+    r"""Function ID"""
+
+    SEND = "send"
+
+
+class PipelineFunctionSendMode(str, Enum, metaclass=utils.OpenEnumMeta):
+    r"""In Sender mode, forwards search results directly to the destination. In Metrics mode, accumulates metrics from federated send operators, and forwards the aggregate metrics."""
+
+    SENDER = "sender"
+    METRICS = "metrics"
+
+
+class SendConfigurationTypedDict(TypedDict):
+    search_id: str
+    r"""Id of the search this function is running on."""
+    url: NotRequired[str]
+    r"""Full URL to send search to."""
+    group: NotRequired[str]
+    r"""Group within the workspace we're sending to."""
+    workspace: NotRequired[str]
+    r"""Workspace within the deployment to send the search results to."""
+    send_url_template: NotRequired[str]
+    r"""Template to build the URL to send from."""
+    tee: NotRequired[str]
+    r"""Tee results to search. When set to true results will be shipped instead of stats"""
+    flush_ms: NotRequired[float]
+    r"""How often are stats flushed in ms"""
+    suppress_previews: NotRequired[bool]
+    r"""Disables generation of intermediate stats. When true stats will be emitted only on end"""
+    mode: NotRequired[PipelineFunctionSendMode]
+    r"""In Sender mode, forwards search results directly to the destination. In Metrics mode, accumulates metrics from federated send operators, and forwards the aggregate metrics."""
+
+
+class SendConfiguration(BaseModel):
+    search_id: Annotated[str, pydantic.Field(alias="searchId")]
+    r"""Id of the search this function is running on."""
+
+    url: Optional[str] = None
+    r"""Full URL to send search to."""
+
+    group: Optional[str] = "default"
+    r"""Group within the workspace we're sending to."""
+
+    workspace: Optional[str] = "main"
+    r"""Workspace within the deployment to send the search results to."""
+
+    send_url_template: Annotated[
+        Optional[str], pydantic.Field(alias="sendUrlTemplate")
+    ] = None
+    r"""Template to build the URL to send from."""
+
+    tee: Optional[str] = "false"
+    r"""Tee results to search. When set to true results will be shipped instead of stats"""
+
+    flush_ms: Annotated[Optional[float], pydantic.Field(alias="flushMs")] = 1000
+    r"""How often are stats flushed in ms"""
+
+    suppress_previews: Annotated[
+        Optional[bool], pydantic.Field(alias="suppressPreviews")
+    ] = None
+    r"""Disables generation of intermediate stats. When true stats will be emitted only on end"""
+
+    mode: Annotated[
+        Optional[PipelineFunctionSendMode], PlainValidator(validate_open_enum(False))
+    ] = None
+    r"""In Sender mode, forwards search results directly to the destination. In Metrics mode, accumulates metrics from federated send operators, and forwards the aggregate metrics."""
+
+    @field_serializer("mode")
+    def serialize_mode(self, value):
+        if isinstance(value, str):
+            try:
+                return models.PipelineFunctionSendMode(value)
+            except ValueError:
+                return value
+        return value
+
+
+class PipelineFunctionSendTypedDict(TypedDict):
+    id: PipelineFunctionSendID
+    r"""Function ID"""
+    conf: SendConfigurationTypedDict
+    filter_: NotRequired[str]
+    r"""Filter that selects data to be fed through this Function"""
+    description: NotRequired[str]
+    r"""Simple description of this step"""
+    disabled: NotRequired[bool]
+    r"""If true, data will not be pushed through this function"""
+    final: NotRequired[bool]
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+    group_id: NotRequired[str]
+    r"""Group ID"""
+
+
+class PipelineFunctionSend(BaseModel):
+    id: PipelineFunctionSendID
+    r"""Function ID"""
+
+    conf: SendConfiguration
+
+    filter_: Annotated[Optional[str], pydantic.Field(alias="filter")] = "true"
+    r"""Filter that selects data to be fed through this Function"""
+
+    description: Optional[str] = None
+    r"""Simple description of this step"""
+
+    disabled: Optional[bool] = None
+    r"""If true, data will not be pushed through this function"""
+
+    final: Optional[bool] = None
+    r"""If enabled, stops the results of this Function from being passed to the downstream Functions"""
+
+    group_id: Annotated[Optional[str], pydantic.Field(alias="groupId")] = None
+    r"""Group ID"""