Workspace

class resources.workspace.Workspace

Base class: Resource

A Cloudomation Engine installation.

note

Workspace resources cannot be created or deleted.

See the corresponding Flow Api class at Workspace

Property	Description	Type	Import/Export
active	A flag to control if the workspace is active. Output only.	Boolean()	export only
branch_name	Git branch name to use.	String(length=128)	export only
bundle_id	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	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
commit_message	The commit message for this change.	Text()	import only
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	A multiline description of what this record is and does.	Text()	both
git_url	Url to this bundle's repository.	String(length=1024)	export only
has_deprecation		Boolean()	export only
has_syntax_error		Boolean()	export only
icon	An SVG/PNG icon for the workspace.	Text()	both
id		UUID(as_uuid=False)	neither
identity_type		Enum('EXECUTION', 'LDAP_CONFIG', 'SCHEDULE', 'SYNC_CONFIG', 'USER', 'WEBHOOK', 'WORKSPACE', name='identitytype')	neither
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 EXECUTION, LDAP_CONFIG, MESSAGE, ORGANIZATION, PROCESS, USER, WORKSPACE	Boolean()	both
last_activity	The last time the identity was active in Cloudomation. Output only.	DateTime(timezone=True)	neither
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: location_inheritance	record types	description -
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
primary_process_id		UUID(as_uuid=False)	neither
project_id	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.	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', 'CUSTOM_OBJECT', 'DEVOLUTIONS_CONFIG', 'EXECUTION', 'FILE', 'FLOW', 'LDAP_CONFIG', 'MESSAGE', 'OAUTH', 'OBJECT_TEMPLATE', 'ORGANIZATION', 'PLUGIN', 'PROCESS', 'PROJECT', 'ROLE', 'SCHEDULE', 'SCHEDULER', 'SCHEMA', 'SETTING', 'SYNC_CONFIG', 'TAG', 'USER', 'VAULT_CONFIG', 'WEBHOOK', 'WORKSPACE', 'WRAPPER', name='recordtype')	neither
repository_name	The repository name of this workspace.	String(length=128)	both
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
roles	The roles this identity has.	JSONB(astext_type=Text())	import only
schema_version		String(length=128)	both
size_bytes_workspace		BigInteger()	neither
smtp_oauth2_access_token		String(length=512)	neither
smtp_oauth2_refresh_token		String(length=512)	neither
sync_counter_cde_minutes		Integer()	neither
sync_counter_connection_dev		Integer()	neither
sync_counter_connection_productive		Integer()	neither
sync_counter_flow_dev		Integer()	neither
sync_counter_flow_productive		Integer()	neither
usage_count_cde_minutes	The number of minutes of CDE usage this month.	Integer()	export only
usage_count_connection_dev	A counter of the number of executions of type CONNECTION which were started in development mode this month. Output only.	Integer()	export only
usage_count_connection_productive	A counter of the number of executions of type CONNECTION which were started in productive mode this month. Output only.	Integer()	export only
usage_count_flow_dev	A counter of the number of executions of flows which were started in development mode this month. Output only.	Integer()	export only
usage_count_flow_productive	A counter of the number of executions of flows which were started in productive mode this month. Output only.	Integer()	export only
usage_sync_id		UUID(as_uuid=False)	neither
workspace_id		UUID(as_uuid=False)	export only