Class Image
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Image.Builder,
Image>
Describes an image.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal List
<Application> The applications associated with the image.final String
The version of the AppStream 2.0 agent to use for instances that are launched from this image.final String
arn()
The ARN of the image.final String
The ARN of the image from which this image was created.static Image.Builder
builder()
final Instant
The time the image was created.final String
The description to display.final String
The image name to display.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.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 Applications property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ImageErrors property.final String
The name of the image builder that was used to create the private image.final Boolean
Indicates whether an image builder can be launched from this image.final List
<ResourceError> Describes the errors that are returned when a new image can't be created.final ImagePermissions
The permissions to provide to the destination AWS account for the specified image.final String
name()
The name of the image.final PlatformType
platform()
The operating system platform of the image.final String
The operating system platform of the image.final Instant
The release date of the public base image.static Class
<? extends Image.Builder> final ImageState
state()
The image starts in thePENDING
state.final String
The image starts in thePENDING
state.final ImageStateChangeReason
The reason why the last state change occurred.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 VisibilityType
Indicates whether the image is public or private.final String
Indicates whether the image is public or private.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the image.
- Returns:
- The name of the image.
-
arn
The ARN of the image.
- Returns:
- The ARN of the image.
-
baseImageArn
The ARN of the image from which this image was created.
- Returns:
- The ARN of the image from which this image was created.
-
displayName
The image name to display.
- Returns:
- The image name to display.
-
state
The image starts in the
PENDING
state. If image creation succeeds, the state isAVAILABLE
. If image creation fails, the state isFAILED
.If the service returns an enum value that is not available in the current SDK version,
state
will returnImageState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The image starts in the
PENDING
state. If image creation succeeds, the state isAVAILABLE
. If image creation fails, the state isFAILED
. - See Also:
-
stateAsString
The image starts in the
PENDING
state. If image creation succeeds, the state isAVAILABLE
. If image creation fails, the state isFAILED
.If the service returns an enum value that is not available in the current SDK version,
state
will returnImageState.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstateAsString()
.- Returns:
- The image starts in the
PENDING
state. If image creation succeeds, the state isAVAILABLE
. If image creation fails, the state isFAILED
. - See Also:
-
visibility
Indicates whether the image is public or private.
If the service returns an enum value that is not available in the current SDK version,
visibility
will returnVisibilityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvisibilityAsString()
.- Returns:
- Indicates whether the image is public or private.
- See Also:
-
visibilityAsString
Indicates whether the image is public or private.
If the service returns an enum value that is not available in the current SDK version,
visibility
will returnVisibilityType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvisibilityAsString()
.- Returns:
- Indicates whether the image is public or private.
- See Also:
-
imageBuilderSupported
Indicates whether an image builder can be launched from this image.
- Returns:
- Indicates whether an image builder can be launched from this image.
-
imageBuilderName
The name of the image builder that was used to create the private image. If the image is shared, this value is null.
- Returns:
- The name of the image builder that was used to create the private image. If the image is shared, this value is null.
-
platform
The operating system platform of the image.
If the service returns an enum value that is not available in the current SDK version,
platform
will returnPlatformType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- The operating system platform of the image.
- See Also:
-
platformAsString
The operating system platform of the image.
If the service returns an enum value that is not available in the current SDK version,
platform
will returnPlatformType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromplatformAsString()
.- Returns:
- The operating system platform of the image.
- See Also:
-
description
The description to display.
- Returns:
- The description to display.
-
stateChangeReason
The reason why the last state change occurred.
- Returns:
- The reason why the last state change occurred.
-
hasApplications
public final boolean hasApplications()For responses, this returns true if the service returned a value for the Applications 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. -
applications
The applications associated with the image.
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
hasApplications()
method.- Returns:
- The applications associated with the image.
-
createdTime
The time the image was created.
- Returns:
- The time the image was created.
-
publicBaseImageReleasedDate
The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
- Returns:
- The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
-
appstreamAgentVersion
The version of the AppStream 2.0 agent to use for instances that are launched from this image.
- Returns:
- The version of the AppStream 2.0 agent to use for instances that are launched from this image.
-
imagePermissions
The permissions to provide to the destination AWS account for the specified image.
- Returns:
- The permissions to provide to the destination AWS account for the specified image.
-
hasImageErrors
public final boolean hasImageErrors()For responses, this returns true if the service returned a value for the ImageErrors 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. -
imageErrors
Describes the errors that are returned when a new image can't be created.
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
hasImageErrors()
method.- Returns:
- Describes the errors that are returned when a new image can't be created.
-
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<Image.Builder,
Image> - 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
-