Skip to content

CustomParameter

Source code in docs_src/capo_datazone/types/custom_parameter.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
class CustomParameter(TypedDict, closed=True):
    key_name: "str"
    """<p>The key name of the parameter.</p>"""
    description: NotRequired["capo_datazone.types.description.Description"]
    """<p>The description of the parameter.</p>"""
    field_type: "str"
    """<p>The filed type of the parameter.</p>"""
    default_value: NotRequired["str"]
    """<p>The default value of the parameter.</p>"""
    is_editable: NotRequired["bool"]
    """<p>Specifies whether the parameter is editable.</p>"""
    is_optional: NotRequired["bool"]
    """<p>Specifies whether the custom parameter is optional.</p>"""
    is_update_supported: NotRequired["bool"]
    """<p>Specifies whether a parameter value can be updated after creation. </p>"""

default_value instance-attribute 

default_value: NotRequired[str]

The default value of the parameter.

description instance-attribute 

description: NotRequired[Description]

The description of the parameter.

field_type instance-attribute 

field_type: str

The filed type of the parameter.

is_editable instance-attribute 

is_editable: NotRequired[bool]

Specifies whether the parameter is editable.

is_optional instance-attribute 

is_optional: NotRequired[bool]

Specifies whether the custom parameter is optional.

is_update_supported instance-attribute 

is_update_supported: NotRequired[bool]

Specifies whether a parameter value can be updated after creation.

key_name instance-attribute 

key_name: str

The key name of the parameter.