Class Workspace


  • @Generated(value="OracleSDKGenerator",
               comments="API Version: 20200430")
    public final class Workspace
    extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    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.
    Note: Objects should always be created or deserialized using the Workspace.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 Workspace.Builder, which maintain a set of all explicitly set fields called Workspace.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).

    • Method Detail

      • getVcnId

        public String getVcnId()
        The OCID of the VCN the subnet is in.
        Returns:
        the value
      • getSubnetId

        public String getSubnetId()
        The OCID of the subnet for customer connected databases.
        Returns:
        the value
      • getDnsServerIp

        public String getDnsServerIp()
        The IP of the custom DNS.
        Returns:
        the value
      • getDnsServerZone

        public String getDnsServerZone()
        The DNS zone of the custom DNS to use to resolve names.
        Returns:
        the value
      • getIsPrivateNetworkEnabled

        public Boolean getIsPrivateNetworkEnabled()
        Specifies whether the private network connection is enabled or disabled.
        Returns:
        the value
      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        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”}

        Returns:
        the value
      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. See Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

        Returns:
        the value
      • getDescription

        public String getDescription()
        A detailed description for the workspace.
        Returns:
        the value
      • getDisplayName

        public String getDisplayName()
        A user-friendly display name for the workspace.

        Does not have to be unique, and can be modified. Avoid entering confidential information.

        Returns:
        the value
      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing 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
      • getLifecycleState

        public Workspace.LifecycleState getLifecycleState()
        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.

        Returns:
        the value
      • getStateMessage

        public String getStateMessage()
        A message describing the current state in more detail.

        For example, can be used to provide actionable information for a resource in failed state.

        Returns:
        the value
      • getId

        public String getId()
        A system-generated and immutable identifier assigned to the workspace upon creation.
        Returns:
        the value
      • getEndpointId

        public String getEndpointId()
        OCID of the private endpoint associated with the container/workspace.
        Returns:
        the value
      • getEndpointName

        public String getEndpointName()
        Name of the private endpoint associated with the container/workspace.
        Returns:
        the value
      • getRegistryId

        public String getRegistryId()
        DCMS Registry ID associated with the container/workspace.
        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