ConnectorProperty ¶

class ConnectorProperty(TypedDict, closed=True):
    name: "capo_glue.types.property_name.PropertyName"
    """<p>The name of the property.</p>"""
    key_override: NotRequired[
        "capo_glue.types.connector_property_key.ConnectorPropertyKey"
    ]
    """<p>A key name to use when sending this property in API requests, if different from the display name.</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>"""
    allowed_values: NotRequired["capo_glue.types.list_of_string.ListOfString"]
    """<p>A list of <code>AllowedValue</code> objects representing the values allowed for the property.</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>"""
    property_type: "capo_glue.types.property_type.PropertyType"
    """<p>The data type of this property</p>"""
    format: NotRequired["str"]
    """<p>A format template for the property value that defines how the value should be formatted before sending it in API requests. Use <code>{value}</code> as a placeholder for the actual property value (for example, <code>SSWS {value}</code>).</p>"""