WorkspaceImage (AWS SDK for Java

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

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Describes a WorkSpace image.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

WorkspaceImage()

Constructors
Constructor and Description
`WorkspaceImage()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkspaceImage`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreated()` The date when the image was created.
`String`	`getDescription()` The description of the image.
`String`	`getErrorCode()` The error code that is returned for the image.
`String`	`getErrorMessage()` The text of the error message that is returned for the image.
`String`	`getImageId()` The identifier of the image.
`String`	`getName()` The name of the image.
`OperatingSystem`	`getOperatingSystem()` The operating system that the image is running.
`String`	`getOwnerAccountId()` The identifier of the AWS account that owns the image.
`String`	`getRequiredTenancy()` Specifies whether the image is running on dedicated hardware.
`String`	`getState()` The status of the image.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreated(Date created)` The date when the image was created.
`void`	`setDescription(String description)` The description of the image.
`void`	`setErrorCode(String errorCode)` The error code that is returned for the image.
`void`	`setErrorMessage(String errorMessage)` The text of the error message that is returned for the image.
`void`	`setImageId(String imageId)` The identifier of the image.
`void`	`setName(String name)` The name of the image.
`void`	`setOperatingSystem(OperatingSystem operatingSystem)` The operating system that the image is running.
`void`	`setOwnerAccountId(String ownerAccountId)` The identifier of the AWS account that owns the image.
`void`	`setRequiredTenancy(String requiredTenancy)` Specifies whether the image is running on dedicated hardware.
`void`	`setState(String state)` The status of the image.
`String`	`toString()` Returns a string representation of this object.
`WorkspaceImage`	`withCreated(Date created)` The date when the image was created.
`WorkspaceImage`	`withDescription(String description)` The description of the image.
`WorkspaceImage`	`withErrorCode(String errorCode)` The error code that is returned for the image.
`WorkspaceImage`	`withErrorMessage(String errorMessage)` The text of the error message that is returned for the image.
`WorkspaceImage`	`withImageId(String imageId)` The identifier of the image.
`WorkspaceImage`	`withName(String name)` The name of the image.
`WorkspaceImage`	`withOperatingSystem(OperatingSystem operatingSystem)` The operating system that the image is running.
`WorkspaceImage`	`withOwnerAccountId(String ownerAccountId)` The identifier of the AWS account that owns the image.
`WorkspaceImage`	`withRequiredTenancy(String requiredTenancy)` Specifies whether the image is running on dedicated hardware.
`WorkspaceImage`	`withRequiredTenancy(WorkspaceImageRequiredTenancy requiredTenancy)` Specifies whether the image is running on dedicated hardware.
`WorkspaceImage`	`withState(String state)` The status of the image.
`WorkspaceImage`	`withState(WorkspaceImageState state)` The status of the image.

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

- Constructor Detail
  - WorkspaceImage
```
public WorkspaceImage()
```
- Method Detail
  - setImageId
```
public void setImageId(String imageId)
```
    The identifier of the image.
    
    Parameters:
    
    imageId - The identifier of the image.
  - getImageId
```
public String getImageId()
```
    The identifier of the image.
    
    Returns:
    
    The identifier of the image.
  - withImageId
```
public WorkspaceImage withImageId(String imageId)
```
    The identifier of the image.
    
    Parameters:
    
    imageId - The identifier of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the image.
    
    Parameters:
    
    name - The name of the image.
  - getName
```
public String getName()
```
    The name of the image.
    
    Returns:
    
    The name of the image.
  - withName
```
public WorkspaceImage withName(String name)
```
    The name of the image.
    
    Parameters:
    
    name - The name of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the image.
    
    Parameters:
    
    description - The description of the image.
  - getDescription
```
public String getDescription()
```
    The description of the image.
    
    Returns:
    
    The description of the image.
  - withDescription
```
public WorkspaceImage withDescription(String description)
```
    The description of the image.
    
    Parameters:
    
    description - The description of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOperatingSystem
```
public void setOperatingSystem(OperatingSystem operatingSystem)
```
    The operating system that the image is running.
    
    Parameters:
    
    operatingSystem - The operating system that the image is running.
  - getOperatingSystem
```
public OperatingSystem getOperatingSystem()
```
    The operating system that the image is running.
    
    Returns:
    
    The operating system that the image is running.
  - withOperatingSystem
```
public WorkspaceImage withOperatingSystem(OperatingSystem operatingSystem)
```
    The operating system that the image is running.
    
    Parameters:
    
    operatingSystem - The operating system that the image is running.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The status of the image.
    
    Parameters:
    
    state - The status of the image.
    
    See Also:
    
    WorkspaceImageState
  - getState
```
public String getState()
```
    The status of the image.
    
    Returns:
    
    The status of the image.
    
    See Also:
    
    WorkspaceImageState
  - withState
```
public WorkspaceImage withState(String state)
```
    The status of the image.
    
    Parameters:
    
    state - The status of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkspaceImageState
  - withState
```
public WorkspaceImage withState(WorkspaceImageState state)
```
    The status of the image.
    
    Parameters:
    
    state - The status of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkspaceImageState
  - setRequiredTenancy
```
public void setRequiredTenancy(String requiredTenancy)
```
    Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
    
    Parameters:
    
    requiredTenancy - Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
    
    See Also:
    
    WorkspaceImageRequiredTenancy
  - getRequiredTenancy
```
public String getRequiredTenancy()
```
    Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
    
    Returns:
    
    Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
    
    See Also:
    
    WorkspaceImageRequiredTenancy
  - withRequiredTenancy
```
public WorkspaceImage withRequiredTenancy(String requiredTenancy)
```
    Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
    
    Parameters:
    
    requiredTenancy - Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkspaceImageRequiredTenancy
  - withRequiredTenancy
```
public WorkspaceImage withRequiredTenancy(WorkspaceImageRequiredTenancy requiredTenancy)
```
    Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
    
    Parameters:
    
    requiredTenancy - Specifies whether the image is running on dedicated hardware. When Bring Your Own License (BYOL) is enabled, this value is set to DEDICATED. For more information, see Bring Your Own Windows Desktop Images.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    WorkspaceImageRequiredTenancy
  - setErrorCode
```
public void setErrorCode(String errorCode)
```
    The error code that is returned for the image.
    
    Parameters:
    
    errorCode - The error code that is returned for the image.
  - getErrorCode
```
public String getErrorCode()
```
    The error code that is returned for the image.
    
    Returns:
    
    The error code that is returned for the image.
  - withErrorCode
```
public WorkspaceImage withErrorCode(String errorCode)
```
    The error code that is returned for the image.
    
    Parameters:
    
    errorCode - The error code that is returned for the image.
    
    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 for the image.
    
    Parameters:
    
    errorMessage - The text of the error message that is returned for the image.
  - getErrorMessage
```
public String getErrorMessage()
```
    The text of the error message that is returned for the image.
    
    Returns:
    
    The text of the error message that is returned for the image.
  - withErrorMessage
```
public WorkspaceImage withErrorMessage(String errorMessage)
```
    The text of the error message that is returned for the image.
    
    Parameters:
    
    errorMessage - The text of the error message that is returned for the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreated
```
public void setCreated(Date created)
```
    The date when the image was created. If the image has been shared, the AWS account that the image has been shared with sees the original creation date of the image.
    
    Parameters:
    
    created - The date when the image was created. If the image has been shared, the AWS account that the image has been shared with sees the original creation date of the image.
  - getCreated
```
public Date getCreated()
```
    The date when the image was created. If the image has been shared, the AWS account that the image has been shared with sees the original creation date of the image.
    
    Returns:
    
    The date when the image was created. If the image has been shared, the AWS account that the image has been shared with sees the original creation date of the image.
  - withCreated
```
public WorkspaceImage withCreated(Date created)
```
    The date when the image was created. If the image has been shared, the AWS account that the image has been shared with sees the original creation date of the image.
    
    Parameters:
    
    created - The date when the image was created. If the image has been shared, the AWS account that the image has been shared with sees the original creation date of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setOwnerAccountId
```
public void setOwnerAccountId(String ownerAccountId)
```
    The identifier of the AWS account that owns the image.
    
    Parameters:
    
    ownerAccountId - The identifier of the AWS account that owns the image.
  - getOwnerAccountId
```
public String getOwnerAccountId()
```
    The identifier of the AWS account that owns the image.
    
    Returns:
    
    The identifier of the AWS account that owns the image.
  - withOwnerAccountId
```
public WorkspaceImage withOwnerAccountId(String ownerAccountId)
```
    The identifier of the AWS account that owns the image.
    
    Parameters:
    
    ownerAccountId - The identifier of the AWS account that owns the image.
    
    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 WorkspaceImage 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 WorkspaceImage

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WorkspaceImage

Method Detail

setImageId

getImageId

withImageId

setName

getName

withName

setDescription

getDescription

withDescription

setOperatingSystem

getOperatingSystem

withOperatingSystem

setState

getState

withState

withState

setRequiredTenancy

getRequiredTenancy

withRequiredTenancy

withRequiredTenancy

setErrorCode

getErrorCode

withErrorCode

setErrorMessage

getErrorMessage

withErrorMessage

setCreated

getCreated

withCreated

setOwnerAccountId

getOwnerAccountId

withOwnerAccountId

toString

equals

hashCode

clone

marshall