java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.appstream.model.AppStreamRequest
    - - software.amazon.awssdk.services.appstream.model.DescribeImagesRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeImagesRequest
extends AppStreamRequest
implements ToCopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeImagesRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<String>`	`arns()`	The ARNs of the public, private, and shared images to describe.
`static DescribeImagesRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasArns()`	For responses, this returns true if the service returned a value for the Arns property.
`int`	`hashCode()`
`boolean`	`hasNames()`	For responses, this returns true if the service returned a value for the Names property.
`Integer`	`maxResults()`	The maximum size of each page of results.
`List<String>`	`names()`	The names of the public or private images to describe.
`String`	`nextToken()`	The pagination token to use to retrieve the next page of results for this operation.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeImagesRequest.Builder>`	`serializableBuilderClass()`
`DescribeImagesRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`VisibilityType`	`type()`	The type of image (public, private, or shared) to describe.
`String`	`typeAsString()`	The type of image (public, private, or shared) to describe.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

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

- Method Detail
  - hasNames
```
public final boolean hasNames()
```
    For responses, this returns true if the service returned a value for the Names property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - names
```
public final List<String> names()
```
    The names of the public or private images to describe.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNames() method.
    
    Returns:
    
    The names of the public or private images to describe.
  - hasArns
```
public final boolean hasArns()
```
    For responses, this returns true if the service returned a value for the Arns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - arns
```
public final List<String> arns()
```
    The ARNs of the public, private, and shared images to describe.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasArns() method.
    
    Returns:
    
    The ARNs of the public, private, and shared images to describe.
  - type
```
public final VisibilityType type()
```
    The type of image (public, private, or shared) to describe.
    
    If the service returns an enum value that is not available in the current SDK version, type will return VisibilityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of image (public, private, or shared) to describe.
    
    See Also:
    
    VisibilityType
  - typeAsString
```
public final String typeAsString()
```
    The type of image (public, private, or shared) to describe.
    
    If the service returns an enum value that is not available in the current SDK version, type will return VisibilityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of image (public, private, or shared) to describe.
    
    See Also:
    
    VisibilityType
  - nextToken
```
public final String nextToken()
```
    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
    
    Returns:
    
    The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
  - maxResults
```
public final Integer maxResults()
```
    The maximum size of each page of results.
    
    Returns:
    
    The maximum size of each page of results.
  - toBuilder
```
public DescribeImagesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>
    
    Specified by:
    
    toBuilder in class AppStreamRequest
  - builder
```
public static DescribeImagesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeImagesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DescribeImagesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

hasNames

names

hasArns

arns

type

typeAsString

nextToken

maxResults

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField