Class WorkspaceProperties
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<WorkspaceProperties.Builder,
WorkspaceProperties>
Describes a WorkSpace.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic WorkspaceProperties.Builder
builder()
final Compute
The compute type.final String
The compute type.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Protocols property.final OperatingSystemName
The name of the operating system.final String
The name of the operating system.The protocol.The protocol.final Integer
The size of the root volume.final RunningMode
The running mode.final String
The running mode.final Integer
The time after a user logs off when WorkSpaces are automatically stopped.static Class
<? extends WorkspaceProperties.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
The size of the user storage.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.If the service returns an enum value that is not available in the current SDK version,
runningMode
will returnRunningMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrunningModeAsString()
.- 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. - See Also:
-
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.If the service returns an enum value that is not available in the current SDK version,
runningMode
will returnRunningMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrunningModeAsString()
.- 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. - See Also:
-
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
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
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
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 returnCompute.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomputeTypeNameAsString()
.- Returns:
- The compute type. For more information, see Amazon WorkSpaces Bundles.
- See Also:
-
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 returnCompute.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcomputeTypeNameAsString()
.- Returns:
- The compute type. For more information, see Amazon WorkSpaces Bundles.
- See Also:
-
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 usePCOIP
orWSP
. -
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 usePCOIP
orWSP
. -
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 theisEmpty()
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
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 usePCOIP
orWSP
. -
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 usePCOIP
orWSP
. -
Unavailable for Windows 7 WorkSpaces and WorkSpaces using GPU-based bundles (Graphics, GraphicsPro, Graphics.g4dn, and GraphicsPro.g4dn).
-
-
-
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 returnOperatingSystemName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperatingSystemNameAsString()
.- Returns:
- The name of the operating system.
- See Also:
-
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 returnOperatingSystemName.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoperatingSystemNameAsString()
.- Returns:
- The name of the operating system.
- See Also:
-
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 interfaceToCopyableBuilder<WorkspaceProperties.Builder,
WorkspaceProperties> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-