Class WorkspaceProperties

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

Describes a WorkSpace.

See Also:

  • Method Details

    • runningMode

      public final RunningMode runningMode()

      The running mode. For more information, see Manage the WorkSpace Running Mode.

      The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

      Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

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

      Returns:
      The running mode. For more information, see Manage the WorkSpace Running Mode.

      The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

      Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

      See Also:

    • runningModeAsString

      public final String runningModeAsString()

      The running mode. For more information, see Manage the WorkSpace Running Mode.

      The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

      Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

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

      Returns:
      The running mode. For more information, see Manage the WorkSpace Running Mode.

      The MANUAL value is only supported by Amazon WorkSpaces Core. Contact your account team to be allow-listed to use this value. For more information, see Amazon WorkSpaces Core.

      Review your running mode to ensure you are using one that is optimal for your needs and budget. For more information on switching running modes, see Can I switch between hourly and monthly billing?

      See Also:

    • runningModeAutoStopTimeoutInMinutes

      public final Integer runningModeAutoStopTimeoutInMinutes()

      The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

      Returns:
      The time after a user logs off when WorkSpaces are automatically stopped. Configured in 60-minute intervals.

    • rootVolumeSizeGib

      public final Integer rootVolumeSizeGib()

      The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

      Returns:
      The size of the root volume. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

    • userVolumeSizeGib

      public final Integer userVolumeSizeGib()

      The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

      Returns:
      The size of the user storage. For important information about how to modify the size of the root and user volumes, see Modify a WorkSpace.

    • computeTypeName

      public final Compute computeTypeName()

      The compute type. For more information, see Amazon WorkSpaces Bundles.

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

      Returns:
      The compute type. For more information, see Amazon WorkSpaces Bundles.
      See Also:

    • computeTypeNameAsString

      public final String computeTypeNameAsString()

      The compute type. For more information, see Amazon WorkSpaces Bundles.

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

      Returns:
      The compute type. For more information, see Amazon WorkSpaces Bundles.
      See Also:

    • protocols

      public final List<Protocol> protocols()

      The protocol. For more information, see Protocols for Amazon WorkSpaces.

      • Only available for WorkSpaces created with PCoIP bundles.

      • The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP).

      • Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

      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 hasProtocols() method.

      Returns:
      The protocol. For more information, see Protocols for Amazon WorkSpaces.

      • Only available for WorkSpaces created with PCoIP bundles.

      • The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP).

      • Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

    • hasProtocols

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

    • protocolsAsStrings

      public final List<String> protocolsAsStrings()

      The protocol. For more information, see Protocols for Amazon WorkSpaces.

      • Only available for WorkSpaces created with PCoIP bundles.

      • The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP).

      • Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

      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 hasProtocols() method.

      Returns:
      The protocol. For more information, see Protocols for Amazon WorkSpaces.

      • Only available for WorkSpaces created with PCoIP bundles.

      • The Protocols property is case sensitive. Ensure you use PCOIP or DCV (formerly WSP).

      • Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).

    • operatingSystemName

      public final OperatingSystemName operatingSystemName()

      The name of the operating system.

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

      Returns:
      The name of the operating system.
      See Also:

    • operatingSystemNameAsString

      public final String operatingSystemNameAsString()

      The name of the operating system.

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

      Returns:
      The name of the operating system.
      See Also:

    • toBuilder

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

    • builder

      public static WorkspaceProperties.Builder builder()

    • serializableBuilderClass

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