Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace WorkspaceSummary

Summary details of a workspace.

Properties

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment that contains the workspace.

Optional definedTags

definedTags: undefined | object

Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {@code {"foo-namespace": {"bar-key": "value"}}}

Optional description

description: undefined | string

A user defined description for the workspace.

Optional displayName

displayName: undefined | string

A user-friendly display name that is changeable. Avoid entering confidential information.

Optional endpointId

endpointId: undefined | string

DCMS endpoint associated with the container/workspace. Returns null if there is none.

Optional endpointName

endpointName: undefined | string

Name of the private endpoint associated with the container/workspace. Returns null if there is none.

Optional freeformTags

freeformTags: undefined | object

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {@code {"bar-key": "value"}}

Optional id

id: undefined | string

A system-generated and immutable identifier assigned to the workspace upon creation.

Optional lifecycleState

lifecycleState: LifecycleState

The current state of the workspace.

Optional registryId

registryId: undefined | string

DCMS registry associated with the container/workspace. Returns null if there is none.

Optional stateMessage

stateMessage: undefined | string

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

Optional timeCreated

timeCreated: Date

The date and time the workspace was created, in the timestamp format defined by RFC3339.

Optional timeUpdated

timeUpdated: Date

The date and time the workspace was updated, in the timestamp format defined by RFC3339.

Optional workspaceProperties

workspaceProperties: undefined | object

key-value pairs of workspace properties

Functions

getDeserializedJsonObj

getJsonObj