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

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	WorkspaceRequest.Builder

Method Summary

Modifier and Type	Method	Description
static WorkspaceRequest.Builder	builder()
String	bundleId()	The identifier of the bundle for the WorkSpace.
String	directoryId()	The identifier of the Directory Service directory for the WorkSpace.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Boolean	rootVolumeEncryptionEnabled()	Indicates whether the data stored on the root volume is encrypted.
List<SdkField<?>>	sdkFields()
static Class<? extends WorkspaceRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	The tags for the WorkSpace.
WorkspaceRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userName()	The user name of the user for the WorkSpace.
Boolean	userVolumeEncryptionEnabled()	Indicates whether the data stored on the user volume is encrypted.
String	volumeEncryptionKey()	The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace.
String	workspaceName()	The name of the user-decoupled WorkSpace.
WorkspaceProperties	workspaceProperties()	The WorkSpace properties.

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

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

Returns:

The name of the user-decoupled WorkSpace.

toBuilder

public WorkspaceRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<WorkspaceRequest.Builder,WorkspaceRequest>

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)

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