Skip to content

RegisterConnectionTypeRequest

Source code in docs_src/capo_glue/types/register_connection_type_request.py 
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class RegisterConnectionTypeRequest(TypedDict, closed=True):
    connection_type: "capo_glue.types.name_string.NameString"
    """<p>The name of the connection type. Must be between 1 and 255 characters and must be prefixed with "REST-" to indicate it is a REST-based connector.</p>"""
    integration_type: "capo_glue.types.integration_type.IntegrationType"
    """<p>The integration type for the connection. Currently only "REST" protocol is supported.</p>"""
    description: NotRequired["capo_glue.types.description.Description"]
    """<p>A description of the connection type. Can be up to 2048 characters and provides details about the purpose and functionality of the connection type.</p>"""
    connection_properties: "capo_glue.types.connection_properties_configuration.ConnectionPropertiesConfiguration"
    """<p>Defines the base URL and additional request parameters needed during connection creation for this connection type.</p>"""
    connector_authentication_configuration: "capo_glue.types.connector_authentication_configuration.ConnectorAuthenticationConfiguration"
    """<p>Defines the supported authentication types and required properties for this connection type, including Basic, OAuth2, and Custom authentication methods.</p>"""
    rest_configuration: "capo_glue.types.rest_configuration.RestConfiguration"
    """<p>Defines the HTTP request and response configuration, validation endpoint, and entity configurations for REST API interactions.</p>"""
    tags: NotRequired["capo_glue.types.tags_map.TagsMap"]
    """<p>The tags you assign to the connection type.</p>"""

connection_properties instance-attribute 

connection_properties: ConnectionPropertiesConfiguration

Defines the base URL and additional request parameters needed during connection creation for this connection type.

connection_type instance-attribute 

connection_type: NameString

The name of the connection type. Must be between 1 and 255 characters and must be prefixed with "REST-" to indicate it is a REST-based connector.

connector_authentication_configuration instance-attribute 

connector_authentication_configuration: ConnectorAuthenticationConfiguration

Defines the supported authentication types and required properties for this connection type, including Basic, OAuth2, and Custom authentication methods.

description instance-attribute 

description: NotRequired[Description]

A description of the connection type. Can be up to 2048 characters and provides details about the purpose and functionality of the connection type.

integration_type instance-attribute 

integration_type: IntegrationType

The integration type for the connection. Currently only "REST" protocol is supported.

rest_configuration instance-attribute 

rest_configuration: RestConfiguration

Defines the HTTP request and response configuration, validation endpoint, and entity configurations for REST API interactions.

tags instance-attribute 

tags: NotRequired[TagsMap]

The tags you assign to the connection type.