Workspace (AWS SDK For Java for OSGi 1.10.2 API)

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

All Implemented Interfaces:

Serializable, Cloneable
```
public class Workspace
extends Object
implements Serializable, Cloneable
```
Contains information about a WorkSpace.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

Workspace()

Constructors
Constructor and Description
`Workspace()`

Method Summary

Methods
Modifier and Type	Method and Description
`Workspace`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBundleId()` The identifier of the bundle that the WorkSpace was created from.
`String`	`getDirectoryId()` The identifier of the AWS Directory Service directory that the WorkSpace belongs to.
`String`	`getErrorCode()` If the WorkSpace could not be created, this contains the error code.
`String`	`getErrorMessage()` If the WorkSpace could not be created, this contains a textual error message that describes the failure.
`String`	`getIpAddress()` The IP address of the WorkSpace.
`String`	`getState()` The operational state of the WorkSpace.
`String`	`getSubnetId()` The identifier of the subnet that the WorkSpace is in.
`String`	`getUserName()` The user that the WorkSpace is assigned to.
`String`	`getWorkspaceId()` The identifier of the WorkSpace.
`int`	`hashCode()`
`void`	`setBundleId(String bundleId)` The identifier of the bundle that the WorkSpace was created from.
`void`	`setDirectoryId(String directoryId)` The identifier of the AWS Directory Service directory that the WorkSpace belongs to.
`void`	`setErrorCode(String errorCode)` If the WorkSpace could not be created, this contains the error code.
`void`	`setErrorMessage(String errorMessage)` If the WorkSpace could not be created, this contains a textual error message that describes the failure.
`void`	`setIpAddress(String ipAddress)` The IP address of the 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 that the WorkSpace is in.
`void`	`setUserName(String userName)` The user that the WorkSpace is assigned to.
`void`	`setWorkspaceId(String workspaceId)` The identifier of the WorkSpace.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Workspace`	`withBundleId(String bundleId)` The identifier of the bundle that the WorkSpace was created from.
`Workspace`	`withDirectoryId(String directoryId)` The identifier of the AWS Directory Service directory that the WorkSpace belongs to.
`Workspace`	`withErrorCode(String errorCode)` If the WorkSpace could not be created, this contains the error code.
`Workspace`	`withErrorMessage(String errorMessage)` If the WorkSpace could not be created, this contains a textual error message that describes the failure.
`Workspace`	`withIpAddress(String ipAddress)` The IP address of the 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 that the WorkSpace is in.
`Workspace`	`withUserName(String userName)` The user that the WorkSpace is assigned to.
`Workspace`	`withWorkspaceId(String workspaceId)` The identifier of the WorkSpace.

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

- Constructor Detail
  - Workspace
```
public Workspace()
```
- Method Detail
  - getWorkspaceId
```
public String getWorkspaceId()
```
    The identifier of the WorkSpace.
    Constraints:
    Pattern: ^ws-[0-9a-z]{8,63}$
    
    Returns:
    The identifier of the WorkSpace.
  - setWorkspaceId
```
public void setWorkspaceId(String workspaceId)
```
    The identifier of the WorkSpace.
    Constraints:
    Pattern: ^ws-[0-9a-z]{8,63}$
    
    Parameters:
    workspaceId - The identifier of the WorkSpace.
  - withWorkspaceId
```
public Workspace withWorkspaceId(String workspaceId)
```
    The identifier of the WorkSpace.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ^ws-[0-9a-z]{8,63}$
    
    Parameters:
    workspaceId - The identifier of the WorkSpace.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getDirectoryId
```
public String getDirectoryId()
```
    The identifier of the AWS Directory Service directory that the WorkSpace belongs to.
    Constraints:
    Pattern: ^d-[0-9a-f]{8,63}$
    
    Returns:
    The identifier of the AWS Directory Service directory that the WorkSpace belongs to.
  - setDirectoryId
```
public void setDirectoryId(String directoryId)
```
    The identifier of the AWS Directory Service directory that the WorkSpace belongs to.
    Constraints:
    Pattern: ^d-[0-9a-f]{8,63}$
    
    Parameters:
    directoryId - The identifier of the AWS Directory Service directory that the WorkSpace belongs to.
  - withDirectoryId
```
public Workspace withDirectoryId(String directoryId)
```
    The identifier of the AWS Directory Service directory that the WorkSpace belongs to.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ^d-[0-9a-f]{8,63}$
    
    Parameters:
    directoryId - The identifier of the AWS Directory Service directory that the WorkSpace belongs to.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getUserName
```
public String getUserName()
```
    The user that the WorkSpace is assigned to.
    Constraints:
    Length: 1 - 63
    
    Returns:
    The user that the WorkSpace is assigned to.
  - setUserName
```
public void setUserName(String userName)
```
    The user that the WorkSpace is assigned to.
    Constraints:
    Length: 1 - 63
    
    Parameters:
    userName - The user that the WorkSpace is assigned to.
  - withUserName
```
public Workspace withUserName(String userName)
```
    The user that the WorkSpace is assigned to.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 63
    
    Parameters:
    userName - The user that the WorkSpace is assigned to.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getIpAddress
```
public String getIpAddress()
```
    The IP address of the WorkSpace.
    
    Returns:
    The IP address of the WorkSpace.
  - setIpAddress
```
public void setIpAddress(String ipAddress)
```
    The IP address of the WorkSpace.
    
    Parameters:
    ipAddress - The IP address of the WorkSpace.
  - withIpAddress
```
public Workspace withIpAddress(String ipAddress)
```
    The IP address of the WorkSpace.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    ipAddress - The IP address of the WorkSpace.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getState
