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

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

@Generated("software.amazon.awssdk:codegen")
public final class WorkspaceImage
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<WorkspaceImage.Builder,WorkspaceImage>

Describes a WorkSpace image.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface WorkspaceImage.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static WorkspaceImage.Builder`	`builder()`
`Instant`	`created()`	The date when the image was created.
`String`	`description()`	The description of the image.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`errorCode()`	The error code that is returned for the image.
`List<ErrorDetails>`	`errorDetails()`	Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.
`String`	`errorMessage()`	The text of the error message that is returned for the image.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasErrorDetails()`	For responses, this returns true if the service returned a value for the ErrorDetails property.
`int`	`hashCode()`
`String`	`imageId()`	The identifier of the image.
`String`	`name()`	The name of the image.
`OperatingSystem`	`operatingSystem()`	The operating system that the image is running.
`String`	`ownerAccountId()`	The identifier of the Amazon Web Services account that owns the image.
`WorkspaceImageRequiredTenancy`	`requiredTenancy()`	Specifies whether the image is running on dedicated hardware.
`String`	`requiredTenancyAsString()`	Specifies whether the image is running on dedicated hardware.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends WorkspaceImage.Builder>`	`serializableBuilderClass()`
`WorkspaceImageState`	`state()`	The status of the image.
`String`	`stateAsString()`	The status of the image.
`WorkspaceImage.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`UpdateResult`	`updates()`	The updates (if any) that are available for the specified image.

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

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

- Method Detail
  - imageId
```
public final String imageId()
```
    The identifier of the image.
    
    Returns:
    
    The identifier of the image.
  - name
```
public final String name()
```
    The name of the image.
    
    Returns:
    
    The name of the image.
  - description
```
public final String description()
```
    The description of the image.
    
    Returns:
    
    The description of the image.
  - operatingSystem
```
public final OperatingSystem operatingSystem()
```
    The operating system that the image is running.
    
    Returns:
    
    The operating system that the image is running.
  - state
```
public final WorkspaceImageState state()
```
    The status of the image.
    
    If the service returns an enum value that is not available in the current SDK version, state will return WorkspaceImageState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The status of the image.
    
    See Also:
    
    WorkspaceImageState
  - stateAsString
```
public final String stateAsString()
```
    The status of the image.
    
    If the service returns an enum value that is not available in the current SDK version, state will return WorkspaceImageState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().
    
    Returns:
    
    The status of the image.
    
    See Also:
    
    WorkspaceImageState
  - requiredTenancy
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, requiredTenancy will return WorkspaceImageRequiredTenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requiredTenancyAsString().
    
    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
  - requiredTenancyAsString
```
public final String requiredTenancyAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, requiredTenancy will return WorkspaceImageRequiredTenancy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requiredTenancyAsString().
    
    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
  - errorCode
```
public final String errorCode()
```
    The error code that is returned for the image.
    
    Returns:
    
    The error code that is returned for the image.
  - errorMessage
```
public final String errorMessage()
```
    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.
  - created
```
public final Instant created()
```
    The date when the image was created. If the image has been shared, the Amazon Web Services 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 Amazon Web Services account that the image has been shared with sees the original creation date of the image.
  - ownerAccountId
```
public final String ownerAccountId()
```
    The identifier of the Amazon Web Services account that owns the image.
    
    Returns:
    
    The identifier of the Amazon Web Services account that owns the image.
  - updates
```
public final UpdateResult updates()
```
    The updates (if any) that are available for the specified image.
    
    Returns:
    
    The updates (if any) that are available for the specified image.
  - hasErrorDetails
```
public final boolean hasErrorDetails()
```
    For responses, this returns true if the service returned a value for the ErrorDetails property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - errorDetails
```
public final List<ErrorDetails> errorDetails()
```
    Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasErrorDetails() method.
    
    Returns:
    
    Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.
  - toBuilder
```
public WorkspaceImage.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<WorkspaceImage.Builder,WorkspaceImage>
  - builder
```
public static WorkspaceImage.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends WorkspaceImage.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class WorkspaceImage

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

imageId

name

description

operatingSystem

state

stateAsString

requiredTenancy

requiredTenancyAsString

errorCode

errorMessage

created

ownerAccountId

updates

hasErrorDetails

errorDetails

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields