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)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasArns() Returns true if the Arns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
boolean	hasNames() Returns true if the Names property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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()
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()

Returns true if the Names property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasNames() to see if a value was sent in this field.

Returns:

The names of the public or private images to describe.

hasArns

public final boolean hasArns()

Returns true if the Arns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

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.

You can use hasArns() to see if a value was sent in this field.

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