Class WorkspaceRequest

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

Describes the information used to create a WorkSpace.

See Also:

  • Method Details

    • directoryId

      public final String directoryId()

      The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.

      Returns:
      The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.

    • userName

      public final String userName()

      The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.

      The username is not case-sensitive, but we recommend matching the case in the Directory Service directory to avoid potential incompatibilities.

      The reserved keyword, [UNDEFINED], is used when creating user-decoupled WorkSpaces.

      Returns:
      The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.

      The username is not case-sensitive, but we recommend matching the case in the Directory Service directory to avoid potential incompatibilities.

      The reserved keyword, [UNDEFINED], is used when creating user-decoupled WorkSpaces.

    • bundleId

      public final String bundleId()

      The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.

      Returns:
      The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.

    • 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 WorkSpace properties.

      Returns:
      The WorkSpace properties.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      The tags for 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 hasTags() method.

      Returns:
      The tags for the WorkSpace.

    • workspaceName

      public final String workspaceName()

      The name of the user-decoupled WorkSpace.

      WorkspaceName is required if UserName is [UNDEFINED] for user-decoupled WorkSpaces. WorkspaceName is not applicable if UserName is specified for user-assigned WorkSpaces.

      Returns:
      The name of the user-decoupled WorkSpace.

      WorkspaceName is required if UserName is [UNDEFINED] for user-decoupled WorkSpaces. WorkspaceName is not applicable if UserName is specified for user-assigned WorkSpaces.

    • ipv6Address

      public final String ipv6Address()

      The IPv6 address for the WorkSpace.

      Returns:
      The IPv6 address for the WorkSpace.

    • toBuilder

      public WorkspaceRequest.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<WorkspaceRequest.Builder,WorkspaceRequest>
      Returns:
      a builder for type T

    • builder

      public static WorkspaceRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends WorkspaceRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.