Package software.amazon.awssdk.services.imagebuilder.model

Class ListImagesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.imagebuilder.model.ImagebuilderRequest

software.amazon.awssdk.services.imagebuilder.model.ListImagesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListImagesRequest.Builder,ListImagesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListImagesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListImagesRequest.Builder	builder()
Boolean	byName()	Requests a list of images with a specific recipe name.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Filter>	filters()	Use the following filters to streamline results:
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasFilters()	For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
Boolean	includeDeprecated()	Includes deprecated images in the response list.
Integer	maxResults()	The maximum items to return in a request.
String	nextToken()	A token to specify where to start paginating.
Ownership	owner()	The owner defines which images you want to list.
String	ownerAsString()	The owner defines which images you want to list.
List<SdkField<?>>	sdkFields()
static Class<? extends ListImagesRequest.Builder>	serializableBuilderClass()
ListImagesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

owner

public final Ownership owner()

The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

If the service returns an enum value that is not available in the current SDK version, owner will return Ownership.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ownerAsString().

Returns:

The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

See Also:

Ownership

ownerAsString

public final String ownerAsString()

The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

If the service returns an enum value that is not available in the current SDK version, owner will return Ownership.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from ownerAsString().

Returns:

The owner defines which images you want to list. By default, this request will only show images owned by your account. You can use this field to specify if you want to view images owned by yourself, by Amazon, or those images that have been shared with you by other customers.

See Also:

Ownership

hasFilters

public final boolean hasFilters()

For responses, this returns true if the service returned a value for the Filters 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.

filters

public final List<Filter> filters()

Use the following filters to streamline results:

• name

• osVersion

• platform

• type

• version

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 hasFilters() method.

Returns:

Use the following filters to streamline results:

• name

• osVersion

• platform

• type

• version

byName

public final Boolean byName()

Requests a list of images with a specific recipe name.

Returns:

Requests a list of images with a specific recipe name.

maxResults

public final Integer maxResults()

The maximum items to return in a request.

Returns:

The maximum items to return in a request.

nextToken

public final String nextToken()

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

Returns:

A token to specify where to start paginating. This is the nextToken from a previously truncated response.

includeDeprecated

public final Boolean includeDeprecated()

Includes deprecated images in the response list.

Returns:

Includes deprecated images in the response list.

toBuilder

public ListImagesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListImagesRequest.Builder,ListImagesRequest>

Specified by:

toBuilder in class ImagebuilderRequest

builder

public static ListImagesRequest.Builder builder()

serializableBuilderClass

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