Workspace

class oci.data_integration.models.Workspace(**kwargs)

Bases: object

A workspace is an organizational construct to keep multiple data integration solutions and their resources (data assets, data flows, tasks, and so on) separate from each other, helping you to stay organized. For example, you could have separate workspaces for development, testing, and production.

Attributes:

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a Workspace.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a Workspace.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a Workspace.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a Workspace.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a Workspace.

LIFECYCLE_STATE_INACTIVE

A constant which can be used with the lifecycle_state property of a Workspace.

LIFECYCLE_STATE_STARTING

A constant which can be used with the lifecycle_state property of a Workspace.

LIFECYCLE_STATE_STOPPED

A constant which can be used with the lifecycle_state property of a Workspace.

LIFECYCLE_STATE_STOPPING

A constant which can be used with the lifecycle_state property of a Workspace.

LIFECYCLE_STATE_UPDATING

A constant which can be used with the lifecycle_state property of a Workspace.

compartment_id

Gets the compartment_id of this Workspace.

defined_tags

Gets the defined_tags of this Workspace.

description

Gets the description of this Workspace.

display_name

[Required] Gets the display_name of this Workspace.

dns_server_ip

Gets the dns_server_ip of this Workspace.

dns_server_zone

Gets the dns_server_zone of this Workspace.

endpoint_id

Gets the endpoint_id of this Workspace.

endpoint_name

Gets the endpoint_name of this Workspace.

freeform_tags

Gets the freeform_tags of this Workspace.

id

[Required] Gets the id of this Workspace.

is_private_network_enabled

Gets the is_private_network_enabled of this Workspace.

lifecycle_state

Gets the lifecycle_state of this Workspace. Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for administrative reasons DELETED - The resource has been deleted and isn't available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.

registry_id

Gets the registry_id of this Workspace.

state_message

Gets the state_message of this Workspace.

subnet_id

Gets the subnet_id of this Workspace.

time_created

Gets the time_created of this Workspace.

time_updated

Gets the time_updated of this Workspace.

vcn_id

Gets the vcn_id of this Workspace.

workspace_properties

Gets the workspace_properties of this Workspace.

Methods:

__init__(**kwargs)

Initializes a new Workspace object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Workspace. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Workspace. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Workspace. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Workspace. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Workspace. This constant has a value of “FAILED”

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

A constant which can be used with the lifecycle_state property of a Workspace. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_STARTING = 'STARTING'

A constant which can be used with the lifecycle_state property of a Workspace. This constant has a value of “STARTING”

LIFECYCLE_STATE_STOPPED = 'STOPPED'

A constant which can be used with the lifecycle_state property of a Workspace. This constant has a value of “STOPPED”

LIFECYCLE_STATE_STOPPING = 'STOPPING'

A constant which can be used with the lifecycle_state property of a Workspace. This constant has a value of “STOPPING”

LIFECYCLE_STATE_UPDATING = 'UPDATING'

A constant which can be used with the lifecycle_state property of a Workspace. This constant has a value of “UPDATING”

__init__(**kwargs)

Initializes a new Workspace object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • vcn_id (str) – The value to assign to the vcn_id property of this Workspace.

  • subnet_id (str) – The value to assign to the subnet_id property of this Workspace.

  • dns_server_ip (str) – The value to assign to the dns_server_ip property of this Workspace.

  • dns_server_zone (str) – The value to assign to the dns_server_zone property of this Workspace.

  • is_private_network_enabled (bool) – The value to assign to the is_private_network_enabled property of this Workspace.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Workspace.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Workspace.

  • description (str) – The value to assign to the description property of this Workspace.

  • display_name (str) – The value to assign to the display_name property of this Workspace.

  • compartment_id (str) – The value to assign to the compartment_id property of this Workspace.

  • time_created (datetime) – The value to assign to the time_created property of this Workspace.

  • time_updated (datetime) – The value to assign to the time_updated property of this Workspace.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Workspace. Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “STARTING”, “STOPPING”, “STOPPED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • state_message (str) – The value to assign to the state_message property of this Workspace.

  • id (str) – The value to assign to the id property of this Workspace.

  • endpoint_id (str) – The value to assign to the endpoint_id property of this Workspace.

  • endpoint_name (str) – The value to assign to the endpoint_name property of this Workspace.

  • registry_id (str) – The value to assign to the registry_id property of this Workspace.

  • workspace_properties (dict(str, str)) – The value to assign to the workspace_properties property of this Workspace.

