Class WorkspaceSummary

Summary details of a workspace.

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

Properties

CompartmentId

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

The OCID of the compartment that contains 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>>

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

Description

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

A user defined description for the workspace.

DisplayName

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

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

EndpointId

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

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

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. Returns null if there is none.

FreeformTags

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

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

Id

Declaration
[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.

LifecycleState

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

The current state of the workspace.

RegistryId

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

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

StateMessage

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

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

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.

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