Class WorkspaceImage
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<WorkspaceImage.Builder,
WorkspaceImage>
Describes a WorkSpace image.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic WorkspaceImage.Builder
builder()
final Instant
created()
The date when the image was created.final String
The description of the image.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The error code that is returned for the image.final List
<ErrorDetails> Additional details of the error returned for the image, including the possible causes of the errors and troubleshooting information.final String
The text of the error message that is returned for the image.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ErrorDetails property.final int
hashCode()
final String
imageId()
The identifier of the image.final String
name()
The name of the image.final OperatingSystem
The operating system that the image is running.final String
The identifier of the Amazon Web Services account that owns the image.Specifies whether the image is running on dedicated hardware.final String
Specifies whether the image is running on dedicated hardware.static Class
<? extends WorkspaceImage.Builder> final WorkspaceImageState
state()
The status of the image.final String
The status of the image.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final UpdateResult
updates()
The updates (if any) that are available for the specified image.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
imageId
The identifier of the image.
- Returns:
- The identifier of the image.
-
name
The name of the image.
- Returns:
- The name of the image.
-
description
The description of the image.
- Returns:
- The description of the image.
-
operatingSystem
The operating system that the image is running.
- Returns:
- The operating system that the image is running.
-
state
The status of the image.
If the service returns an enum value that is not available in the current SDK version,
state
will returnWorkspaceImageState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The status of the image.
- See Also:
-
stateAsString
The status of the image.
If the service returns an enum value that is not available in the current SDK version,
state
will returnWorkspaceImageState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The status of the image.
- See Also:
-
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 returnWorkspaceImageRequiredTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequiredTenancyAsString()
.- 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:
-
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 returnWorkspaceImageRequiredTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequiredTenancyAsString()
.- 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:
-
errorCode
The error code that is returned for the image.
- Returns:
- The error code that is returned for the image.
-
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
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
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<WorkspaceImage.Builder,
WorkspaceImage> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-