property compartment_id

Gets the compartment_id of this Workspace. The OCID of the compartment containing the workspace.

Returns

The compartment_id of this Workspace.

Return type

str

property defined_tags

Gets the defined_tags of this Workspace. Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this Workspace.

Return type

dict(str, dict(str, object))

property description

Gets the description of this Workspace. A detailed description for the workspace.

Returns

The description of this Workspace.

Return type

str

property display_name

[Required] Gets the display_name of this Workspace. A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.

Returns

The display_name of this Workspace.

Return type

str

property dns_server_ip

Gets the dns_server_ip of this Workspace. The IP of the custom DNS.

Returns

The dns_server_ip of this Workspace.

Return type

str

property dns_server_zone

Gets the dns_server_zone of this Workspace. The DNS zone of the custom DNS to use to resolve names.

Returns

The dns_server_zone of this Workspace.

Return type

str

property endpoint_id

Gets the endpoint_id of this Workspace. OCID of the private endpoint associated with the container/workspace.

Returns

The endpoint_id of this Workspace.

Return type

str

property endpoint_name

Gets the endpoint_name of this Workspace. Name of the private endpoint associated with the container/workspace.

Returns

The endpoint_name of this Workspace.

Return type

str

property freeform_tags

Gets the freeform_tags of this Workspace. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {“Department”: “Finance”}

Returns

The freeform_tags of this Workspace.

Return type

dict(str, str)

property id

[Required] Gets the id of this Workspace. A system-generated and immutable identifier assigned to the workspace upon creation.

Returns

The id of this Workspace.

Return type

str

property is_private_network_enabled

Gets the is_private_network_enabled of this Workspace. Specifies whether the private network connection is enabled or disabled.

Returns

The is_private_network_enabled of this Workspace.

Return type

bool

property lifecycle_state

Gets the lifecycle_state of this Workspace. Lifecycle states for workspaces in Data Integration Service CREATING - The resource is being created and may not be usable until the entire metadata is defined UPDATING - The resource is being updated and may not be usable until all changes are commited DELETING - The resource is being deleted and might require deep cleanup of children. ACTIVE - The resource is valid and available for access INACTIVE - The resource might be incomplete in its definition or might have been made unavailable for

administrative reasons

DELETED - The resource has been deleted and isn’t available FAILED - The resource is in a failed state due to validation or other errors STARTING - The resource is being started and may not be usable until becomes ACTIVE again STOPPING - The resource is in the process of Stopping and may not be usable until it Stops or fails STOPPED - The resource is in Stopped state due to stop operation.

Allowed values for this property are: “CREATING”, “ACTIVE”, “INACTIVE”, “UPDATING”, “DELETING”, “DELETED”, “FAILED”, “STARTING”, “STOPPING”, “STOPPED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this Workspace.

Return type

str

property registry_id

Gets the registry_id of this Workspace. DCMS Registry ID associated with the container/workspace.

Returns

The registry_id of this Workspace.

Return type

str

property state_message

Gets the state_message of this Workspace. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.

Returns

The state_message of this Workspace.

Return type

str

property subnet_id

Gets the subnet_id of this Workspace. The OCID of the subnet for customer connected databases.

Returns

The subnet_id of this Workspace.

Return type

str

property time_created

Gets the time_created of this Workspace. The date and time the workspace was created, in the timestamp format defined by RFC3339.

Returns

The time_created of this Workspace.

Return type

datetime

property time_updated

Gets the time_updated of this Workspace. The date and time the workspace was updated, in the timestamp format defined by RFC3339.

Returns

The time_updated of this Workspace.

Return type

datetime

property vcn_id

Gets the vcn_id of this Workspace. The OCID of the VCN the subnet is in.

Returns

The vcn_id of this Workspace.

Return type

str

property workspace_properties

Gets the workspace_properties of this Workspace. key-value pairs of workspace properties

Returns

The workspace_properties of this Workspace.

Return type

dict(str, str)