Class ImageSummary

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

An image summary.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the image.

      Returns:
      The Amazon Resource Name (ARN) of the image.

    • name

      public final String name()

      The name of the image.

      Returns:
      The name of the image.

    • type

      public final ImageType type()

      Specifies whether this image produces an AMI or a container image.

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

      Returns:
      Specifies whether this image produces an AMI or a container image.
      See Also:

    • typeAsString

      public final String typeAsString()

      Specifies whether this image produces an AMI or a container image.

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

      Returns:
      Specifies whether this image produces an AMI or a container image.
      See Also:

    • version

      public final String version()

      The version of the image.

      Returns:
      The version of the image.

    • platform

      public final Platform platform()

      The image operating system platform, such as Linux or Windows.

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

      Returns:
      The image operating system platform, such as Linux or Windows.
      See Also:

    • platformAsString

      public final String platformAsString()

      The image operating system platform, such as Linux or Windows.

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

      Returns:
      The image operating system platform, such as Linux or Windows.
      See Also:

    • osVersion

      public final String osVersion()

      The operating system version of the instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

      Returns:
      The operating system version of the instances that launch from this image. For example, Amazon Linux 2, Ubuntu 18, or Microsoft Windows Server 2019.

    • state

      public final ImageState state()

      The state of the image.

      Returns:
      The state of the image.

    • owner

      public final String owner()

      The owner of the image.

      Returns:
      The owner of the image.

    • dateCreated

      public final String dateCreated()

      The date on which Image Builder created this image.

      Returns:
      The date on which Image Builder created this image.

    • outputResources

      public final OutputResources outputResources()

      The output resources that Image Builder produced when it created this image.

      Returns:
      The output resources that Image Builder produced when it created this image.

    • hasTags

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

    • tags

      public final Map<String,String> tags()

      The tags that apply to this 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 hasTags() method.

      Returns:
      The tags that apply to this image.

    • buildType

      public final BuildType buildType()

      Indicates the type of build that created this image. The build can be initiated in the following ways:

      • USER_INITIATED – A manual pipeline build request.

      • SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

      • IMPORT – A VM import created the image to use as the base image for the recipe.

      • IMPORT_ISO – An ISO disk import created the image.

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

      Returns:
      Indicates the type of build that created this image. The build can be initiated in the following ways:

      • USER_INITIATED – A manual pipeline build request.

      • SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

      • IMPORT – A VM import created the image to use as the base image for the recipe.

      • IMPORT_ISO – An ISO disk import created the image.

      See Also:

    • buildTypeAsString

      public final String buildTypeAsString()

      Indicates the type of build that created this image. The build can be initiated in the following ways:

      • USER_INITIATED – A manual pipeline build request.

      • SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

      • IMPORT – A VM import created the image to use as the base image for the recipe.

      • IMPORT_ISO – An ISO disk import created the image.

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

      Returns:
      Indicates the type of build that created this image. The build can be initiated in the following ways:

      • USER_INITIATED – A manual pipeline build request.

      • SCHEDULED – A pipeline build initiated by a cron expression in the Image Builder pipeline, or from EventBridge.

      • IMPORT – A VM import created the image to use as the base image for the recipe.

      • IMPORT_ISO – An ISO disk import created the image.

      See Also:

    • imageSource

      public final ImageSource imageSource()

      The origin of the base image that Image Builder used to build this image.

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

      Returns:
      The origin of the base image that Image Builder used to build this image.
      See Also:

    • imageSourceAsString

      public final String imageSourceAsString()

      The origin of the base image that Image Builder used to build this image.

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

      Returns:
      The origin of the base image that Image Builder used to build this image.
      See Also:

    • deprecationTime

      public final Instant deprecationTime()

      The time when deprecation occurs for an image resource. This can be a past or future date.

      Returns:
      The time when deprecation occurs for an image resource. This can be a past or future date.

    • lifecycleExecutionId

      public final String lifecycleExecutionId()

      Identifies the last runtime instance of the lifecycle policy to take action on the image.

      Returns:
      Identifies the last runtime instance of the lifecycle policy to take action on the image.

    • loggingConfiguration

      public final ImageLoggingConfiguration loggingConfiguration()

      The logging configuration that's defined for the image.

      Returns:
      The logging configuration that's defined for the image.

    • toBuilder

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

    • builder

      public static ImageSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ImageSummary.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.