Connector
class resources.connector.Connector
Base class: Resource
Connection information for a system which can be accessed for automation by Cloudomation.
See the corresponding Flow Api class at Connector
Property | Description | Type | Import/Export |
---|---|---|---|
analysis_data | JSONB(astext_type=Text()) | export only | |
bundle_id | Reference to the bundle this record is associated with. Allowed for CONNECTOR, FILE, FLOW, PLUGIN, ROLE, SCHEDULER, SCHEMA, SETTING, TAG, WRAPPER. Not allowed for BUNDLE, BUNDLE_REPOSITORY, EXECUTION, GIT_CONFIG, LDAP_CONFIG, MESSAGE, OAUTH, ORGANIZATION, PROCESS, PROJECT, SCHEDULE, SYNC_CONFIG, USER, VAULT_CONFIG, WEBHOOK, WORKSPACE. Mutually exclusive with project_id | UUID(as_uuid=False) | both |
bundle_name | The name of the bundle. Will look up the bundle and set bundle_id. | String(length=128) | neither |
connector_type | The type of the connector / the type of the remote system. | Enum('AWS', 'AZURE', 'AZUREAI', 'FTP', 'GIT', 'GOOGLE', 'IMAP', 'K8S', 'LDAP', 'MSTEAMS', 'MYSQL', 'OPENAI', 'PS', 'REDIS', 'REST', 'SCP', 'SMB', 'SMTP', 'SOAP', 'SQLMSSQL', 'SQLORACLE', 'SQLPG', 'SSH', 'VAULT', 'WEBDAV', 'XMLRPC', name='connectortype') | both |
created_at | DateTime(timezone=True) | export only | |
created_by | UUID(as_uuid=False) | export only | |
deleted_at | DateTime(timezone=True) | export only | |
deleted_by | UUID(as_uuid=False) | export only | |
description | Text() | both | |
id | UUID(as_uuid=False) | neither | |
input_schema | JSONB(astext_type=Text()) | neither | |
is_archived | Boolean() | both | |
is_bundle_readonly | Boolean() | neither | |
is_deleted | Boolean() | export only | |
is_project_readonly | Boolean() | neither | |
is_readonly | A flag to control if the record can be modified. Allowed for BUNDLE, BUNDLE_REPOSITORY, CONNECTOR, FILE, FLOW, GIT_CONFIG, OAUTH, PLUGIN, PROJECT, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for EXECUTION, LDAP_CONFIG, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACE | Boolean() | both |
last_analysis_at | DateTime(timezone=True) | export only | |
modified_at | DateTime(timezone=True) | export only | |
modified_by | UUID(as_uuid=False) | export only | |
name | String(length=128) | both | |
organization_id | UUID(as_uuid=False) | export only | |
output_schema | JSONB(astext_type=Text()) | neither | |
project_id | Reference to the project this record is associated with. Allowed for CONNECTOR, EXECUTION, FILE, FLOW, GIT_CONFIG, MESSAGE, OAUTH, PLUGIN, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, BUNDLE_REPOSITORY, LDAP_CONFIG, ORGANIZATION, PROCESS, PROJECT, ROLE, USER, WORKSPACE. Mutually exclusive with bundle_id. | UUID(as_uuid=False) | both |
project_name | The name of the project. Will look up the project and set project_id. | String(length=128) | neither |
record_type | Enum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'EXECUTION', 'FILE', 'FLOW', 'GIT_CONFIG', 'LDAP_CONFIG', 'MESSAGE', 'OAUTH', 'ORGANIZATION', 'PLUGIN', 'PROCESS', 'PROJECT', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='recordtype') | neither | |
repository_path | The path to the storing repository, relative to GIT_REPOSITORY_SAVE_PATH | String(length=256) | neither |
resource_type | Enum('BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'FILE', 'FLOW', 'GIT_CONFIG', 'LDAP_CONFIG', 'OAUTH', 'ORGANIZATION', 'PLUGIN', 'PROJECT', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='resourcetype') | neither | |
schema_version | String(length=128) | both | |
value | The connector information. | JSONB(astext_type=Text()) | both |
workspace_id | UUID(as_uuid=False) | export only |