Workspace (AWS SDK for Java

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

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

@Generated(value="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 and Description

static interface Workspace.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Workspace.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.
`String`	`directoryId()` The identifier of the AWS Directory Service directory for the WorkSpace.
`boolean`	`equals(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()`
`String`	`ipAddress()` The IP address of the WorkSpace.
`List<ModificationState>`	`modificationStates()` The modification states of the WorkSpace.
`Boolean`	`rootVolumeEncryptionEnabled()` Indicates whether the data stored on the root volume is encrypted.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Workspace.Builder>`	`serializableBuilderClass()`
`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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`
`String`	`userName()` The user for the WorkSpace.
`Boolean`	`userVolumeEncryptionEnabled()` Indicates whether the data stored on the user volume is encrypted.
`String`	`volumeEncryptionKey()` The KMS key used to encrypt data stored on your WorkSpace.
`String`	`workspaceId()` The identifier of the WorkSpace.
`WorkspaceProperties`	`workspaceProperties()` The properties of the WorkSpace.

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

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

- Method Detail
  - workspaceId
```
public String workspaceId()
```
    The identifier of the WorkSpace.
    
    Returns:
    
    The identifier of the WorkSpace.
  - directoryId
```
public String directoryId()
```
    The identifier of the AWS Directory Service directory for the WorkSpace.
    
    Returns:
    
    The identifier of the AWS Directory Service directory for the WorkSpace.
  - userName
```
public String userName()
```
    The user for the WorkSpace.
    
    Returns:
    
    The user for the WorkSpace.
  - ipAddress
```
public String ipAddress()
```
    The IP address of the WorkSpace.
    
    Returns:
    
    The IP address of the WorkSpace.
  - state
```
public WorkspaceState state()
```
    The operational state of the WorkSpace.
    
    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.
    
    See Also:
    
    WorkspaceState
  - stateAsString
```
public String stateAsString()
```
    The operational state of the WorkSpace.
    
    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.
    
    See Also:
    
    WorkspaceState
  - bundleId
```
public 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 String subnetId()
```
    The identifier of the subnet for the WorkSpace.
    
    Returns:
    
    The identifier of the subnet for the WorkSpace.
  - errorMessage
```
public 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 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 String computerName()
```
    The name of the WorkSpace, as seen by the operating system.
    
    Returns:
    
    The name of the WorkSpace, as seen by the operating system.
  - volumeEncryptionKey
```
public String volumeEncryptionKey()
```
    The KMS key used to encrypt data stored on your WorkSpace.
    
    Returns:
    
    The KMS key used to encrypt data stored on your WorkSpace.
  - userVolumeEncryptionEnabled
```
public 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 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 WorkspaceProperties workspaceProperties()
```
    The properties of the WorkSpace.
    
    Returns:
    
    The properties of the WorkSpace.
  - modificationStates
```
public List<ModificationState> modificationStates()
```
    The modification states of the WorkSpace.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The modification states of the WorkSpace.
  - toBuilder
```
public Workspace.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Workspace.Builder,Workspace>
    
    Returns:
    
    a builder for type T
  - builder
```
public static Workspace.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Workspace.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

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

workspaceProperties

modificationStates

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields