Skip to content

TransformConfigParameter

Source code in docs_src/capo_glue/types/transform_config_parameter.py
class TransformConfigParameter(TypedDict, closed=True):
    name: "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    """<p>Specifies the name of the parameter in the config file of the dynamic transform.</p>"""
    type: "capo_glue.types.param_type.ParamType"
    """<p>Specifies the parameter type in the config file of the dynamic transform.</p>"""
    validation_rule: NotRequired[
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    ]
    """<p>Specifies the validation rule in the config file of the dynamic transform.</p>"""
    validation_message: NotRequired[
        "capo_glue.types.enclosed_in_string_property.EnclosedInStringProperty"
    ]
    """<p>Specifies the validation message in the config file of the dynamic transform.</p>"""
    value: NotRequired[
        "capo_glue.types.enclosed_in_string_properties.EnclosedInStringProperties"
    ]
    """<p>Specifies the value of the parameter in the config file of the dynamic transform.</p>"""
    list_type: NotRequired["capo_glue.types.param_type.ParamType"]
    """<p>Specifies the list type of the parameter in the config file of the dynamic transform.</p>"""
    is_optional: NotRequired["capo_glue.types.boxed_boolean.BoxedBoolean"]
    """<p>Specifies whether the parameter is optional or not in the config file of the dynamic transform.</p>"""

is_optional instance-attribute

is_optional: NotRequired[BoxedBoolean]

Specifies whether the parameter is optional or not in the config file of the dynamic transform.

list_type instance-attribute

list_type: NotRequired[ParamType]

Specifies the list type of the parameter in the config file of the dynamic transform.

name instance-attribute

Specifies the name of the parameter in the config file of the dynamic transform.

type instance-attribute

type: ParamType

Specifies the parameter type in the config file of the dynamic transform.

validation_message instance-attribute

validation_message: NotRequired[EnclosedInStringProperty]

Specifies the validation message in the config file of the dynamic transform.

validation_rule instance-attribute

validation_rule: NotRequired[EnclosedInStringProperty]

Specifies the validation rule in the config file of the dynamic transform.

value instance-attribute

value: NotRequired[EnclosedInStringProperties]

Specifies the value of the parameter in the config file of the dynamic transform.