WorkspaceSummary (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- - com.oracle.bmc.dataintegration.model.WorkspaceSummary

```
@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200430")
public final class WorkspaceSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
```
Summary details of a workspace.
Note: Objects should always be created or deserialized using the WorkspaceSummary.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the WorkspaceSummary.Builder, which maintain a set of all explicitly set fields called WorkspaceSummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class WorkspaceSummary.Builder

static class WorkspaceSummary.LifecycleState
The current state of the workspace.

Nested Classes
Modifier and Type	Class and Description
`static class`	`WorkspaceSummary.Builder`
`static class`	`WorkspaceSummary.LifecycleState` The current state of the workspace.

Field Summary
- Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
  EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors
Constructor and Description
`WorkspaceSummary(String id, String description, String displayName, String compartmentId, Date timeCreated, Date timeUpdated, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, WorkspaceSummary.LifecycleState lifecycleState, String stateMessage, String endpointName, String endpointId, String registryId, Map<String,String> workspaceProperties)` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static WorkspaceSummary.Builder`	`builder()` Create a new builder.
`boolean`	`equals(Object o)`
`String`	`getCompartmentId()` The OCID of the compartment that contains the workspace.
`Map<String,Map<String,Object>>`	`getDefinedTags()` Usage of predefined tag keys.
`String`	`getDescription()` A user defined description for the workspace.
`String`	`getDisplayName()` A user-friendly display name that is changeable.
`String`	`getEndpointId()` DCMS endpoint associated with the container/workspace.
`String`	`getEndpointName()` Name of the private endpoint associated with the container/workspace.
`Map<String,String>`	`getFreeformTags()` Simple key-value pair that is applied without any predefined name, type or scope.
`String`	`getId()` A system-generated and immutable identifier assigned to the workspace upon creation.
`WorkspaceSummary.LifecycleState`	`getLifecycleState()` The current state of the workspace.
`String`	`getRegistryId()` DCMS registry associated with the container/workspace.
`String`	`getStateMessage()` A detailed description about the current state of the workspace.
`Date`	`getTimeCreated()` The date and time the workspace was created, in the timestamp format defined by RFC3339.
`Date`	`getTimeUpdated()` The date and time the workspace was updated, in the timestamp format defined by RFC3339.
`Map<String,String>`	`getWorkspaceProperties()` key-value pairs of workspace properties
`int`	`hashCode()`
`WorkspaceSummary.Builder`	`toBuilder()`
`String`	`toString()`
`String`	`toString(boolean includeByteArrayContents)` Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WorkspaceSummary

@Deprecated
 @ConstructorProperties(value={"id","description","displayName","compartmentId","timeCreated","timeUpdated","freeformTags","definedTags","lifecycleState","stateMessage","endpointName","endpointId","registryId","workspaceProperties"})
public WorkspaceSummary(String id,
                                                                                                                                                                                                                                                                              String description,
                                                                                                                                                                                                                                                                              String displayName,
                                                                                                                                                                                                                                                                              String compartmentId,
                                                                                                                                                                                                                                                                              Date timeCreated,
                                                                                                                                                                                                                                                                              Date timeUpdated,
                                                                                                                                                                                                                                                                              Map<String,String> freeformTags,
                                                                                                                                                                                                                                                                              Map<String,Map<String,Object>> definedTags,
                                                                                                                                                                                                                                                                              WorkspaceSummary.LifecycleState lifecycleState,
                                                                                                                                                                                                                                                                              String stateMessage,
                                                                                                                                                                                                                                                                              String endpointName,
                                                                                                                                                                                                                                                                              String endpointId,
                                                                                                                                                                                                                                                                              String registryId,
                                                                                                                                                                                                                                                                              Map<String,String> workspaceProperties)

Deprecated.

Method Detail
- builder
```
public static WorkspaceSummary.Builder builder()
```
  Create a new builder.
- toBuilder
```
public WorkspaceSummary.Builder toBuilder()
```
- getId
```
public String getId()
```
  A system-generated and immutable identifier assigned to the workspace upon creation.
  
  Returns:
  
  the value
- getDescription
```
public String getDescription()
```
  A user defined description for the workspace.
  
  Returns:
  
  the value
- getDisplayName
```
public String getDisplayName()
```
  A user-friendly display name that is changeable. Avoid entering confidential information.
  
  Returns:
  
  the value
- getCompartmentId
```
public String getCompartmentId()
```
  The OCID of the compartment that contains the workspace.
  
  Returns:
  
  the value
- getTimeCreated
```
public Date getTimeCreated()
```
  The date and time the workspace was created, in the timestamp format defined by RFC3339.
  
  Returns:
  
  the value
- getTimeUpdated
```
public Date getTimeUpdated()
```
  The date and time the workspace was updated, in the timestamp format defined by RFC3339.
  
  Returns:
  
  the value
- getFreeformTags
```
public Map<String,String> getFreeformTags()
```
  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 value
- getDefinedTags
```
public Map<String,Map<String,Object>> getDefinedTags()
```
  Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace": {"bar-key": "value"}}
  
  Returns:
  
  the value
- getLifecycleState
```
public WorkspaceSummary.LifecycleState getLifecycleState()
```
  The current state of the workspace.
  
  Returns:
  
  the value
- getStateMessage
```
public String getStateMessage()
```
  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 value
- getEndpointName
```
public String getEndpointName()
```
  Name of the private endpoint associated with the container/workspace. Returns null if there is none.
  
  Returns:
  
  the value
- getEndpointId
```
public String getEndpointId()
```
  DCMS endpoint associated with the container/workspace. Returns null if there is none.
  
  Returns:
  
  the value
- getRegistryId
```
public String getRegistryId()
```
  DCMS registry associated with the container/workspace. Returns null if there is none.
  
  Returns:
  
  the value
- getWorkspaceProperties
```
public Map<String,String> getWorkspaceProperties()
```
  key-value pairs of workspace properties
  
  Returns:
  
  the value
- toString
```
public String toString()
```
  Overrides:
  
  toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- toString
```
public String toString(boolean includeByteArrayContents)
```
  Return a string representation of the object.
  
  Parameters:
  
  includeByteArrayContents - true to include the full contents of byte arrays
  
  Returns:
  
  string representation
- equals
```
public boolean equals(Object o)
```
  Overrides:
  
  equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Class WorkspaceSummary

Nested Class Summary

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

Methods inherited from class java.lang.Object

Constructor Detail

WorkspaceSummary

Method Detail

builder

toBuilder

getId

getDescription

getDisplayName

getCompartmentId

getTimeCreated

getTimeUpdated

getFreeformTags

getDefinedTags

getLifecycleState

getStateMessage

getEndpointName

getEndpointId

getRegistryId

getWorkspaceProperties

toString

toString

equals

hashCode