WorkspaceRequest (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class WorkspaceRequest
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes the information used to create a WorkSpace.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WorkspaceRequest()

Constructors
Constructor and Description
`WorkspaceRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkspaceRequest`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBundleId()` The identifier of the bundle for the WorkSpace.
`String`	`getDirectoryId()` The identifier of the Directory Service directory for the WorkSpace.
`Boolean`	`getRootVolumeEncryptionEnabled()` Indicates whether the data stored on the root volume is encrypted.
`List<Tag>`	`getTags()` The tags for the WorkSpace.
`String`	`getUserName()` The user name of the user for the WorkSpace.
`Boolean`	`getUserVolumeEncryptionEnabled()` Indicates whether the data stored on the user volume is encrypted.
`String`	`getVolumeEncryptionKey()` The symmetric KMS key used to encrypt data stored on your WorkSpace.
`WorkspaceProperties`	`getWorkspaceProperties()` The WorkSpace properties.
`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 for the WorkSpace.
`void`	`setDirectoryId(String directoryId)` The identifier of the Directory Service directory for the WorkSpace.
`void`	`setRootVolumeEncryptionEnabled(Boolean rootVolumeEncryptionEnabled)` Indicates whether the data stored on the root volume is encrypted.
`void`	`setTags(Collection<Tag> tags)` The tags for the WorkSpace.
`void`	`setUserName(String userName)` The user name of 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 symmetric KMS key used to encrypt data stored on your WorkSpace.
`void`	`setWorkspaceProperties(WorkspaceProperties workspaceProperties)` The WorkSpace properties.
`String`	`toString()` Returns a string representation of this object.
`WorkspaceRequest`	`withBundleId(String bundleId)` The identifier of the bundle for the WorkSpace.
`WorkspaceRequest`	`withDirectoryId(String directoryId)` The identifier of the Directory Service directory for the WorkSpace.
`WorkspaceRequest`	`withRootVolumeEncryptionEnabled(Boolean rootVolumeEncryptionEnabled)` Indicates whether the data stored on the root volume is encrypted.
`WorkspaceRequest`	`withTags(Collection<Tag> tags)` The tags for the WorkSpace.
`WorkspaceRequest`	`withTags(Tag... tags)` The tags for the WorkSpace.
`WorkspaceRequest`	`withUserName(String userName)` The user name of the user for the WorkSpace.
`WorkspaceRequest`	`withUserVolumeEncryptionEnabled(Boolean userVolumeEncryptionEnabled)` Indicates whether the data stored on the user volume is encrypted.
`WorkspaceRequest`	`withVolumeEncryptionKey(String volumeEncryptionKey)` The symmetric KMS key used to encrypt data stored on your WorkSpace.
`WorkspaceRequest`	`withWorkspaceProperties(WorkspaceProperties workspaceProperties)` The WorkSpace properties.

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

- Constructor Detail
  - WorkspaceRequest
```
public WorkspaceRequest()
```
- Method Detail
  - setDirectoryId
```
public void setDirectoryId(String directoryId)
```
    The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
    
    Parameters:
    
    directoryId - The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
  - getDirectoryId
```
public String getDirectoryId()
```
    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.
  - withDirectoryId
```
public WorkspaceRequest withDirectoryId(String directoryId)
```
    The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
    
    Parameters:
    
    directoryId - The identifier of the Directory Service directory for the WorkSpace. You can use DescribeWorkspaceDirectories to list the available directories.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserName
```
public void setUserName(String userName)
```
    The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
    
    Parameters:
    
    userName - The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
  - getUserName
```
public String getUserName()
```
    The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
    
    Returns:
    
    The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
  - withUserName
```
public WorkspaceRequest withUserName(String userName)
```
    The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
    
    Parameters:
    
    userName - The user name of the user for the WorkSpace. This user name must exist in the Directory Service directory for the WorkSpace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBundleId
```
public void setBundleId(String bundleId)
```
    The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
    
    Parameters:
    
    bundleId - The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
  - getBundleId
```
public String getBundleId()
```
    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.
  - withBundleId
```
public WorkspaceRequest withBundleId(String bundleId)
```
    The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
    
    Parameters:
    
    bundleId - The identifier of the bundle for the WorkSpace. You can use DescribeWorkspaceBundles to list the available bundles.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVolumeEncryptionKey
```
public void setVolumeEncryptionKey(String volumeEncryptionKey)
```
    The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
    
    Parameters:
    
    volumeEncryptionKey - 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 symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
    
    Returns:
    
    The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
  - withVolumeEncryptionKey
```
public WorkspaceRequest withVolumeEncryptionKey(String volumeEncryptionKey)
```
    The symmetric KMS key used to encrypt data stored on your WorkSpace. Amazon WorkSpaces does not support asymmetric KMS keys.
    
    Parameters:
    
    volumeEncryptionKey - 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 WorkspaceRequest 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 WorkspaceRequest 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.
  - setWorkspaceProperties
```
public void setWorkspaceProperties(WorkspaceProperties workspaceProperties)
```
    The WorkSpace properties.
    
    Parameters:
    
    workspaceProperties - The WorkSpace properties.
  - getWorkspaceProperties
```
public WorkspaceProperties getWorkspaceProperties()
```
    The WorkSpace properties.
    
    Returns:
    
    The WorkSpace properties.
  - withWorkspaceProperties
```
public WorkspaceRequest withWorkspaceProperties(WorkspaceProperties workspaceProperties)
```
    The WorkSpace properties.
    
    Parameters:
    
    workspaceProperties - The WorkSpace properties.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    The tags for the WorkSpace.
    
    Returns:
    
    The tags for the WorkSpace.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    The tags for the WorkSpace.
    
    Parameters:
    
    tags - The tags for the WorkSpace.
  - withTags
```
public WorkspaceRequest withTags(Tag... tags)
```
    The tags for the WorkSpace.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - The tags for the WorkSpace.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public WorkspaceRequest withTags(Collection<Tag> tags)
```
    The tags for the WorkSpace.
    
    Parameters:
    
    tags - The tags for the 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 WorkspaceRequest 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.

Did this page help you?

Class WorkspaceRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkspaceRequest

Method Detail

setDirectoryId

getDirectoryId

withDirectoryId

setUserName

getUserName

withUserName

setBundleId

getBundleId

withBundleId

setVolumeEncryptionKey

getVolumeEncryptionKey

withVolumeEncryptionKey

setUserVolumeEncryptionEnabled

getUserVolumeEncryptionEnabled

withUserVolumeEncryptionEnabled

isUserVolumeEncryptionEnabled

setRootVolumeEncryptionEnabled

getRootVolumeEncryptionEnabled

withRootVolumeEncryptionEnabled

isRootVolumeEncryptionEnabled

setWorkspaceProperties

getWorkspaceProperties

withWorkspaceProperties

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone

marshall