Package software.amazon.awssdk.services.appstream.model

Class Image

java.lang.Object

software.amazon.awssdk.services.appstream.model.Image

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Image.Builder,Image>

@Generated("software.amazon.awssdk:codegen")
public class Image
extends Object
implements StructuredPojo, ToCopyableBuilder<Image.Builder,Image>

New streaming instances are booted from images. The image stores the application catalog and is connected to fleets.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Image.Builder

Method Summary

Modifier and Type	Method	Description
List<Application>	applications()	The applications associated with an image.
String	arn()	The ARN for the image.
String	baseImageArn()	The source image ARN from which this image was created.
static Image.Builder	builder()
Date	createdTime()	The timestamp when the image was created.
String	description()	A meaningful description for the image.
String	displayName()	The display name for the image.
boolean	equals(Object obj)
int	hashCode()
Boolean	imageBuilderSupported()	Whether an image builder can be launched from this image.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	name()	The unique identifier for the image.
String	platform()	The operating system platform of the image.
Date	publicBaseImageReleasedDate()	The AWS release date of the public base image.
static Class<? extends Image.Builder>	serializableBuilderClass()
String	state()	The image starts in the PENDING state, and then moves to AVAILABLE if image creation succeeds and FAILED if image creation has failed.
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()
String	visibility()	The visibility of an image to the user; images can be public or private.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

name

public String name()

The unique identifier for the image.

Returns:

The unique identifier for the image.

arn

public String arn()

The ARN for the image.

Returns:

The ARN for the image.

baseImageArn

public String baseImageArn()

The source image ARN from which this image was created.

Returns:

The source image ARN from which this image was created.

displayName

public String displayName()

The display name for the image.

Returns:

The display name for the image.

state

public String state()

The image starts in the PENDING state, and then moves to AVAILABLE if image creation succeeds and FAILED if image creation has failed.

Returns:

The image starts in the PENDING state, and then moves to AVAILABLE if image creation succeeds and FAILED if image creation has failed.

See Also:

ImageState

visibility

public String visibility()

The visibility of an image to the user; images can be public or private.

Returns:

The visibility of an image to the user; images can be public or private.

See Also:

VisibilityType

imageBuilderSupported

public Boolean imageBuilderSupported()

Whether an image builder can be launched from this image.

Returns:

Whether an image builder can be launched from this image.

platform

public String platform()

The operating system platform of the image.

Returns:

The operating system platform of the image.

See Also:

PlatformType

description

public String description()

A meaningful description for the image.

Returns:

A meaningful description for the image.

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 an image.

Returns:

The applications associated with an image.

createdTime

public Date createdTime()

The timestamp when the image was created.

Returns:

The timestamp when the image was created.

publicBaseImageReleasedDate

public Date publicBaseImageReleasedDate()

The AWS 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 AWS 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.

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

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.