Class 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.

Inheritance
object
Workspace
Inherited Members
Namespace: Oci.DataintegrationService.Models
Assembly: OCI.DotNetSDK.Dataintegration.dll
Syntax
public class Workspace

Properties

CompartmentId

Declaration
[JsonProperty(PropertyName = "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment containing the workspace.

DefinedTags

Declaration
[JsonProperty(PropertyName = "definedTags")]
public Dictionary<string, Dictionary<string, object>> DefinedTags { get; set; }
Property Value
Type Description
Dictionary<string, Dictionary<string, object>>

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

Description

Declaration
[JsonProperty(PropertyName = "description")]
public string Description { get; set; }
Property Value
Type Description
string

A detailed description for the workspace.

DisplayName

Declaration
[Required(ErrorMessage = "DisplayName is required.")]
[JsonProperty(PropertyName = "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

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

Required

DnsServerIp

Declaration
[JsonProperty(PropertyName = "dnsServerIp")]
public string DnsServerIp { get; set; }
Property Value
Type Description
string

The IP of the custom DNS.

DnsServerZone

Declaration
[JsonProperty(PropertyName = "dnsServerZone")]
public string DnsServerZone { get; set; }
Property Value
Type Description
string

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

EndpointId

Declaration
[JsonProperty(PropertyName = "endpointId")]
public string EndpointId { get; set; }
Property Value
Type Description
string

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

EndpointName

Declaration
[JsonProperty(PropertyName = "endpointName")]
public string EndpointName { get; set; }
Property Value
Type Description
string

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

FreeformTags

Declaration
[JsonProperty(PropertyName = "freeformTags")]
public Dictionary<string, string> FreeformTags { get; set; }
Property Value
Type Description
Dictionary<string, string>

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"}

Id

Declaration
[Required(ErrorMessage = "Id is required.")]
[JsonProperty(PropertyName = "id")]
public string Id { get; set; }
Property Value
Type Description
string

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

Required

IsPrivateNetworkEnabled

Declaration
[JsonProperty(PropertyName = "isPrivateNetworkEnabled")]
public bool? IsPrivateNetworkEnabled { get; set; }
Property Value
Type Description
bool?

Specifies whether the private network connection is enabled or disabled.

LifecycleState

Declaration
[JsonProperty(PropertyName = "lifecycleState")]
[JsonConverter(typeof(ResponseEnumConverter))]
public Workspace.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
Workspace.LifecycleStateEnum?

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.

RegistryId

Declaration
[JsonProperty(PropertyName = "registryId")]
public string RegistryId { get; set; }
Property Value
Type Description
string

DCMS Registry ID associated with the container/workspace.

StateMessage

Declaration
[JsonProperty(PropertyName = "stateMessage")]
public string StateMessage { get; set; }
Property Value
Type Description
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.

SubnetId

Declaration
[JsonProperty(PropertyName = "subnetId")]
public string SubnetId { get; set; }
Property Value
Type Description
string

The OCID of the subnet for customer connected databases.

TimeCreated

Declaration
[JsonProperty(PropertyName = "timeCreated")]
public DateTime? TimeCreated { get; set; }
Property Value
Type Description
DateTime?

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

TimeUpdated

Declaration
[JsonProperty(PropertyName = "timeUpdated")]
public DateTime? TimeUpdated { get; set; }
Property Value
Type Description
DateTime?

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

VcnId

Declaration
[JsonProperty(PropertyName = "vcnId")]
public string VcnId { get; set; }
Property Value
Type Description
string

The OCID of the VCN the subnet is in.

WorkspaceProperties

Declaration
[JsonProperty(PropertyName = "workspaceProperties")]
public Dictionary<string, string> WorkspaceProperties { get; set; }
Property Value
Type Description
Dictionary<string, string>

key-value pairs of workspace properties