software.amazon.awssdk.services.workspaces.model

Class WorkspaceProperties

java.lang.Object

software.amazon.awssdk.services.workspaces.model.WorkspaceProperties

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<WorkspaceProperties.Builder,WorkspaceProperties>

@Generated(value="software.amazon.awssdk:codegen")
public final class WorkspaceProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkspaceProperties.Builder,WorkspaceProperties>

Describes a WorkSpace.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	WorkspaceProperties.Builder

Method Summary

Modifier and Type	Method and Description
static WorkspaceProperties.Builder	builder()
Compute	computeTypeName() The compute type.
String	computeTypeNameAsString() The compute type.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasProtocols() For responses, this returns true if the service returned a value for the Protocols property.
List<Protocol>	protocols() The protocol.
List<String>	protocolsAsStrings() The protocol.
Integer	rootVolumeSizeGib() The size of the root volume.
RunningMode	runningMode() The running mode.
String	runningModeAsString() The running mode.
Integer	runningModeAutoStopTimeoutInMinutes() The time after a user logs off when WorkSpaces are automatically stopped.
List<SdkField<?>>	sdkFields()
static Class<? extends WorkspaceProperties.Builder>	serializableBuilderClass()
WorkspaceProperties.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Integer	userVolumeSizeGib() The size of the user storage.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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.

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.

See Also:

RunningMode

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.

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.

See Also:

RunningMode

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:

Compute

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:

Compute

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 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 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 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 WSP.

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

toBuilder

public WorkspaceProperties.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WorkspaceProperties.Builder,WorkspaceProperties>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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