Workspace (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.workspaces.model.Workspace

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Workspace
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes a WorkSpace.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Workspace()

Constructors
Constructor and Description
`Workspace()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Workspace`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBundleId()` The identifier of the bundle used to create the WorkSpace.
`String`	`getComputerName()` The name of the WorkSpace, as seen by the operating system.
`DataReplicationSettings`	`getDataReplicationSettings()` Indicates the settings of the data replication.
`String`	`getDirectoryId()` The identifier of the Directory Service directory for the WorkSpace.
`String`	`getErrorCode()` The error code that is returned if the WorkSpace cannot be created.
`String`	`getErrorMessage()` The text of the error message that is returned if the WorkSpace cannot be created.
`String`	`getIpAddress()` The IP address of the WorkSpace.
`List<ModificationState>`	`getModificationStates()` The modification states of the WorkSpace.
`List<RelatedWorkspaceProperties>`	`getRelatedWorkspaces()` The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
`Boolean`	`getRootVolumeEncryptionEnabled()` Indicates whether the data stored on the root volume is encrypted.
`List<StandbyWorkspacesProperties>`	`getStandbyWorkspacesProperties()` The properties of the standby WorkSpace
`String`	`getState()` The operational state of the WorkSpace.
`String`	`getSubnetId()` The identifier of the subnet for the WorkSpace.
`String`	`getUserName()` The user for the WorkSpace.
`Boolean`	`getUserVolumeEncryptionEnabled()` Indicates whether the data stored on the user volume is encrypted.
`String`	`getVolumeEncryptionKey()` The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace.
`String`	`getWorkspaceId()` The identifier of the WorkSpace.
`String`	`getWorkspaceName()` The name of the user-decoupled WorkSpace.
`WorkspaceProperties`	`getWorkspaceProperties()` The properties of the WorkSpace.
`int`	`hashCode()`
`Boolean`	`isRootVolumeEncryptionEnabled()` Indicates whether the data stored on the root volume is encrypted.
`Boolean`	`isUserVolumeEncryptionEnabled()` Indicates whether the data stored on the user volume is encrypted.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBundleId(String bundleId)` The identifier of the bundle used to create the WorkSpace.
`void`	`setComputerName(String computerName)` The name of the WorkSpace, as seen by the operating system.
`void`	`setDataReplicationSettings(DataReplicationSettings dataReplicationSettings)` Indicates the settings of the data replication.
`void`	`setDirectoryId(String directoryId)` The identifier of the Directory Service directory for the WorkSpace.
`void`	`setErrorCode(String errorCode)` The error code that is returned if the WorkSpace cannot be created.
`void`	`setErrorMessage(String errorMessage)` The text of the error message that is returned if the WorkSpace cannot be created.
`void`	`setIpAddress(String ipAddress)` The IP address of the WorkSpace.
`void`	`setModificationStates(Collection<ModificationState> modificationStates)` The modification states of the WorkSpace.
`void`	`setRelatedWorkspaces(Collection<RelatedWorkspaceProperties> relatedWorkspaces)` The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
`void`	`setRootVolumeEncryptionEnabled(Boolean rootVolumeEncryptionEnabled)` Indicates whether the data stored on the root volume is encrypted.
`void`	`setStandbyWorkspacesProperties(Collection<StandbyWorkspacesProperties> standbyWorkspacesProperties)` The properties of the standby WorkSpace
`void`	`setState(String state)` The operational state of the WorkSpace.
`void`	`setState(WorkspaceState state)` The operational state of the WorkSpace.
`void`	`setSubnetId(String subnetId)` The identifier of the subnet for the WorkSpace.
`void`	`setUserName(String userName)` The user for the WorkSpace.
`void`	`setUserVolumeEncryptionEnabled(Boolean userVolumeEncryptionEnabled)` Indicates whether the data stored on the user volume is encrypted.
`void`	`setVolumeEncryptionKey(String volumeEncryptionKey)` The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace.
`void`	`setWorkspaceId(String workspaceId)` The identifier of the WorkSpace.
`void`	`setWorkspaceName(String workspaceName)` The name of the user-decoupled WorkSpace.
`void`	`setWorkspaceProperties(WorkspaceProperties workspaceProperties)` The properties of the WorkSpace.
`String`	`toString()` Returns a string representation of this object.
`Workspace`	`withBundleId(String bundleId)` The identifier of the bundle used to create the WorkSpace.
`Workspace`	`withComputerName(String computerName)` The name of the WorkSpace, as seen by the operating system.
`Workspace`	`withDataReplicationSettings(DataReplicationSettings dataReplicationSettings)` Indicates the settings of the data replication.
`Workspace`	`withDirectoryId(String directoryId)` The identifier of the Directory Service directory for the WorkSpace.
`Workspace`	`withErrorCode(String errorCode)` The error code that is returned if the WorkSpace cannot be created.
`Workspace`	`withErrorMessage(String errorMessage)` The text of the error message that is returned if the WorkSpace cannot be created.
`Workspace`	`withIpAddress(String ipAddress)` The IP address of the WorkSpace.
`Workspace`	`withModificationStates(Collection<ModificationState> modificationStates)` The modification states of the WorkSpace.
`Workspace`	`withModificationStates(ModificationState... modificationStates)` The modification states of the WorkSpace.
`Workspace`	`withRelatedWorkspaces(Collection<RelatedWorkspaceProperties> relatedWorkspaces)` The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
`Workspace`	`withRelatedWorkspaces(RelatedWorkspaceProperties... relatedWorkspaces)` The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
`Workspace`	`withRootVolumeEncryptionEnabled(Boolean rootVolumeEncryptionEnabled)` Indicates whether the data stored on the root volume is encrypted.
`Workspace`	`withStandbyWorkspacesProperties(Collection<StandbyWorkspacesProperties> standbyWorkspacesProperties)` The properties of the standby WorkSpace
`Workspace`	`withStandbyWorkspacesProperties(StandbyWorkspacesProperties... standbyWorkspacesProperties)` The properties of the standby WorkSpace
`Workspace`	`withState(String state)` The operational state of the WorkSpace.
`Workspace`	`withState(WorkspaceState state)` The operational state of the WorkSpace.
`Workspace`	`withSubnetId(String subnetId)` The identifier of the subnet for the WorkSpace.
`Workspace`	`withUserName(String userName)` The user for the WorkSpace.
`Workspace`	`withUserVolumeEncryptionEnabled(Boolean userVolumeEncryptionEnabled)` Indicates whether the data stored on the user volume is encrypted.
`Workspace`	`withVolumeEncryptionKey(String volumeEncryptionKey)` The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace.
`Workspace`	`withWorkspaceId(String workspaceId)` The identifier of the WorkSpace.
`Workspace`	`withWorkspaceName(String workspaceName)` The name of the user-decoupled WorkSpace.
`Workspace`	`withWorkspaceProperties(WorkspaceProperties workspaceProperties)` The properties of the WorkSpace.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Workspace
```
public Workspace()
```
- Method Detail
  - setWorkspaceId
```
public void setWorkspaceId(String workspaceId)
```
    The identifier of the WorkSpace.
    
    Parameters:
    
    workspaceId - The identifier of the WorkSpace.
  - getWorkspaceId
```
public String getWorkspaceId()
```
    The identifier of the WorkSpace.
    
    Returns:
    
    The identifier of the WorkSpace.
  - withWorkspaceId
```
public Workspace withWorkspaceId(String workspaceId)
```
    The identifier of the WorkSpace.
    
    Parameters:
    
    workspaceId - The identifier of the WorkSpace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDirectoryId
```
public void setDirectoryId(String directoryId)
```
    The identifier of the Directory Service directory for the WorkSpace.
    
    Parameters:
    
    directoryId - The identifier of the Directory Service directory for the WorkSpace.
  - getDirectoryId
```
public String getDirectoryId()
```
    The identifier of the Directory Service directory for the WorkSpace.
    
    Returns:
    
    The identifier of the Directory Service directory for the WorkSpace.
  - withDirectoryId
```
public Workspace withDirectoryId(String directoryId)
```
    The identifier of the Directory Service directory for the WorkSpace.
    
    Parameters:
    
    directoryId - The identifier of the Directory Service directory for the WorkSpace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserName
```
public void setUserName(String userName)
```
    The user for the WorkSpace.
    
    Parameters:
    
    userName - The user for the WorkSpace.
  - getUserName
```
public String getUserName()
```
    The user for the WorkSpace.
    
    Returns:
    
    The user for the WorkSpace.
  - withUserName
```
public Workspace withUserName(String userName)
```
    The user for the WorkSpace.
    
    Parameters:
    
    userName - The user for the WorkSpace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIpAddress
```
public void setIpAddress(String ipAddress)
```
    The IP address of the WorkSpace.
    
    Parameters:
    
    ipAddress - The IP address of the WorkSpace.
  - getIpAddress
```
public String getIpAddress()
```
    The IP address of the WorkSpace.
    
    Returns:
    
    The IP address of the WorkSpace.
  - withIpAddress
```
public Workspace withIpAddress(String ipAddress)
```
    The IP address of the WorkSpace.
    
    Parameters:
    
    ipAddress - The IP address of the WorkSpace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String 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.
    Parameters:
    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.
    See Also:
    
    WorkspaceState
  - getState
```
public String getState()
```
    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.
    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
  - withState
```
public Workspace withState(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkspaceState
  - setState
```
public void setState(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.
    Parameters:
    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.
    See Also:
    
    WorkspaceState
  - withState
```
public Workspace withState(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkspaceState
  - setBundleId
```
public void setBundleId(String bundleId)
```
    The identifier of the bundle used to create the WorkSpace.
    
    Parameters:
    
    bundleId - The identifier of the bundle used to create the WorkSpace.
  - getBundleId
```
public String getBundleId()
```
    The identifier of the bundle used to create the WorkSpace.
    
    Returns:
    
    The identifier of the bundle used to create the WorkSpace.
  - withBundleId
```
public Workspace withBundleId(String bundleId)
```
    The identifier of the bundle used to create the WorkSpace.
    
    Parameters:
    
    bundleId - The identifier of the bundle used to create the WorkSpace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSubnetId
```
public void setSubnetId(String subnetId)
```
    The identifier of the subnet for the WorkSpace.
    
    Parameters:
    
    subnetId - The identifier of the subnet for the WorkSpace.
  - getSubnetId
```
public String getSubnetId()
```
    The identifier of the subnet for the WorkSpace.
    
    Returns:
    
    The identifier of the subnet for the WorkSpace.
  - withSubnetId
```
public Workspace withSubnetId(String subnetId)
```
    The identifier of the subnet for the WorkSpace.
    
    Parameters:
    
    subnetId - The identifier of the subnet for the WorkSpace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
    The text of the error message that is returned if the WorkSpace cannot be created.
    
    Parameters:
    
    errorMessage - The text of the error message that is returned if the WorkSpace cannot be created.
  - getErrorMessage
```
public String getErrorMessage()
```
    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.
  - withErrorMessage
```
public Workspace withErrorMessage(String errorMessage)
```
    The text of the error message that is returned if the WorkSpace cannot be created.
    
    Parameters:
    
    errorMessage - The text of the error message that is returned if the WorkSpace cannot be created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setErrorCode
```
public void setErrorCode(String errorCode)
```
    The error code that is returned if the WorkSpace cannot be created.
    
    Parameters:
    
    errorCode - The error code that is returned if the WorkSpace cannot be created.
  - getErrorCode
```
public String getErrorCode()
```
    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.
  - withErrorCode
```
public Workspace withErrorCode(String errorCode)
```
    The error code that is returned if the WorkSpace cannot be created.
    
    Parameters:
    
    errorCode - The error code that is returned if the WorkSpace cannot be created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setComputerName
```
public void setComputerName(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.
    
    Parameters:
    
    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.
  - getComputerName
```
public String getComputerName()
```
    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.
  - withComputerName
```
public Workspace withComputerName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeEncryptionKey
```
public void setVolumeEncryptionKey(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.
    
    Parameters:
    
    volumeEncryptionKey - The ARN of the symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
  - getVolumeEncryptionKey
```
public String getVolumeEncryptionKey()
```
    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.
  - withVolumeEncryptionKey
```
public Workspace withVolumeEncryptionKey(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserVolumeEncryptionEnabled
```
public void setUserVolumeEncryptionEnabled(Boolean userVolumeEncryptionEnabled)
```
    Indicates whether the data stored on the user volume is encrypted.
    
    Parameters:
    
    userVolumeEncryptionEnabled - Indicates whether the data stored on the user volume is encrypted.
  - getUserVolumeEncryptionEnabled
```
public Boolean getUserVolumeEncryptionEnabled()
```
    Indicates whether the data stored on the user volume is encrypted.
    
    Returns:
    
    Indicates whether the data stored on the user volume is encrypted.
  - withUserVolumeEncryptionEnabled
```
public Workspace withUserVolumeEncryptionEnabled(Boolean userVolumeEncryptionEnabled)
```
    Indicates whether the data stored on the user volume is encrypted.
    
    Parameters:
    
    userVolumeEncryptionEnabled - Indicates whether the data stored on the user volume is encrypted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isUserVolumeEncryptionEnabled
```
public Boolean isUserVolumeEncryptionEnabled()
```
    Indicates whether the data stored on the user volume is encrypted.
    
    Returns:
    
    Indicates whether the data stored on the user volume is encrypted.
  - setRootVolumeEncryptionEnabled
```
public void setRootVolumeEncryptionEnabled(Boolean rootVolumeEncryptionEnabled)
```
    Indicates whether the data stored on the root volume is encrypted.
    
    Parameters:
    
    rootVolumeEncryptionEnabled - Indicates whether the data stored on the root volume is encrypted.
  - getRootVolumeEncryptionEnabled
```
public Boolean getRootVolumeEncryptionEnabled()
```
    Indicates whether the data stored on the root volume is encrypted.
    
    Returns:
    
    Indicates whether the data stored on the root volume is encrypted.
  - withRootVolumeEncryptionEnabled
```
public Workspace withRootVolumeEncryptionEnabled(Boolean rootVolumeEncryptionEnabled)
```
    Indicates whether the data stored on the root volume is encrypted.
    
    Parameters:
    
    rootVolumeEncryptionEnabled - Indicates whether the data stored on the root volume is encrypted.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRootVolumeEncryptionEnabled
```
public Boolean isRootVolumeEncryptionEnabled()
```
    Indicates whether the data stored on the root volume is encrypted.
    
    Returns:
    
    Indicates whether the data stored on the root volume is encrypted.
  - setWorkspaceName
```
public void setWorkspaceName(String workspaceName)
```
    The name of the user-decoupled WorkSpace.
    
    Parameters:
    
    workspaceName - The name of the user-decoupled WorkSpace.
  - getWorkspaceName
```
public String getWorkspaceName()
```
    The name of the user-decoupled WorkSpace.
    
    Returns:
    
    The name of the user-decoupled WorkSpace.
  - withWorkspaceName
```
public Workspace withWorkspaceName(String workspaceName)
```
    The name of the user-decoupled WorkSpace.
    
    Parameters:
    
    workspaceName - The name of the user-decoupled WorkSpace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setWorkspaceProperties
```
public void setWorkspaceProperties(WorkspaceProperties workspaceProperties)
```
    The properties of the WorkSpace.
    
    Parameters:
    
    workspaceProperties - The properties of the WorkSpace.
  - getWorkspaceProperties
```
public WorkspaceProperties getWorkspaceProperties()
```
    The properties of the WorkSpace.
    
    Returns:
    
    The properties of the WorkSpace.
  - withWorkspaceProperties
```
public Workspace withWorkspaceProperties(WorkspaceProperties workspaceProperties)
```
    The properties of the WorkSpace.
    
    Parameters:
    
    workspaceProperties - The properties of the WorkSpace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getModificationStates
```
public List<ModificationState> getModificationStates()
```
    The modification states of the WorkSpace.
    
    Returns:
    
    The modification states of the WorkSpace.
  - setModificationStates
```
public void setModificationStates(Collection<ModificationState> modificationStates)
```
    The modification states of the WorkSpace.
    
    Parameters:
    
    modificationStates - The modification states of the WorkSpace.
  - withModificationStates
```
public Workspace withModificationStates(ModificationState... modificationStates)
```
    The modification states of the WorkSpace.
    
    NOTE: This method appends the values to the existing list (if any). Use setModificationStates(java.util.Collection) or withModificationStates(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    modificationStates - The modification states of the WorkSpace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withModificationStates
```
public Workspace withModificationStates(Collection<ModificationState> modificationStates)
```
    The modification states of the WorkSpace.
    
    Parameters:
    
    modificationStates - The modification states of the WorkSpace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRelatedWorkspaces
```
public List<RelatedWorkspaceProperties> getRelatedWorkspaces()
```
    The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
    
    Returns:
    
    The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
  - setRelatedWorkspaces
```
public void setRelatedWorkspaces(Collection<RelatedWorkspaceProperties> relatedWorkspaces)
```
    The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
    
    Parameters:
    
    relatedWorkspaces - The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
  - withRelatedWorkspaces
```
public Workspace withRelatedWorkspaces(RelatedWorkspaceProperties... relatedWorkspaces)
```
    The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
    
    NOTE: This method appends the values to the existing list (if any). Use setRelatedWorkspaces(java.util.Collection) or withRelatedWorkspaces(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    relatedWorkspaces - The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRelatedWorkspaces
```
public Workspace withRelatedWorkspaces(Collection<RelatedWorkspaceProperties> relatedWorkspaces)
```
    The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
    
    Parameters:
    
    relatedWorkspaces - The standby WorkSpace or primary WorkSpace related to the specified WorkSpace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDataReplicationSettings
```
public void setDataReplicationSettings(DataReplicationSettings dataReplicationSettings)
```
    Indicates the settings of the data replication.
    
    Parameters:
    
    dataReplicationSettings - Indicates the settings of the data replication.
  - getDataReplicationSettings
```
public DataReplicationSettings getDataReplicationSettings()
```
    Indicates the settings of the data replication.
    
    Returns:
    
    Indicates the settings of the data replication.
  - withDataReplicationSettings
```
public Workspace withDataReplicationSettings(DataReplicationSettings dataReplicationSettings)
```
    Indicates the settings of the data replication.
    
    Parameters:
    
    dataReplicationSettings - Indicates the settings of the data replication.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getStandbyWorkspacesProperties
```
public List<StandbyWorkspacesProperties> getStandbyWorkspacesProperties()
```
    The properties of the standby WorkSpace
    
    Returns:
    
    The properties of the standby WorkSpace
  - setStandbyWorkspacesProperties
```
public void setStandbyWorkspacesProperties(Collection<StandbyWorkspacesProperties> standbyWorkspacesProperties)
```
    The properties of the standby WorkSpace
    
    Parameters:
    
    standbyWorkspacesProperties - The properties of the standby WorkSpace
  - withStandbyWorkspacesProperties
```
public Workspace withStandbyWorkspacesProperties(StandbyWorkspacesProperties... standbyWorkspacesProperties)
```
    The properties of the standby WorkSpace
    
    NOTE: This method appends the values to the existing list (if any). Use setStandbyWorkspacesProperties(java.util.Collection) or withStandbyWorkspacesProperties(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    standbyWorkspacesProperties - The properties of the standby WorkSpace
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withStandbyWorkspacesProperties
```
public Workspace withStandbyWorkspacesProperties(Collection<StandbyWorkspacesProperties> standbyWorkspacesProperties)
```
    The properties of the standby WorkSpace
    
    Parameters:
    
    standbyWorkspacesProperties - The properties of the standby WorkSpace
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Workspace clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class Workspace

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Workspace

Method Detail

setWorkspaceId

getWorkspaceId

withWorkspaceId

setDirectoryId

getDirectoryId

withDirectoryId

setUserName

getUserName

withUserName

setIpAddress

getIpAddress

withIpAddress

setState

getState

withState

setState

withState

setBundleId

getBundleId

withBundleId

setSubnetId

getSubnetId

withSubnetId

setErrorMessage

getErrorMessage

withErrorMessage

setErrorCode

getErrorCode

withErrorCode

setComputerName

getComputerName

withComputerName

setVolumeEncryptionKey

getVolumeEncryptionKey

withVolumeEncryptionKey

setUserVolumeEncryptionEnabled

getUserVolumeEncryptionEnabled

withUserVolumeEncryptionEnabled

isUserVolumeEncryptionEnabled

setRootVolumeEncryptionEnabled

getRootVolumeEncryptionEnabled

withRootVolumeEncryptionEnabled

isRootVolumeEncryptionEnabled

setWorkspaceName

getWorkspaceName

withWorkspaceName

setWorkspaceProperties

getWorkspaceProperties

withWorkspaceProperties

getModificationStates

setModificationStates

withModificationStates

withModificationStates

getRelatedWorkspaces

setRelatedWorkspaces

withRelatedWorkspaces

withRelatedWorkspaces

setDataReplicationSettings

getDataReplicationSettings

withDataReplicationSettings

getStandbyWorkspacesProperties

setStandbyWorkspacesProperties

withStandbyWorkspacesProperties

withStandbyWorkspacesProperties

toString

equals

hashCode

clone

marshall