Image (AWS Java SDK :: Services :: Amazon AppStream 2.20.103 API)

java.lang.Object
- software.amazon.awssdk.services.appstream.model.Image

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

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

Describes an image.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Image.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<Application>`	`applications()` The applications associated with the image.
`String`	`appstreamAgentVersion()` The version of the AppStream 2.0 agent to use for instances that are launched from this image.
`String`	`arn()` The ARN of the image.
`String`	`baseImageArn()` The ARN of the image from which this image was created.
`static Image.Builder`	`builder()`
`Instant`	`createdTime()` The time the image was created.
`String`	`description()` The description to display.
`String`	`displayName()` The image name to display.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasApplications()` For responses, this returns true if the service returned a value for the Applications property.
`int`	`hashCode()`
`boolean`	`hasImageErrors()` For responses, this returns true if the service returned a value for the ImageErrors property.
`String`	`imageBuilderName()` The name of the image builder that was used to create the private image.
`Boolean`	`imageBuilderSupported()` Indicates whether an image builder can be launched from this image.
`List<ResourceError>`	`imageErrors()` Describes the errors that are returned when a new image can't be created.
`ImagePermissions`	`imagePermissions()` The permissions to provide to the destination AWS account for the specified image.
`String`	`name()` The name of the image.
`PlatformType`	`platform()` The operating system platform of the image.
`String`	`platformAsString()` The operating system platform of the image.
`Instant`	`publicBaseImageReleasedDate()` The release date of the public base image.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Image.Builder>`	`serializableBuilderClass()`
`ImageState`	`state()` The image starts in the `PENDING` state.
`String`	`stateAsString()` The image starts in the `PENDING` state.
`ImageStateChangeReason`	`stateChangeReason()` The reason why the last state change occurred.
`Image.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`VisibilityType`	`visibility()` Indicates whether the image is public or private.
`String`	`visibilityAsString()` Indicates whether the image is public or private.

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
  - 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:
    
    ImageState
  - 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:
    
    ImageState
  - 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:
    
    VisibilityType
  - 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:
    
    VisibilityType
  - 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:
    
    PlatformType
  - 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:
    
    PlatformType
  - 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.
  - toBuilder
```
public Image.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Image.Builder,Image>
  - 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)
```
    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 Image

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

name

arn

baseImageArn

displayName

state

stateAsString

visibility

visibilityAsString

imageBuilderSupported

imageBuilderName

platform

platformAsString

description

stateChangeReason

hasApplications

applications

createdTime

publicBaseImageReleasedDate

appstreamAgentVersion

imagePermissions

hasImageErrors

imageErrors

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields