DescribeImagesRequest (AWS Java SDK for Amazon AppStream 1.11.415 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.appstream.model.DescribeImagesRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeImagesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

DescribeImagesRequest()

Constructors
Constructor and Description
`DescribeImagesRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeImagesRequest`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getArns()` The ARNs of the public, private, and shared images to describe.
`Integer`	`getMaxResults()` The maximum size of each page of results.
`List<String>`	`getNames()` The names of the public or private images to describe.
`String`	`getNextToken()` The pagination token to use to retrieve the next page of results.
`String`	`getType()` The type of image (public, private, or shared) to describe.
`int`	`hashCode()`
`void`	`setArns(Collection<String> arns)` The ARNs of the public, private, and shared images to describe.
`void`	`setMaxResults(Integer maxResults)` The maximum size of each page of results.
`void`	`setNames(Collection<String> names)` The names of the public or private images to describe.
`void`	`setNextToken(String nextToken)` The pagination token to use to retrieve the next page of results.
`void`	`setType(String type)` The type of image (public, private, or shared) to describe.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeImagesRequest`	`withArns(Collection<String> arns)` The ARNs of the public, private, and shared images to describe.
`DescribeImagesRequest`	`withArns(String... arns)` The ARNs of the public, private, and shared images to describe.
`DescribeImagesRequest`	`withMaxResults(Integer maxResults)` The maximum size of each page of results.
`DescribeImagesRequest`	`withNames(Collection<String> names)` The names of the public or private images to describe.
`DescribeImagesRequest`	`withNames(String... names)` The names of the public or private images to describe.
`DescribeImagesRequest`	`withNextToken(String nextToken)` The pagination token to use to retrieve the next page of results.
`DescribeImagesRequest`	`withType(String type)` The type of image (public, private, or shared) to describe.
`DescribeImagesRequest`	`withType(VisibilityType type)` The type of image (public, private, or shared) to describe.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeImagesRequest
```
public DescribeImagesRequest()
```
- Method Detail
  - getNames
```
public List<String> getNames()
```
    The names of the public or private images to describe.
    
    Returns:
    
    The names of the public or private images to describe.
  - setNames
```
public void setNames(Collection<String> names)
```
    The names of the public or private images to describe.
    
    Parameters:
    
    names - The names of the public or private images to describe.
  - withNames
```
public DescribeImagesRequest withNames(String... names)
```
    The names of the public or private images to describe.
    
    NOTE: This method appends the values to the existing list (if any). Use setNames(java.util.Collection) or withNames(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    names - The names of the public or private images to describe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNames
```
public DescribeImagesRequest withNames(Collection<String> names)
```
    The names of the public or private images to describe.
    
    Parameters:
    
    names - The names of the public or private images to describe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getArns
```
public List<String> getArns()
```
    The ARNs of the public, private, and shared images to describe.
    
    Returns:
    
    The ARNs of the public, private, and shared images to describe.
  - setArns
```
public void setArns(Collection<String> arns)
```
    The ARNs of the public, private, and shared images to describe.
    
    Parameters:
    
    arns - The ARNs of the public, private, and shared images to describe.
  - withArns
```
public DescribeImagesRequest withArns(String... arns)
```
    The ARNs of the public, private, and shared images to describe.
    
    NOTE: This method appends the values to the existing list (if any). Use setArns(java.util.Collection) or withArns(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    arns - The ARNs of the public, private, and shared images to describe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withArns
```
public DescribeImagesRequest withArns(Collection<String> arns)
```
    The ARNs of the public, private, and shared images to describe.
    
    Parameters:
    
    arns - The ARNs of the public, private, and shared images to describe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of image (public, private, or shared) to describe.
    
    Parameters:
    
    type - The type of image (public, private, or shared) to describe.
    
    See Also:
    
    VisibilityType
  - getType
```
public String getType()
```
    The type of image (public, private, or shared) to describe.
    
    Returns:
    
    The type of image (public, private, or shared) to describe.
    
    See Also:
    
    VisibilityType
  - withType
```
public DescribeImagesRequest withType(String type)
```
    The type of image (public, private, or shared) to describe.
    
    Parameters:
    
    type - The type of image (public, private, or shared) to describe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VisibilityType
  - withType
```
public DescribeImagesRequest withType(VisibilityType type)
```
    The type of image (public, private, or shared) to describe.
    
    Parameters:
    
    type - The type of image (public, private, or shared) to describe.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VisibilityType
  - setNextToken
```
public void setNextToken(String nextToken)
```
    The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.
    
    Parameters:
    
    nextToken - The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.
  - getNextToken
```
public String getNextToken()
```
    The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.
    
    Returns:
    
    The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.
  - withNextToken
```
public DescribeImagesRequest withNextToken(String nextToken)
```
    The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.
    
    Parameters:
    
    nextToken - The pagination token to use to retrieve the next page of results. If this value is empty, only the first page is retrieved.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMaxResults
```
public void setMaxResults(Integer maxResults)
```
    The maximum size of each page of results.
    
    Parameters:
    
    maxResults - The maximum size of each page of results.
  - getMaxResults
```
public Integer getMaxResults()
```
    The maximum size of each page of results.
    
    Returns:
    
    The maximum size of each page of results.
  - withMaxResults
```
public DescribeImagesRequest withMaxResults(Integer maxResults)
```
    The maximum size of each page of results.
    
    Parameters:
    
    maxResults - The maximum size of each page of results.
    
    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 DescribeImagesRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class DescribeImagesRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeImagesRequest

Method Detail

getNames

setNames

withNames

withNames

getArns

setArns

withArns

withArns

setType

getType

withType

withType

setNextToken

getNextToken

withNextToken

setMaxResults

getMaxResults

withMaxResults

toString

equals

hashCode

clone