Skip to content

Property

Source code in docs_src/capo_glue/types/property.py
class Property(TypedDict, closed=True):
    name: "capo_glue.types.property_name.PropertyName"
    """<p>The name of the property.</p>"""
    description: "capo_glue.types.property_description_string.PropertyDescriptionString"
    """<p>A description of the property.</p>"""
    required: "capo_glue.types.bool.Bool"
    """<p>Indicates whether the property is required.</p>"""
    default_value: NotRequired["str"]
    """<p>The default value for the property.</p>"""
    property_types: "capo_glue.types.property_types.PropertyTypes"
    """<p>Describes the type of property.</p>"""
    allowed_values: NotRequired["capo_glue.types.allowed_values.AllowedValues"]
    """<p>A list of <code>AllowedValue</code> objects representing the values allowed for the property.</p>"""
    data_operation_scopes: NotRequired["capo_glue.types.data_operations.DataOperations"]
    """<p>Indicates which data operations are applicable to the property.</p>"""
    key_override: NotRequired["str"]
    """<p>A key name to use when sending this property in API requests, if different from the display name.</p>"""
    property_location: NotRequired["capo_glue.types.property_location.PropertyLocation"]
    """<p>Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.</p>"""

allowed_values instance-attribute

allowed_values: NotRequired[AllowedValues]

A list of AllowedValue objects representing the values allowed for the property.

data_operation_scopes instance-attribute

data_operation_scopes: NotRequired[DataOperations]

Indicates which data operations are applicable to the property.

default_value instance-attribute

default_value: NotRequired[str]

The default value for the property.

description instance-attribute

A description of the property.

key_override instance-attribute

key_override: NotRequired[str]

A key name to use when sending this property in API requests, if different from the display name.

name instance-attribute

The name of the property.

property_location instance-attribute

property_location: NotRequired[PropertyLocation]

Specifies where this property should be included in REST requests, such as in headers, query parameters, or request body.

property_types instance-attribute

property_types: PropertyTypes

Describes the type of property.

required instance-attribute

required: Bool

Indicates whether the property is required.