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

Describes an image.

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 the image.
`String`	`getAppstreamAgentVersion()` The version of the AppStream 2.0 agent to use for instances that are launched from this image.
`String`	`getArn()` The ARN of the image.
`String`	`getBaseImageArn()` The ARN of the image from which this image was created.
`Date`	`getCreatedTime()` The time the image was created.
`String`	`getDescription()` The description to display.
`String`	`getDisplayName()` The image name to display.
`String`	`getImageBuilderName()` The name of the image builder that was used to create the private image.
`Boolean`	`getImageBuilderSupported()` Indicates whether an image builder can be launched from this image.
`List<ResourceError>`	`getImageErrors()` Describes the errors that are returned when a new image can't be created.
`ImagePermissions`	`getImagePermissions()` The permissions to provide to the destination AWS account for the specified image.
`String`	`getName()` The name of the image.
`String`	`getPlatform()` The operating system platform of the image.
`Date`	`getPublicBaseImageReleasedDate()` The release date of the public base image.
`String`	`getState()` The image starts in the `PENDING` state.
`ImageStateChangeReason`	`getStateChangeReason()` The reason why the last state change occurred.
`String`	`getVisibility()` Indicates whether the image is public or private.
`int`	`hashCode()`
`Boolean`	`isImageBuilderSupported()` Indicates 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 the image.
`void`	`setAppstreamAgentVersion(String appstreamAgentVersion)` The version of the AppStream 2.0 agent to use for instances that are launched from this image.
`void`	`setArn(String arn)` The ARN of the image.
`void`	`setBaseImageArn(String baseImageArn)` The ARN of the image from which this image was created.
`void`	`setCreatedTime(Date createdTime)` The time the image was created.
`void`	`setDescription(String description)` The description to display.
`void`	`setDisplayName(String displayName)` The image name to display.
`void`	`setImageBuilderName(String imageBuilderName)` The name of the image builder that was used to create the private image.
`void`	`setImageBuilderSupported(Boolean imageBuilderSupported)` Indicates whether an image builder can be launched from this image.
`void`	`setImageErrors(Collection<ResourceError> imageErrors)` Describes the errors that are returned when a new image can't be created.
`void`	`setImagePermissions(ImagePermissions imagePermissions)` The permissions to provide to the destination AWS account for the specified image.
`void`	`setName(String name)` The name of 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 release date of the public base image.
`void`	`setState(ImageState state)` The image starts in the `PENDING` state.
`void`	`setState(String state)` The image starts in the `PENDING` state.
`void`	`setStateChangeReason(ImageStateChangeReason stateChangeReason)` The reason why the last state change occurred.
`void`	`setVisibility(String visibility)` Indicates whether the image is public or private.
`void`	`setVisibility(VisibilityType visibility)` Indicates whether the image is public or private.
`String`	`toString()` Returns a string representation of this object.
`Image`	`withApplications(Application... applications)` The applications associated with the image.
`Image`	`withApplications(Collection<Application> applications)` The applications associated with the image.
`Image`	`withAppstreamAgentVersion(String appstreamAgentVersion)` The version of the AppStream 2.0 agent to use for instances that are launched from this image.
`Image`	`withArn(String arn)` The ARN of the image.
`Image`	`withBaseImageArn(String baseImageArn)` The ARN of the image from which this image was created.
`Image`	`withCreatedTime(Date createdTime)` The time the image was created.
`Image`	`withDescription(String description)` The description to display.
`Image`	`withDisplayName(String displayName)` The image name to display.
`Image`	`withImageBuilderName(String imageBuilderName)` The name of the image builder that was used to create the private image.
`Image`	`withImageBuilderSupported(Boolean imageBuilderSupported)` Indicates whether an image builder can be launched from this image.
`Image`	`withImageErrors(Collection<ResourceError> imageErrors)` Describes the errors that are returned when a new image can't be created.
`Image`	`withImageErrors(ResourceError... imageErrors)` Describes the errors that are returned when a new image can't be created.
`Image`	`withImagePermissions(ImagePermissions imagePermissions)` The permissions to provide to the destination AWS account for the specified image.
`Image`	`withName(String name)` The name of 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 release date of the public base image.
`Image`	`withState(ImageState state)` The image starts in the `PENDING` state.
`Image`	`withState(String state)` The image starts in the `PENDING` state.
`Image`	`withStateChangeReason(ImageStateChangeReason stateChangeReason)` The reason why the last state change occurred.
`Image`	`withVisibility(String visibility)` Indicates whether the image is public or private.
`Image`	`withVisibility(VisibilityType visibility)` Indicates whether the image is 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 name of the image.
    
    Parameters:
    
    name - The name of the image.
  - getName
```
public String getName()
```
    The name of the image.
    
    Returns:
    
    The name of the image.
  - withName
```
public Image withName(String name)
```
    The name of the image.
    
    Parameters:
    
    name - The name of 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 of the image.
    
    Parameters:
    
    arn - The ARN of the image.
  - getArn
```
public String getArn()
```
    The ARN of the image.
    
    Returns:
    
    The ARN of the image.
  - withArn
```
public Image withArn(String arn)
```
    The ARN of the image.
    
    Parameters:
    
    arn - The ARN of the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBaseImageArn
```
public void setBaseImageArn(String baseImageArn)
```
    The ARN of the image from which this image was created.
    
    Parameters:
    
    baseImageArn - The ARN of the image from which this image was created.
  - getBaseImageArn
```
public String getBaseImageArn()
```
    The ARN of the image from which this image was created.
    
    Returns:
    
    The ARN of the image from which this image was created.
  - withBaseImageArn
```
public Image withBaseImageArn(String baseImageArn)
```
    The ARN of the image from which this image was created.
    
    Parameters:
    
    baseImageArn - The ARN of the image 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 image name to display.
    
    Parameters:
    
    displayName - The image name to display.
  - getDisplayName
```
public String getDisplayName()
```
    The image name to display.
    
    Returns:
    
    The image name to display.
  - withDisplayName
```
public Image withDisplayName(String displayName)
```
    The image name to display.
    
    Parameters:
    
    displayName - The image name to display.
    
    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. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.
    
    Parameters:
    
    state - 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
  - getState
```
public String getState()
```
    The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.
    
    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
  - withState
```
public Image withState(String state)
```
    The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.
    
    Parameters:
    
    state - The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is 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. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.
    
    Parameters:
    
    state - 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
  - withState
```
public Image withState(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.
    
    Parameters:
    
    state - The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is 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)
```
    Indicates whether the image is public or private.
    
    Parameters:
    
    visibility - Indicates whether the image is public or private.
    
    See Also:
    
    VisibilityType
  - getVisibility
```
public String getVisibility()
```
    Indicates whether the image is public or private.
    
    Returns:
    
    Indicates whether the image is public or private.
    
    See Also:
    
    VisibilityType
  - withVisibility
```
public Image withVisibility(String visibility)
```
    Indicates whether the image is public or private.
    
    Parameters:
    
    visibility - Indicates whether the image is 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)
```
    Indicates whether the image is public or private.
    
    Parameters:
    
    visibility - Indicates whether the image is public or private.
    
    See Also:
    
    VisibilityType
  - withVisibility
```
public Image withVisibility(VisibilityType visibility)
```
    Indicates whether the image is public or private.
    
    Parameters:
    
    visibility - Indicates whether the image is 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)
```
    Indicates whether an image builder can be launched from this image.
    
    Parameters:
    
    imageBuilderSupported - Indicates whether an image builder can be launched from this image.
  - getImageBuilderSupported
```
public Boolean getImageBuilderSupported()
```
    Indicates whether an image builder can be launched from this image.
    
    Returns:
    
    Indicates whether an image builder can be launched from this image.
  - withImageBuilderSupported
```
public Image withImageBuilderSupported(Boolean imageBuilderSupported)
```
    Indicates whether an image builder can be launched from this image.
    
    Parameters:
    
    imageBuilderSupported - Indicates 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()
```
    Indicates whether an image builder can be launched from this image.
    
    Returns:
    
    Indicates whether an image builder can be launched from this image.
  - setImageBuilderName
```
public void setImageBuilderName(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.
    
    Parameters:
    
    imageBuilderName - The name of the image builder that was used to create the private image. If the image is shared, this value is null.
  - getImageBuilderName
```
public String getImageBuilderName()
```
    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.
  - withImageBuilderName
```
public Image withImageBuilderName(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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)
```
    The description to display.
    
    Parameters:
    
    description - The description to display.
  - getDescription
```
public String getDescription()
```
    The description to display.
    
    Returns:
    
    The description to display.
  - withDescription
```
public Image withDescription(String description)
```
    The description to display.
    
    Parameters:
    
    description - The description to display.
    
    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 the image.
    
    Returns:
    
    The applications associated with the image.
  - setApplications
```
public void setApplications(Collection<Application> applications)
```
    The applications associated with the image.
    
    Parameters:
    
    applications - The applications associated with the image.
  - withApplications
```
public Image withApplications(Application... applications)
```
    The applications associated with the 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 the 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 the image.
    
    Parameters:
    
    applications - The applications associated with the image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedTime
```
public void setCreatedTime(Date createdTime)
```
    The time the image was created.
    
    Parameters:
    
    createdTime - The time the image was created.
  - getCreatedTime
```
public Date getCreatedTime()
```
    The time the image was created.
    
    Returns:
    
    The time the image was created.
  - withCreatedTime
```
public Image withCreatedTime(Date createdTime)
```
    The time the image was created.
    
    Parameters:
    
    createdTime - The time 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 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 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 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.
  - withPublicBaseImageReleasedDate
```
public Image withPublicBaseImageReleasedDate(Date 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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAppstreamAgentVersion
```
public void setAppstreamAgentVersion(String appstreamAgentVersion)
```
    The version of the AppStream 2.0 agent to use for instances that are launched from this image.
    
    Parameters:
    
    appstreamAgentVersion - The version of the AppStream 2.0 agent to use for instances that are launched from this image.
  - getAppstreamAgentVersion
```
public String getAppstreamAgentVersion()
```
    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.
  - withAppstreamAgentVersion
```
public Image withAppstreamAgentVersion(String appstreamAgentVersion)
```
    The version of the AppStream 2.0 agent to use for instances that are launched from this image.
    
    Parameters:
    
    appstreamAgentVersion - The version of the AppStream 2.0 agent to use for instances that are launched from this image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setImagePermissions
```
public void setImagePermissions(ImagePermissions imagePermissions)
```
    The permissions to provide to the destination AWS account for the specified image.
    
    Parameters:
    
    imagePermissions - The permissions to provide to the destination AWS account for the specified image.
  - getImagePermissions
```
public ImagePermissions getImagePermissions()
```
    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.
  - withImagePermissions
```
public Image withImagePermissions(ImagePermissions imagePermissions)
```
    The permissions to provide to the destination AWS account for the specified image.
    
    Parameters:
    
    imagePermissions - The permissions to provide to the destination AWS account for the specified image.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getImageErrors
```
public List<ResourceError> getImageErrors()
```
    Describes the errors that are returned when a new image can't be created.
    
    Returns:
    
    Describes the errors that are returned when a new image can't be created.
  - setImageErrors
```
public void setImageErrors(Collection<ResourceError> imageErrors)
```
    Describes the errors that are returned when a new image can't be created.
    
    Parameters:
    
    imageErrors - Describes the errors that are returned when a new image can't be created.
  - withImageErrors
```
public Image withImageErrors(ResourceError... imageErrors)
```
    Describes the errors that are returned when a new image can't be created.
    
    NOTE: This method appends the values to the existing list (if any). Use setImageErrors(java.util.Collection) or withImageErrors(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    imageErrors - Describes the errors that are returned when a new image can't be created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withImageErrors
```
public Image withImageErrors(Collection<ResourceError> imageErrors)
```
    Describes the errors that are returned when a new image can't be created.
    
    Parameters:
    
    imageErrors - Describes the errors that are returned when a new image can't be 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. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    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.

AWS SDK for Java 1.x API Reference - 1.12.773

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

setImageBuilderName

getImageBuilderName

withImageBuilderName

setPlatform

getPlatform

withPlatform

setPlatform

withPlatform

setDescription

getDescription

withDescription

setStateChangeReason

getStateChangeReason

withStateChangeReason

getApplications

setApplications

withApplications

withApplications

setCreatedTime

getCreatedTime

withCreatedTime

setPublicBaseImageReleasedDate

getPublicBaseImageReleasedDate

withPublicBaseImageReleasedDate

setAppstreamAgentVersion

getAppstreamAgentVersion

withAppstreamAgentVersion

setImagePermissions

getImagePermissions

withImagePermissions

getImageErrors

setImageErrors

withImageErrors

withImageErrors

toString

equals

hashCode

clone

marshall