software.amazon.awssdk.services.appstream.model

Class Image

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

Method Summary

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 for display.
String	displayName() The image name for display.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	imageBuilderSupported() Indicates whether an image builder can be launched from this image.
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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

name

public String name()

The name of the image.

Returns:

The name of the image.

arn

public String arn()

The ARN of the image.

Returns:

The ARN of the image.

baseImageArn

public 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 String displayName()

The image name for display.

Returns:

The image name for display.

state

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

platform

public 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 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 String description()

The description for display.

Returns:

The description for display.

stateChangeReason

public ImageStateChangeReason stateChangeReason()

The reason why the last state change occurred.

Returns:

The reason why the last state change occurred.

applications

public List<Application> applications()

The applications associated with the image.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The applications associated with the image.

createdTime

public Instant createdTime()

The time the image was created.

Returns:

The time the image was created.

publicBaseImageReleasedDate

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

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

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