Connector
class resources.connector.Connector
Base class: Resource
Connection information for a system which can be accessed for automation by Cloudomation Engine.
See the corresponding Flow Api class at Connector
Property | Description | Type | Import/Export | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
bundle_id | Reference to the bundle this record is associated with. Allowed for BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, EXECUTION, FILE, FLOW, LDAP_CONFIG, MESSAGE, OAUTH, OBJECT_TEMPLATE, PLUGIN, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, CHAT, ORGANIZATION, PROCESS, PROJECT, USER, 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) | import only | |||||||||||||||
commit_message | The commit message for this change. | Text() | import only | |||||||||||||||
connector_type | The type of the connector / the type of the remote system. | Enum('AWS', 'AZURE', 'AZUREAI', 'FTP', 'GIT', 'GOOGLE', 'IMAP', 'K8S', 'LDAP', 'MYSQL', 'OPENAI', 'PS', 'REDIS', 'REST', 'SCP', 'SFTP', '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) | import only | ||||||||||||||||
deleted_by | UUID(as_uuid=False) | import only | ||||||||||||||||
description | A multiline description of what this record is and does. | Text() | both | |||||||||||||||
has_deprecation | Boolean() | export only | ||||||||||||||||
has_syntax_error | Boolean() | export only | ||||||||||||||||
id | UUID(as_uuid=False) | neither | ||||||||||||||||
input_schema | JSONEncodedData() | neither | ||||||||||||||||
is_bundle_content | A flag to control if the resource is considered bundle content. Changes in bundle content mark the bundle as modified. Updating the bundle will modify the bundle content. | 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, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, FILE, FLOW, OAUTH, OBJECT_TEMPLATE, PLUGIN, PROJECT, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for CHAT, EXECUTION, LDAP_CONFIG, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACE | Boolean() | both | |||||||||||||||
location_inheritance | Controls the project/bundle association of a newly created record when no project_id /project_name /bundle_id /bundle_name is specified in the create request. Depending on the record type different options are available:
| String(length=128) | import only | |||||||||||||||
max_runtime_minutes | The maximum runtime of executions of this connector in minutes. If set to 0, there is no limit. If set to null, the EXECUTION_MAX_RUNTIME_MINUTES workspace configuration will be used when creating an execution of this connector. | Integer() | export only | |||||||||||||||
modified_at | DateTime(timezone=True) | export only | ||||||||||||||||
modified_by | UUID(as_uuid=False) | export only | ||||||||||||||||
name | The name of this record. Must be unique across a workspace. | String(length=128) | both | |||||||||||||||
organization_id | UUID(as_uuid=False) | export only | ||||||||||||||||
output_schema | JSONEncodedData() | neither | ||||||||||||||||
pending_delete_identity_id | UUID(as_uuid=False) | neither | ||||||||||||||||
pending_restore_identity_id | UUID(as_uuid=False) | neither | ||||||||||||||||
pending_trash_identity_id | UUID(as_uuid=False) | neither | ||||||||||||||||
priority | The execution priority of the connector. Will be inherited to executions of this connector. If unset the EXECUTION_DEFAULT_PRIORITY workspace configuration will be used. Higher priority executions will be processed first. | SmallInteger() | both | |||||||||||||||
project_id | Reference to the project this record is associated with. Allowed for CHAT, CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, EXECUTION, FILE, FLOW, MESSAGE, OAUTH, OBJECT_TEMPLATE, 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) | import only | |||||||||||||||
record_type | Enum('EXECUTION', 'MESSAGE', 'PROCESS', 'CHAT', 'BUNDLE', 'BUNDLE_REPOSITORY', 'CONNECTOR', 'CUSTOM_OBJECT', 'DEVOLUTIONS_CONFIG', 'FILE', 'FLOW', 'LDAP_CONFIG', 'OAUTH', 'OBJECT_TEMPLATE', 'ORGANIZATION', 'PLUGIN', 'PROJECT', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='recordtype') | neither | ||||||||||||||||
recurse_pending_delete | Boolean() | neither | ||||||||||||||||
recurse_pending_restore | Boolean() | neither | ||||||||||||||||
recurse_pending_trash | Boolean() | 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', 'CUSTOM_OBJECT', 'DEVOLUTIONS_CONFIG', 'FILE', 'FLOW', 'LDAP_CONFIG', 'OAUTH', 'OBJECT_TEMPLATE', '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 | ||||||||||||||||
track_in_git | Should new records automatically be tracked in git. | Boolean() | both | |||||||||||||||
validation_error | The validation result of the input value against the input schema, excluding required fields. | Boolean() | export only | |||||||||||||||
value | The static configuration of the connector. Must be valid against the input schema of the connector type, except for required fields which can be omitted here, and can be set when using the connector. | JSONEncodedData() | both | |||||||||||||||
workspace_id | UUID(as_uuid=False) | export only |