Package software.amazon.awssdk.services.workspaces.model

Class Workspace

java.lang.Object
software.amazon.awssdk.services.workspaces.model.Workspace
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Workspace.Builder,Workspace>
@Generated("software.amazon.awssdk:codegen") public final class Workspace extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Workspace.Builder,Workspace>

Describes a WorkSpace.

See Also:

  • Method Details

    • workspaceId

      public final String workspaceId()

      The identifier of the WorkSpace.

      Returns:
      The identifier of the WorkSpace.

    • directoryId

      public final String directoryId()

      The identifier of the Directory Service directory for the WorkSpace.

      Returns:
      The identifier of the Directory Service directory for the WorkSpace.

    • userName

      public final String userName()

      The user for the WorkSpace.

      Returns:
      The user for the WorkSpace.

    • ipAddress

      public final String ipAddress()

      The IP address of the WorkSpace.

      Returns:
      The IP address of the WorkSpace.

    • state

      public final WorkspaceState state()

      The operational state of the WorkSpace.

      After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.

      If the service returns an enum value that is not available in the current SDK version, state will return WorkspaceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The operational state of the WorkSpace.

      After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.

      See Also:

    • stateAsString

      public final String stateAsString()

      The operational state of the WorkSpace.

      After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.

      If the service returns an enum value that is not available in the current SDK version, state will return WorkspaceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The operational state of the WorkSpace.

      After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.

      See Also:

    • bundleId

      public final String bundleId()

      The identifier of the bundle used to create the WorkSpace.

      Returns:
      The identifier of the bundle used to create the WorkSpace.

    • subnetId

      public final String subnetId()

      The identifier of the subnet for the WorkSpace.

      Returns:
      The identifier of the subnet for the WorkSpace.

    • errorMessage

      public final String errorMessage()

      The text of the error message that is returned if the WorkSpace cannot be created.

      Returns:
      The text of the error message that is returned if the WorkSpace cannot be created.

    • errorCode

      public final String errorCode()

      The error code that is returned if the WorkSpace cannot be created.

      Returns:
      The error code that is returned if the WorkSpace cannot be created.

    • computerName

      public final String computerName()

      The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.

      Returns:
      The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.

    • volumeEncryptionKey

      public final String volumeEncryptionKey()

      The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

      Returns:
      The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.

    • userVolumeEncryptionEnabled

      public final Boolean userVolumeEncryptionEnabled()

      Indicates whether the data stored on the user volume is encrypted.

      Returns:
      Indicates whether the data stored on the user volume is encrypted.

    • rootVolumeEncryptionEnabled

      public final Boolean rootVolumeEncryptionEnabled()

      Indicates whether the data stored on the root volume is encrypted.

      Returns:
      Indicates whether the data stored on the root volume is encrypted.

    • workspaceProperties

      public final WorkspaceProperties workspaceProperties()

      The properties of the WorkSpace.

      Returns:
      The properties of the WorkSpace.

    • hasModificationStates

      public final boolean hasModificationStates()
      For responses, this returns true if the service returned a value for the ModificationStates property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • modificationStates

      public final List<ModificationState> modificationStates()

      The modification states of the WorkSpace.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasModificationStates() method.

      Returns:
      The modification states of the WorkSpace.

    • hasRelatedWorkspaces

      public final boolean hasRelatedWorkspaces()
      For responses, this returns true if the service returned a value for the RelatedWorkspaces property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • relatedWorkspaces

      public final List<RelatedWorkspaceProperties> relatedWorkspaces()

      The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasRelatedWorkspaces() method.

      Returns:
      The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.

    • toBuilder

      public Workspace.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<Workspace.Builder,Workspace>
      Returns:
      a builder for type T

    • builder

      public static Workspace.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Workspace.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.