Class Image

java.lang.Object
software.amazon.awssdk.services.appstream.model.Image
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Image.Builder,Image>
@Generated("software.amazon.awssdk:codegen") public final class Image extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Image.Builder,Image>

Describes an image.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the image.

      Returns:
      The name of the image.

    • arn

      public final String arn()

      The ARN of the image.

      Returns:
      The ARN of the image.

    • baseImageArn

      public final String 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

      public final String displayName()

      The image name to display.

      Returns:
      The image name to display.

    • state

      public final ImageState state()

      The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.

      If the service returns an enum value that is not available in the current SDK version, state will return ImageState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.
      See Also:

    • stateAsString

      public final String stateAsString()

      The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.

      If the service returns an enum value that is not available in the current SDK version, state will return ImageState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from stateAsString().

      Returns:
      The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.
      See Also:

    • visibility

      public final VisibilityType 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 return VisibilityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

      Returns:
      Indicates whether the image is public or private.
      See Also:

    • visibilityAsString

      public final String 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 return VisibilityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

      Returns:
      Indicates whether the image is public or private.
      See Also:

    • imageBuilderSupported

      public final Boolean 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

      public final String 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

      public final PlatformType 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 return PlatformType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().

      Returns:
      The operating system platform of the image.
      See Also:

    • platformAsString

      public final String 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 return PlatformType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from platformAsString().

      Returns:
      The operating system platform of the image.
      See Also:

    • description

      public final String description()

      The description to display.

      Returns:
      The description to display.

    • stateChangeReason

      public final ImageStateChangeReason 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 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.

    • applications

      public final List<Application> 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

      public final Instant createdTime()

      The time the image was created.

      Returns:
      The time the image was created.

    • publicBaseImageReleasedDate

      public final Instant 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

      public final String 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

      public final ImagePermissions 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 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.

    • imageErrors

      public final List<ResourceError> 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.

    • latestAppstreamAgentVersion

      public final LatestAppstreamAgentVersion latestAppstreamAgentVersion()

      Indicates whether the image is using the latest AppStream 2.0 agent version or not.

      If the service returns an enum value that is not available in the current SDK version, latestAppstreamAgentVersion will return LatestAppstreamAgentVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from latestAppstreamAgentVersionAsString().

      Returns:
      Indicates whether the image is using the latest AppStream 2.0 agent version or not.
      See Also:

    • latestAppstreamAgentVersionAsString

      public final String latestAppstreamAgentVersionAsString()

      Indicates whether the image is using the latest AppStream 2.0 agent version or not.

      If the service returns an enum value that is not available in the current SDK version, latestAppstreamAgentVersion will return LatestAppstreamAgentVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from latestAppstreamAgentVersionAsString().

      Returns:
      Indicates whether the image is using the latest AppStream 2.0 agent version or not.
      See Also:

    • hasSupportedInstanceFamilies

      public final boolean hasSupportedInstanceFamilies()
      For responses, this returns true if the service returned a value for the SupportedInstanceFamilies 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.

    • supportedInstanceFamilies

      public final List<String> supportedInstanceFamilies()

      The supported instances families that determine which image a customer can use when the customer launches a fleet or image builder. The following instances families are supported:

      • General Purpose

      • Compute Optimized

      • Memory Optimized

      • Graphics

      • Graphics Design

      • Graphics Pro

      • Graphics G4

      • Graphics G5

      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 hasSupportedInstanceFamilies() method.

      Returns:
      The supported instances families that determine which image a customer can use when the customer launches a fleet or image builder. The following instances families are supported:

      • General Purpose

      • Compute Optimized

      • Memory Optimized

      • Graphics

      • Graphics Design

      • Graphics Pro

      • Graphics G4

      • Graphics G5

    • dynamicAppProvidersEnabled

      public final DynamicAppProvidersEnabled dynamicAppProvidersEnabled()

      Indicates whether dynamic app providers are enabled within an AppStream 2.0 image or not.

      If the service returns an enum value that is not available in the current SDK version, dynamicAppProvidersEnabled will return DynamicAppProvidersEnabled.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dynamicAppProvidersEnabledAsString().

      Returns:
      Indicates whether dynamic app providers are enabled within an AppStream 2.0 image or not.
      See Also:

    • dynamicAppProvidersEnabledAsString

      public final String dynamicAppProvidersEnabledAsString()

      Indicates whether dynamic app providers are enabled within an AppStream 2.0 image or not.

      If the service returns an enum value that is not available in the current SDK version, dynamicAppProvidersEnabled will return DynamicAppProvidersEnabled.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dynamicAppProvidersEnabledAsString().

      Returns:
      Indicates whether dynamic app providers are enabled within an AppStream 2.0 image or not.
      See Also:

    • imageSharedWithOthers

      public final ImageSharedWithOthers imageSharedWithOthers()

      Indicates whether the image is shared with another account ID.

      If the service returns an enum value that is not available in the current SDK version, imageSharedWithOthers will return ImageSharedWithOthers.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from imageSharedWithOthersAsString().

      Returns:
      Indicates whether the image is shared with another account ID.
      See Also:

    • imageSharedWithOthersAsString

      public final String imageSharedWithOthersAsString()

      Indicates whether the image is shared with another account ID.

      If the service returns an enum value that is not available in the current SDK version, imageSharedWithOthers will return ImageSharedWithOthers.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from imageSharedWithOthersAsString().

      Returns:
      Indicates whether the image is shared with another account ID.
      See Also:

    • toBuilder

      public Image.Builder 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 interface ToCopyableBuilder<Image.Builder,Image>
      Returns:
      a builder for type T

    • builder

      public static Image.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Image.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.