software.amazon.awssdk.services.appstream.model

Class DescribeImagesRequest

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(value="software.amazon.awssdk:codegen")
public final class DescribeImagesRequest
extends AppStreamRequest
implements ToCopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeImagesRequest.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	arns() The ARNs of the public, private, and shared images to describe.
static DescribeImagesRequest.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
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.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeImagesRequest.Builder>	serializableBuilderClass()
DescribeImagesRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

names

public 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.

Returns:

The names of the public or private images to describe.

arns

public 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.

Returns:

The ARNs of the public, private, and shared images to describe.

type

public 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 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 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 Integer maxResults()

The maximum size of each page of results.

Returns:

The maximum size of each page of results.

toBuilder

public DescribeImagesRequest.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<DescribeImagesRequest.Builder,DescribeImagesRequest>

Specified by:

toBuilder in class AppStreamRequest

Returns:

a builder for type T

builder

public static DescribeImagesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeImagesRequest.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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.