WorkspaceSummary

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

Bases: object

Summary details of a workspace.

Attributes

LIFECYCLE_STATE_ACTIVE A constant which can be used with the lifecycle_state property of a WorkspaceSummary.
LIFECYCLE_STATE_CREATING A constant which can be used with the lifecycle_state property of a WorkspaceSummary.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a WorkspaceSummary.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a WorkspaceSummary.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a WorkspaceSummary.
LIFECYCLE_STATE_INACTIVE A constant which can be used with the lifecycle_state property of a WorkspaceSummary.
LIFECYCLE_STATE_STARTING A constant which can be used with the lifecycle_state property of a WorkspaceSummary.
LIFECYCLE_STATE_STOPPED A constant which can be used with the lifecycle_state property of a WorkspaceSummary.
LIFECYCLE_STATE_STOPPING A constant which can be used with the lifecycle_state property of a WorkspaceSummary.
LIFECYCLE_STATE_UPDATING A constant which can be used with the lifecycle_state property of a WorkspaceSummary.
compartment_id Gets the compartment_id of this WorkspaceSummary.
defined_tags Gets the defined_tags of this WorkspaceSummary.
description Gets the description of this WorkspaceSummary.
display_name Gets the display_name of this WorkspaceSummary.
freeform_tags Gets the freeform_tags of this WorkspaceSummary.
id Gets the id of this WorkspaceSummary.
lifecycle_state Gets the lifecycle_state of this WorkspaceSummary.
state_message Gets the state_message of this WorkspaceSummary.
time_created Gets the time_created of this WorkspaceSummary.
time_updated Gets the time_updated of this WorkspaceSummary.

Methods

__init__(**kwargs) Initializes a new WorkspaceSummary object with values from keyword arguments.
LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'

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

LIFECYCLE_STATE_STARTING = 'STARTING'

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

LIFECYCLE_STATE_STOPPED = 'STOPPED'

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

LIFECYCLE_STATE_STOPPING = 'STOPPING'

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

LIFECYCLE_STATE_UPDATING = 'UPDATING'

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

__init__(**kwargs)

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

Parameters:
  • id (str) – The value to assign to the id property of this WorkspaceSummary.
  • description (str) – The value to assign to the description property of this WorkspaceSummary.
  • display_name (str) – The value to assign to the display_name property of this WorkspaceSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this WorkspaceSummary.
  • time_created (datetime) – The value to assign to the time_created property of this WorkspaceSummary.
  • time_updated (datetime) – The value to assign to the time_updated property of this WorkspaceSummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this WorkspaceSummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this WorkspaceSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this WorkspaceSummary. 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 WorkspaceSummary.
compartment_id

Gets the compartment_id of this WorkspaceSummary. The OCID of the compartment that contains the workspace.

Returns:The compartment_id of this WorkspaceSummary.
Return type:str
defined_tags

Gets the defined_tags of this WorkspaceSummary. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:The defined_tags of this WorkspaceSummary.
Return type:dict(str, dict(str, object))
description

Gets the description of this WorkspaceSummary. A user defined description for the workspace.

Returns:The description of this WorkspaceSummary.
Return type:str
display_name

Gets the display_name of this WorkspaceSummary. A user-friendly display name that is changeable. Avoid entering confidential information.

Returns:The display_name of this WorkspaceSummary.
Return type:str
freeform_tags

Gets the freeform_tags of this WorkspaceSummary. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns:The freeform_tags of this WorkspaceSummary.
Return type:dict(str, str)
id

Gets the id of this WorkspaceSummary. A system-generated and immutable identifier assigned to the workspace upon creation.

Returns:The id of this WorkspaceSummary.
Return type:str
lifecycle_state

Gets the lifecycle_state of this WorkspaceSummary. The current state of the 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’.

Returns:The lifecycle_state of this WorkspaceSummary.
Return type:str
state_message

Gets the state_message of this WorkspaceSummary. A detailed description about the current state of the workspace. Used to provide actionable information if the workspace is in a failed state.

Returns:The state_message of this WorkspaceSummary.
Return type:str
time_created

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

Returns:The time_created of this WorkspaceSummary.
Return type:datetime
time_updated

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

Returns:The time_updated of this WorkspaceSummary.
Return type:datetime