ImageSummary (AWS Java SDK :: Services :: Imagebuilder 2.20.94 API)

java.lang.Object
- software.amazon.awssdk.services.imagebuilder.model.ImageSummary

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

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

An image summary.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ImageSummary.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ImageSummary.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`arn()` The Amazon Resource Name (ARN) of the image.
`static ImageSummary.Builder`	`builder()`
`BuildType`	`buildType()` Indicates the type of build that created this image.
`String`	`buildTypeAsString()` Indicates the type of build that created this image.
`String`	`dateCreated()` The date on which Image Builder created this image.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`ImageSource`	`imageSource()` The origin of the base image that Image Builder used to build this image.
`String`	`imageSourceAsString()` The origin of the base image that Image Builder used to build this image.
`String`	`name()` The name of the image.
`String`	`osVersion()` The operating system version of the instances that launch from this image.
`OutputResources`	`outputResources()` The output resources that Image Builder produced when it created this image.
`String`	`owner()` The owner of the image.
`Platform`	`platform()` The image operating system platform, such as Linux or Windows.
`String`	`platformAsString()` The image operating system platform, such as Linux or Windows.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ImageSummary.Builder>`	`serializableBuilderClass()`
`ImageState`	`state()` The state of the image.
`Map<String,String>`	`tags()` The tags that apply to this image.
`ImageSummary.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`ImageType`	`type()` Specifies whether this image produces an AMI or a container image.
`String`	`typeAsString()` Specifies whether this image produces an AMI or a container image.
`String`	`version()` The version of the 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
  - 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:
    
    ImageType
  - 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:
    
    ImageType
  - 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:
    
    Platform
  - 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:
    
    Platform
  - 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.
    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.
    See Also:
    
    BuildType
  - 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.
    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.
    See Also:
    
    BuildType
  - 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:
    
    ImageSource
  - 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:
    
    ImageSource
  - toBuilder
```
public ImageSummary.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ImageSummary.Builder,ImageSummary>
  - 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)
```
    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 ImageSummary

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

name

type

typeAsString

version

platform

platformAsString

osVersion

state

owner

dateCreated

outputResources

hasTags

tags

buildType

buildTypeAsString

imageSource

imageSourceAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields