java.lang.Object
- software.amazon.awssdk.services.workspaces.model.Workspace

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Workspace.Builder,Workspace>

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

Describes a WorkSpace.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Workspace.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Workspace.Builder`	`builder()`
`String`	`bundleId()`	The identifier of the bundle used to create the WorkSpace.
`String`	`computerName()`	The name of the WorkSpace, as seen by the operating system.
`DataReplicationSettings`	`dataReplicationSettings()`	Indicates the settings of the data replication.
`String`	`directoryId()`	The identifier of the Directory Service directory for the WorkSpace.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`errorCode()`	The error code that is returned if the WorkSpace cannot be created.
`String`	`errorMessage()`	The text of the error message that is returned if the WorkSpace cannot be created.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasModificationStates()`	For responses, this returns true if the service returned a value for the ModificationStates property.
`boolean`	`hasRelatedWorkspaces()`	For responses, this returns true if the service returned a value for the RelatedWorkspaces property.
`boolean`	`hasStandbyWorkspacesProperties()`	For responses, this returns true if the service returned a value for the StandbyWorkspacesProperties property.
`String`	`ipAddress()`	The IP address of the WorkSpace.
`List<ModificationState>`	`modificationStates()`	The modification states of the WorkSpace.
`List<RelatedWorkspaceProperties>`	`relatedWorkspaces()`	The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
`Boolean`	`rootVolumeEncryptionEnabled()`	Indicates whether the data stored on the root volume is encrypted.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Workspace.Builder>`	`serializableBuilderClass()`
`List<StandbyWorkspacesProperties>`	`standbyWorkspacesProperties()`	The properties of the standby WorkSpace
`WorkspaceState`	`state()`	The operational state of the WorkSpace.
`String`	`stateAsString()`	The operational state of the WorkSpace.
`String`	`subnetId()`	The identifier of the subnet for the WorkSpace.
`Workspace.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`userName()`	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`	`workspaceId()`	The identifier of the WorkSpace.
`String`	`workspaceName()`	The name of the user-decoupled WorkSpace.
`WorkspaceProperties`	`workspaceProperties()`	The properties of the WorkSpace.

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
  - workspaceId
```
public final String workspaceId()
```
    The identifier of the WorkSpace.
    
    Returns:
    
    The identifier of the WorkSpace.
  - directoryId
```
public final String directoryId()
```
    The identifier of the Directory Service directory for the WorkSpace.
    
    Returns:
    
    The identifier of the Directory Service directory for the WorkSpace.
  - userName
```
public final String userName()
```
    The user for the WorkSpace.
    
    Returns:
    
    The user for the WorkSpace.
  - ipAddress
```
public final String ipAddress()
```
    The IP address of the WorkSpace.
    
    Returns:
    
    The IP address of the WorkSpace.
  - state
```
public final WorkspaceState state()
```
    The operational state of the WorkSpace.
    
    PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).
    
    AVAILABLE – The WorkSpace is running and has passed the health checks.
    
    IMPAIRED – Refer to UNHEALTHY state.
    
    UNHEALTHY – The WorkSpace is not responding to health checks.
    
    REBOOTING – The WorkSpace is being rebooted (restarted).
    
    STARTING – The WorkSpace is starting up and health checks are being run.
    
    REBUILDING – The WorkSpace is being rebuilt.
    
    RESTORING – The WorkSpace is being restored.
    
    MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.
    
    ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.
    
    TERMINATING – The WorkSpace is being deleted.
    
    TERMINATED – The WorkSpace has been deleted.
    
    SUSPENDED – The WorkSpace has been suspended for image creation.
    
    UPDATING – The WorkSpace is undergoing an update.
    
    STOPPING – The WorkSpace is being stopped.
    
    STOPPED – The WorkSpace has been stopped.
    
    ERROR – The WorkSpace is an error state (for example, an error occurred during startup).
    
    After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
    
    If the service returns an enum value that is not available in the current SDK version, state will return WorkspaceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    Returns:
    
    The operational state of the WorkSpace.
    
    PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).
    
    AVAILABLE – The WorkSpace is running and has passed the health checks.
    
    IMPAIRED – Refer to UNHEALTHY state.
    
    UNHEALTHY – The WorkSpace is not responding to health checks.
    
    REBOOTING – The WorkSpace is being rebooted (restarted).
    
    STARTING – The WorkSpace is starting up and health checks are being run.
    
    REBUILDING – The WorkSpace is being rebuilt.
    
    RESTORING – The WorkSpace is being restored.
    
    MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.
    
    ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.
    
    TERMINATING – The WorkSpace is being deleted.
    
    TERMINATED – The WorkSpace has been deleted.
    
    SUSPENDED – The WorkSpace has been suspended for image creation.
    
    UPDATING – The WorkSpace is undergoing an update.
    
    STOPPING – The WorkSpace is being stopped.
    
    STOPPED – The WorkSpace has been stopped.
    
    ERROR – The WorkSpace is an error state (for example, an error occurred during startup).
    
    After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
    
    See Also:
    
    WorkspaceState
  - stateAsString
```
public final String stateAsString()
```
    The operational state of the WorkSpace.
    
    PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).
    
    AVAILABLE – The WorkSpace is running and has passed the health checks.
    
    IMPAIRED – Refer to UNHEALTHY state.
    
    UNHEALTHY – The WorkSpace is not responding to health checks.
    
    REBOOTING – The WorkSpace is being rebooted (restarted).
    
    STARTING – The WorkSpace is starting up and health checks are being run.
    
    REBUILDING – The WorkSpace is being rebuilt.
    
    RESTORING – The WorkSpace is being restored.
    
    MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.
    
    ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.
    
    TERMINATING – The WorkSpace is being deleted.
    
    TERMINATED – The WorkSpace has been deleted.
    
    SUSPENDED – The WorkSpace has been suspended for image creation.
    
    UPDATING – The WorkSpace is undergoing an update.
    
    STOPPING – The WorkSpace is being stopped.
    
    STOPPED – The WorkSpace has been stopped.
    
    ERROR – The WorkSpace is an error state (for example, an error occurred during startup).
    
    After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
    
    If the service returns an enum value that is not available in the current SDK version, state will return WorkspaceState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    Returns:
    
    The operational state of the WorkSpace.
    
    PENDING – The WorkSpace is in a waiting state (for example, the WorkSpace is being created).
    
    AVAILABLE – The WorkSpace is running and has passed the health checks.
    
    IMPAIRED – Refer to UNHEALTHY state.
    
    UNHEALTHY – The WorkSpace is not responding to health checks.
    
    REBOOTING – The WorkSpace is being rebooted (restarted).
    
    STARTING – The WorkSpace is starting up and health checks are being run.
    
    REBUILDING – The WorkSpace is being rebuilt.
    
    RESTORING – The WorkSpace is being restored.
    
    MAINTENANCE – The WorkSpace is undergoing scheduled maintenance by Amazon Web Services.
    
    ADMIN_MAINTENANCE – The WorkSpace is undergoing maintenance by the WorkSpaces administrator.
    
    TERMINATING – The WorkSpace is being deleted.
    
    TERMINATED – The WorkSpace has been deleted.
    
    SUSPENDED – The WorkSpace has been suspended for image creation.
    
    UPDATING – The WorkSpace is undergoing an update.
    
    STOPPING – The WorkSpace is being stopped.
    
    STOPPED – The WorkSpace has been stopped.
    
    ERROR – The WorkSpace is an error state (for example, an error occurred during startup).
    
    After a WorkSpace is terminated, the TERMINATED state is returned only briefly before the WorkSpace directory metadata is cleaned up, so this state is rarely returned. To confirm that a WorkSpace is terminated, check for the WorkSpace ID by using DescribeWorkSpaces. If the WorkSpace ID isn't returned, then the WorkSpace has been successfully terminated.
    
    See Also:
    
    WorkspaceState
  - bundleId
```
public final String bundleId()
```
    The identifier of the bundle used to create the WorkSpace.
    
    Returns:
    
    The identifier of the bundle used to create the WorkSpace.
  - subnetId
```
public final String subnetId()
```
    The identifier of the subnet for the WorkSpace.
    
    Returns:
    
    The identifier of the subnet for the WorkSpace.
  - errorMessage
```
public final String errorMessage()
```
    The text of the error message that is returned if the WorkSpace cannot be created.
    
    Returns:
    
    The text of the error message that is returned if the WorkSpace cannot be created.
  - errorCode
```
public final String errorCode()
```
    The error code that is returned if the WorkSpace cannot be created.
    
    Returns:
    
    The error code that is returned if the WorkSpace cannot be created.
  - computerName
```
public final String computerName()
```
    The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
    
    Returns:
    
    The name of the WorkSpace, as seen by the operating system. The format of this name varies. For more information, see Launch a WorkSpace.
  - 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.
  - workspaceName
```
public final String workspaceName()
```
    The name of the user-decoupled WorkSpace.
    
    Returns:
    
    The name of the user-decoupled WorkSpace.
  - workspaceProperties
```
public final WorkspaceProperties workspaceProperties()
```
    The properties of the WorkSpace.
    
    Returns:
    
    The properties of the WorkSpace.
  - hasModificationStates
```
public final boolean hasModificationStates()
```
    For responses, this returns true if the service returned a value for the ModificationStates 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.
  - modificationStates
```
public final List<ModificationState> modificationStates()
```
    The modification states of 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 hasModificationStates() method.
    
    Returns:
    
    The modification states of the WorkSpace.
  - hasRelatedWorkspaces
```
public final boolean hasRelatedWorkspaces()
```
    For responses, this returns true if the service returned a value for the RelatedWorkspaces 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.
  - relatedWorkspaces
```
public final List<RelatedWorkspaceProperties> relatedWorkspaces()
```
    The standby WorkSpace or primary WorkSpace related to the specified 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 hasRelatedWorkspaces() method.
    
    Returns:
    
    The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
  - dataReplicationSettings
```
public final DataReplicationSettings dataReplicationSettings()
```
    Indicates the settings of the data replication.
    
    Returns:
    
    Indicates the settings of the data replication.
  - hasStandbyWorkspacesProperties
```
public final boolean hasStandbyWorkspacesProperties()
```
    For responses, this returns true if the service returned a value for the StandbyWorkspacesProperties 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.
  - standbyWorkspacesProperties
```
public final List<StandbyWorkspacesProperties> standbyWorkspacesProperties()
```
    The properties of the standby 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 hasStandbyWorkspacesProperties() method.
    
    Returns:
    
    The properties of the standby WorkSpace
  - toBuilder
```
public Workspace.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Workspace.Builder,Workspace>
  - builder
```
public static Workspace.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Workspace.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class Workspace

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

workspaceId

directoryId

userName

ipAddress

state

stateAsString

bundleId

subnetId

errorMessage

errorCode

computerName

volumeEncryptionKey

userVolumeEncryptionEnabled

rootVolumeEncryptionEnabled

workspaceName

workspaceProperties

hasModificationStates

modificationStates

hasRelatedWorkspaces

relatedWorkspaces

dataReplicationSettings

hasStandbyWorkspacesProperties

standbyWorkspacesProperties

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField