Image (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.appstream.model.Image

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Image
extends Object
implements Serializable, Cloneable, StructuredPojo
```
New streaming instances are booted from images. The image stores the application catalog and is connected to fleets.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Image()

Constructors
Constructor and Description
`Image()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Image`	`clone()`
`boolean`	`equals(Object obj)`
`List<Application>`	`getApplications()` The applications associated with an image.
`String`	`getArn()` The ARN for the image.
`String`	`getBaseImageArn()` The source image ARN from which this image was created.
`Date`	`getCreatedTime()` The timestamp when the image was created.
`String`	`getDescription()` A meaningful description for the image.
`String`	`getDisplayName()` The display name for the image.
`Boolean`	`getImageBuilderSupported()` Whether an image builder can be launched from this image.
`String`	`getName()` The unique identifier for the image.
`String`	`getPlatform()` The operating system platform of the image.
`Date`	`getPublicBaseImageReleasedDate()` The AWS release date of the public base image.
`String`	`getState()` The image starts in the PENDING state, and then moves to AVAILABLE if image creation succeeds and FAILED if image creation has failed.
`ImageStateChangeReason`	`getStateChangeReason()` The reason why the last state change occurred.
`String`	`getVisibility()` The visibility of an image to the user; images can be public or private.
`int`	`hashCode()`
`Boolean`	`isImageBuilderSupported()` Whether an image builder can be launched from this image.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApplications(Collection<Application> applications)` The applications associated with an image.
`void`	`setArn(String arn)` The ARN for the image.
`void`	`setBaseImageArn(String baseImageArn)` The source image ARN from which this image was created.
`void`	`setCreatedTime(Date createdTime)` The timestamp when the image was created.
`void`	`setDescription(String description)` A meaningful description for the image.
`void`	`setDisplayName(String displayName)` The display name for the image.
`void`	`setImageBuilderSupported(Boolean imageBuilderSupported)` Whether an image builder can be launched from this image.
`void`	`setName(String name)` The unique identifier for the image.
`void`	`setPlatform(PlatformType platform)` The operating system platform of the image.
`void`	`setPlatform(String platform)` The operating system platform of the image.
`void`	`setPublicBaseImageReleasedDate(Date publicBaseImageReleasedDate)` The AWS release date of the public base image.
`void`	`setState(ImageState state)` The image starts in the PENDING state, and then moves to AVAILABLE if image creation succeeds and FAILED if image creation has failed.
`void`	`setState(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.
`void`	`setStateChangeReason(ImageStateChangeReason stateChangeReason)` The reason why the last state change occurred.
`void`	`setVisibility(String visibility)` The visibility of an image to the user; images can be public or private.
`void`	`setVisibility(VisibilityType visibility)` The visibility of an image to the user; images can be public or private.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Image`	`withApplications(Application... applications)` The applications associated with an image.
`Image`	`withApplications(Collection<Application> applications)` The applications associated with an image.
`Image`	`withArn(String arn)` The ARN for the image.
`Image`	`withBaseImageArn(String baseImageArn)` The source image ARN from which this image was created.
`Image`	`withCreatedTime(Date createdTime)` The timestamp when the image was created.
`Image`	`withDescription(String description)` A meaningful description for the image.
`Image`	`withDisplayName(String displayName)` The display name for the image.
`Image`	`withImageBuilderSupported(Boolean imageBuilderSupported)` Whether an image builder can be launched from this image.
`Image`	`withName(String name)` The unique identifier for the image.
`Image`	`withPlatform(PlatformType platform)` The operating system platform of the image.
`Image`	`withPlatform(String platform)` The operating system platform of the image.
`Image`	`withPublicBaseImageReleasedDate(Date publicBaseImageReleasedDate)` The AWS release date of the public base image.
`Image`	`withState(ImageState state)` The image starts in the PENDING state, and then moves to AVAILABLE if image creation succeeds and FAILED if image creation has failed.
`Image`	`withState(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.
`Image`	`withStateChangeReason(ImageStateChangeReason stateChangeReason)` The reason why the last state change occurred.
`Image`	`withVisibility(String visibility)` The visibility of an image to the user; images can be public or private.
`Image`	`withVisibility(VisibilityType 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

- Constructor Detail
  - Image
```
public Image()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The unique identifier for the image.
    
    Parameters:
    
    name - The unique identifier for the image.
  - getName
```
public String getName()
```
    The unique identifier for the image.
    
    Returns:
    
    The unique identifier for the image.
  - withName
```
public Image withName(String name)
```
    The unique identifier for the image.
    
    Parameters:
    
    name - The unique identifier for the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setArn
```
public void setArn(String arn)
```
    The ARN for the image.
    
    Parameters:
    
    arn - The ARN for the image.
  - getArn
```
public String getArn()
```
    The ARN for the image.
    
    Returns:
    
    The ARN for the image.
  - withArn
```
public Image withArn(String arn)
```
    The ARN for the image.
    
    Parameters:
    
    arn - The ARN for the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBaseImageArn
```
public void setBaseImageArn(String baseImageArn)
```
    The source image ARN from which this image was created.
    
    Parameters:
    
    baseImageArn - The source image ARN from which this image was created.
  - getBaseImageArn
```
public String getBaseImageArn()
```
    The source image ARN from which this image was created.
    
    Returns:
    
    The source image ARN from which this image was created.
  - withBaseImageArn
```
public Image withBaseImageArn(String baseImageArn)
```
    The source image ARN from which this image was created.
    
    Parameters:
    
    baseImageArn - The source image ARN from which this image was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    The display name for the image.
    
    Parameters:
    
    displayName - The display name for the image.
  - getDisplayName
```
public String getDisplayName()
```
    The display name for the image.
    
    Returns:
    
    The display name for the image.
  - withDisplayName
```
public Image withDisplayName(String displayName)
```
    The display name for the image.
    
    Parameters:
    
    displayName - The display name for the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(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.
    
    Parameters:
    
    state - 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
  - getState
```
public String getState()
```
    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
  - withState
```
public Image withState(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ImageState
  - setState
```
public void setState(ImageState state)
```
    The image starts in the PENDING state, and then moves to AVAILABLE if image creation succeeds and FAILED if image creation has failed.
    
    Parameters:
    
    state - 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
  - withState
```
public Image withState(ImageState state)
```
    The image starts in the PENDING state, and then moves to AVAILABLE if image creation succeeds and FAILED if image creation has failed.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ImageState
  - setVisibility
```
public void setVisibility(String visibility)
```
    The visibility of an image to the user; images can be public or private.
    
    Parameters:
    
    visibility - The visibility of an image to the user; images can be public or private.
    
    See Also:
    
    VisibilityType
  - getVisibility
```
public String getVisibility()
```
    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
  - withVisibility
```
public Image withVisibility(String visibility)
```
    The visibility of an image to the user; images can be public or private.
    
    Parameters:
    
    visibility - The visibility of an image to the user; images can be public or private.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VisibilityType
  - setVisibility
```
public void setVisibility(VisibilityType visibility)
```
    The visibility of an image to the user; images can be public or private.
    
    Parameters:
    
    visibility - The visibility of an image to the user; images can be public or private.
    
    See Also:
    
    VisibilityType
  - withVisibility
```
public Image withVisibility(VisibilityType visibility)
```
    The visibility of an image to the user; images can be public or private.
    
    Parameters:
    
    visibility - The visibility of an image to the user; images can be public or private.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VisibilityType
  - setImageBuilderSupported
```
public void setImageBuilderSupported(Boolean imageBuilderSupported)
```
    Whether an image builder can be launched from this image.
    
    Parameters:
    
    imageBuilderSupported - Whether an image builder can be launched from this image.
  - getImageBuilderSupported
```
public Boolean getImageBuilderSupported()
```
    Whether an image builder can be launched from this image.
    
    Returns:
    
    Whether an image builder can be launched from this image.
  - withImageBuilderSupported
```
public Image withImageBuilderSupported(Boolean imageBuilderSupported)
```
    Whether an image builder can be launched from this image.
    
    Parameters:
    
    imageBuilderSupported - Whether an image builder can be launched from this image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isImageBuilderSupported
```
public Boolean isImageBuilderSupported()
```
    Whether an image builder can be launched from this image.
    
    Returns:
    
    Whether an image builder can be launched from this image.
  - setPlatform
```
public void setPlatform(String platform)
```
    The operating system platform of the image.
    
    Parameters:
    
    platform - The operating system platform of the image.
    
    See Also:
    
    PlatformType
  - getPlatform
```
public String getPlatform()
```
    The operating system platform of the image.
    
    Returns:
    
    The operating system platform of the image.
    
    See Also:
    
    PlatformType
  - withPlatform
```
public Image withPlatform(String platform)
```
    The operating system platform of the image.
    
    Parameters:
    
    platform - The operating system platform of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlatformType
  - setPlatform
```
public void setPlatform(PlatformType platform)
```
    The operating system platform of the image.
    
    Parameters:
    
    platform - The operating system platform of the image.
    
    See Also:
    
    PlatformType
  - withPlatform
```
public Image withPlatform(PlatformType platform)
```
    The operating system platform of the image.
    
    Parameters:
    
    platform - The operating system platform of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PlatformType
  - setDescription
```
public void setDescription(String description)
```
    A meaningful description for the image.
    
    Parameters:
    
    description - A meaningful description for the image.
  - getDescription
```
public String getDescription()
```
    A meaningful description for the image.
    
    Returns:
    
    A meaningful description for the image.
  - withDescription
```
public Image withDescription(String description)
```
    A meaningful description for the image.
    
    Parameters:
    
    description - A meaningful description for the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStateChangeReason
```
public void setStateChangeReason(ImageStateChangeReason stateChangeReason)
```
    The reason why the last state change occurred.
    
    Parameters:
    
    stateChangeReason - The reason why the last state change occurred.
  - getStateChangeReason
```
public ImageStateChangeReason getStateChangeReason()
```
    The reason why the last state change occurred.
    
    Returns:
    
    The reason why the last state change occurred.
  - withStateChangeReason
```
public Image withStateChangeReason(ImageStateChangeReason stateChangeReason)
```
    The reason why the last state change occurred.
    
    Parameters:
    
    stateChangeReason - The reason why the last state change occurred.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getApplications
```
public List<Application> getApplications()
```
    The applications associated with an image.
    
    Returns:
    
    The applications associated with an image.
  - setApplications
```
public void setApplications(Collection<Application> applications)
```
    The applications associated with an image.
    
    Parameters:
    
    applications - The applications associated with an image.
  - withApplications
```
public Image withApplications(Application... applications)
```
    The applications associated with an image.
    
    NOTE: This method appends the values to the existing list (if any). Use setApplications(java.util.Collection) or withApplications(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    applications - The applications associated with an image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withApplications
```
public Image withApplications(Collection<Application> applications)
```
    The applications associated with an image.
    
    Parameters:
    
    applications - The applications associated with an image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedTime
```
public void setCreatedTime(Date createdTime)
```
    The timestamp when the image was created.
    
    Parameters:
    
    createdTime - The timestamp when the image was created.
  - getCreatedTime
```
public Date getCreatedTime()
```
    The timestamp when the image was created.
    
    Returns:
    
    The timestamp when the image was created.
  - withCreatedTime
```
public Image withCreatedTime(Date createdTime)
```
    The timestamp when the image was created.
    
    Parameters:
    
    createdTime - The timestamp when the image was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPublicBaseImageReleasedDate
```
public void setPublicBaseImageReleasedDate(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.
    
    Parameters:
    
    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.
  - getPublicBaseImageReleasedDate
```
public Date getPublicBaseImageReleasedDate()
```
    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.
  - withPublicBaseImageReleasedDate
```
public Image withPublicBaseImageReleasedDate(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Image clone()
```
    Overrides:
    
    clone 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.

Did this page help you?

Class Image

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Image

Method Detail

setName

getName

withName

setArn

getArn

withArn

setBaseImageArn

getBaseImageArn

withBaseImageArn

setDisplayName

getDisplayName

withDisplayName

setState

getState

withState

setState

withState

setVisibility

getVisibility

withVisibility

setVisibility

withVisibility

setImageBuilderSupported

getImageBuilderSupported

withImageBuilderSupported

isImageBuilderSupported

setPlatform

getPlatform

withPlatform

setPlatform

withPlatform

setDescription

getDescription

withDescription

setStateChangeReason

getStateChangeReason

withStateChangeReason

getApplications

setApplications

withApplications

withApplications

setCreatedTime

getCreatedTime

withCreatedTime

setPublicBaseImageReleasedDate

getPublicBaseImageReleasedDate

withPublicBaseImageReleasedDate

toString

equals

hashCode

clone

marshall