Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace Workspace

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.

Properties

Optional compartmentId

compartmentId: undefined | string

The OCID of the compartment containing the workspace.

Optional definedTags

definedTags: undefined | object

Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {@code {"Operations": {"CostCenter": "42"}}}

Optional description

description: undefined | string

A detailed description for the workspace.

displayName

displayName: string

A user-friendly display name for the workspace. Does not have to be unique, and can be modified. Avoid entering confidential information.

Optional dnsServerIp

dnsServerIp: undefined | string

The IP of the custom DNS.

Optional dnsServerZone

dnsServerZone: undefined | string

The DNS zone of the custom DNS to use to resolve names.

Optional endpointId

endpointId: undefined | string

OCID of the private endpoint associated with the container/workspace.

Optional endpointName

endpointName: undefined | string

Name of the private endpoint associated with the container/workspace.

Optional freeformTags

freeformTags: undefined | object

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: {@code {"Department": "Finance"}}

id

id: string

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

Optional isPrivateNetworkEnabled

isPrivateNetworkEnabled: undefined | false | true

Specifies whether the private network connection is enabled or disabled.

Optional lifecycleState

lifecycleState: LifecycleState

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.

Optional registryId

registryId: undefined | string

DCMS Registry ID associated with the container/workspace.

Optional stateMessage

stateMessage: undefined | string

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

Optional subnetId

subnetId: undefined | string

The OCID of the subnet for customer connected databases.

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 vcnId

vcnId: undefined | string

The OCID of the VCN the subnet is in.

Optional workspaceProperties

workspaceProperties: undefined | object

key-value pairs of workspace properties

Functions

getDeserializedJsonObj

  • getDeserializedJsonObj(obj: Workspace): object

getJsonObj