Connector
class flow_api.connector.Connector
(select=None, cls=None, init=None, by='name', allow_normal=True, allow_deleted=False, analysis_data=<class 'flow_api.system.NotSet'>, bundle_id=<class 'flow_api.system.NotSet'>, bundle_name=<class 'flow_api.system.NotSet'>, commit_message=<class 'flow_api.system.NotSet'>, connector_type=<class 'flow_api.system.NotSet'>, description=<class 'flow_api.system.NotSet'>, is_readonly=<class 'flow_api.system.NotSet'>, last_analysis_at=<class 'flow_api.system.NotSet'>, name=<class 'flow_api.system.NotSet'>, project_id=<class 'flow_api.system.NotSet'>, project_name=<class 'flow_api.system.NotSet'>, value=<class 'flow_api.system.NotSet'>, debug=False
)
Base class: Resource
Connection information for a system which can be accessed for automation by Cloudomation Engine.
See the corresponding Resources class at Connector
Parameters
Name | Type | Description |
---|---|---|
allow_deleted | bool | |
allow_normal | bool | |
analysis_data | typing.Union[ flow_api.system.NotSet, dict ] | Results of the last connection analysis of this connector. |
bundle_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | Reference to the bundle this record is associated with. Allowed for BUNDLE_REPOSITORY, CONNECTOR, CUSTOM_OBJECT, DEVOLUTIONS_CONFIG, FILE, FLOW, LDAP_CONFIG, OAUTH, OBJECT_TEMPLATE, PLUGIN, ROLE, SCHEDULE, SCHEDULER, SCHEMA, SETTING, SYNC_CONFIG, TAG, VAULT_CONFIG, WEBHOOK, WRAPPER. Not allowed for BUNDLE, EXECUTION, MESSAGE, ORGANIZATION, PROCESS, PROJECT, USER, WORKSPACE. Mutually exclusive with project_id |
bundle_name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The name of the bundle. Will look up the bundle and set bundle_id. |
by | str | |
cls | typing.Union[ type, NoneType ] | |
commit_message | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The commit message for this change. |
connector_type | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The type of the connector / the type of the remote system. |
debug | bool | if set, the content of the data being written will be logged. |
description | typing.Union[ flow_api.system.NotSet, str, NoneType ] | A multiline description of what this record is and does. |
init | typing.Union[ dict, NoneType ] | |
is_readonly | typing.Union[ flow_api.system.NotSet, bool ] | 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 EXECUTION, LDAP_CONFIG, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACE |
last_analysis_at | typing.Union[ flow_api.system.NotSet, datetime.datetime, NoneType ] | Timestamp of the last connection analysis of this connector. |
name | typing.Union[ flow_api.system.NotSet, str ] | The name of this record. Must be unique across a workspace. |
project_id | typing.Union[ flow_api.system.NotSet, str, NoneType ] | Reference to the project this record is associated with. Allowed for 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. |
project_name | typing.Union[ flow_api.system.NotSet, str, NoneType ] | The name of the project. Will look up the project and set project_id. |
select | typing.Union[ str, NoneType ] | |
value | typing.Union[ flow_api.system.NotSet, dict ] | The connector information. |