```
public String getState()
```
    The operational state of the WorkSpace.
    Constraints:
    Allowed Values: PENDING, AVAILABLE, IMPAIRED, UNHEALTHY, REBOOTING, REBUILDING, TERMINATING, TERMINATED, SUSPENDED, ERROR
    
    Returns:
    The operational state of the WorkSpace.
    See Also:
    WorkspaceState
  - setState
```
public void setState(String state)
```
    The operational state of the WorkSpace.
    Constraints:
    Allowed Values: PENDING, AVAILABLE, IMPAIRED, UNHEALTHY, REBOOTING, REBUILDING, TERMINATING, TERMINATED, SUSPENDED, ERROR
    
    Parameters:
    state - The operational state of the WorkSpace.
    See Also:
    WorkspaceState
  - withState
```
public Workspace withState(String state)
```
    The operational state of the WorkSpace.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: PENDING, AVAILABLE, IMPAIRED, UNHEALTHY, REBOOTING, REBUILDING, TERMINATING, TERMINATED, SUSPENDED, ERROR
    
    Parameters:
    state - The operational state of the WorkSpace.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    WorkspaceState
  - setState
```
public void setState(WorkspaceState state)
```
    The operational state of the WorkSpace.
    Constraints:
    Allowed Values: PENDING, AVAILABLE, IMPAIRED, UNHEALTHY, REBOOTING, REBUILDING, TERMINATING, TERMINATED, SUSPENDED, ERROR
    
    Parameters:
    state - The operational state of the WorkSpace.
    See Also:
    WorkspaceState
  - withState
```
public Workspace withState(WorkspaceState state)
```
    The operational state of the WorkSpace.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: PENDING, AVAILABLE, IMPAIRED, UNHEALTHY, REBOOTING, REBUILDING, TERMINATING, TERMINATED, SUSPENDED, ERROR
    
    Parameters:
    state - The operational state of the WorkSpace.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
    See Also:
    WorkspaceState
  - getBundleId
```
public String getBundleId()
```
    The identifier of the bundle that the WorkSpace was created from.
    Constraints:
    Pattern: ^wsb-[0-9a-z]{8,63}$
    
    Returns:
    The identifier of the bundle that the WorkSpace was created from.
  - setBundleId
```
public void setBundleId(String bundleId)
```
    The identifier of the bundle that the WorkSpace was created from.
    Constraints:
    Pattern: ^wsb-[0-9a-z]{8,63}$
    
    Parameters:
    bundleId - The identifier of the bundle that the WorkSpace was created from.
  - withBundleId
```
public Workspace withBundleId(String bundleId)
```
    The identifier of the bundle that the WorkSpace was created from.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ^wsb-[0-9a-z]{8,63}$
    
    Parameters:
    bundleId - The identifier of the bundle that the WorkSpace was created from.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSubnetId
```
public String getSubnetId()
```
    The identifier of the subnet that the WorkSpace is in.
    Constraints:
    Pattern: ^(subnet-[0-9a-f]{8})$
    
    Returns:
    The identifier of the subnet that the WorkSpace is in.
  - setSubnetId
```
public void setSubnetId(String subnetId)
```
    The identifier of the subnet that the WorkSpace is in.
    Constraints:
    Pattern: ^(subnet-[0-9a-f]{8})$
    
    Parameters:
    subnetId - The identifier of the subnet that the WorkSpace is in.
  - withSubnetId
```
public Workspace withSubnetId(String subnetId)
```
    The identifier of the subnet that the WorkSpace is in.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: ^(subnet-[0-9a-f]{8})$
    
    Parameters:
    subnetId - The identifier of the subnet that the WorkSpace is in.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getErrorMessage
```
public String getErrorMessage()
```
    If the WorkSpace could not be created, this contains a textual error message that describes the failure.
    
    Returns:
    If the WorkSpace could not be created, this contains a textual error message that describes the failure.
  - setErrorMessage
```
public void setErrorMessage(String errorMessage)
```
    If the WorkSpace could not be created, this contains a textual error message that describes the failure.
    
    Parameters:
    errorMessage - If the WorkSpace could not be created, this contains a textual error message that describes the failure.
  - withErrorMessage
```
public Workspace withErrorMessage(String errorMessage)
```
    If the WorkSpace could not be created, this contains a textual error message that describes the failure.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    errorMessage - If the WorkSpace could not be created, this contains a textual error message that describes the failure.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getErrorCode
```
public String getErrorCode()
```
    If the WorkSpace could not be created, this contains the error code.
    
    Returns:
    If the WorkSpace could not be created, this contains the error code.
  - setErrorCode
```
public void setErrorCode(String errorCode)
```
    If the WorkSpace could not be created, this contains the error code.
    
    Parameters:
    errorCode - If the WorkSpace could not be created, this contains the error code.
  - withErrorCode
```
public Workspace withErrorCode(String errorCode)
```
    If the WorkSpace could not be created, this contains the error code.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    errorCode - If the WorkSpace could not be created, this contains the error code.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    A string representation of this object.
    See Also:
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - clone
```
public Workspace clone()
```
    Overrides:
    
    clone in class Object

Class Workspace

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Workspace

Method Detail

getWorkspaceId

setWorkspaceId

withWorkspaceId

getDirectoryId

setDirectoryId

withDirectoryId

getUserName

setUserName

withUserName

getIpAddress

setIpAddress

withIpAddress

getState

setState

withState

setState

withState

getBundleId

setBundleId

withBundleId

getSubnetId

setSubnetId

withSubnetId

getErrorMessage

setErrorMessage

withErrorMessage

getErrorCode

setErrorCode

withErrorCode

toString

hashCode

equals

clone