software.amazon.awssdk.services.imagebuilder.model

Class ListComponentsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListComponentsRequest.Builder,ListComponentsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListComponentsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListComponentsRequest.Builder	builder()
Boolean	byName() Returns the list of component build versions for the specified name.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
List<Filter>	filters() Use the following filters to streamline results:
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
boolean	hasFilters() For responses, this returns true if the service returned a value for the Filters property.
int	hashCode()
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 components you want to list.
String	ownerAsString() The owner defines which components you want to list.
List<SdkField<?>>	sdkFields()
static Class<? extends ListComponentsRequest.Builder>	serializableBuilderClass()
ListComponentsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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

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 components you want to list. By default, this request will only show components owned by your account. You can use this field to specify if you want to view components owned by yourself, by Amazon, or those components 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 components you want to list. By default, this request will only show components owned by your account. You can use this field to specify if you want to view components owned by yourself, by Amazon, or those components that have been shared with you by other customers.

See Also:

Ownership

ownerAsString

public final String ownerAsString()

The owner defines which components you want to list. By default, this request will only show components owned by your account. You can use this field to specify if you want to view components owned by yourself, by Amazon, or those components 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 components you want to list. By default, this request will only show components owned by your account. You can use this field to specify if you want to view components owned by yourself, by Amazon, or those components 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:

• description

• name

• platform

• supportedOsVersion

• 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:

• description

• name

• platform

• supportedOsVersion

• type

• version

byName

public final Boolean byName()

Returns the list of component build versions for the specified name.

Returns:

Returns the list of component build versions for the specified 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.

toBuilder

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

Specified by:

toBuilder in class ImagebuilderRequest

Returns:

a builder for type T

builder

public static ListComponentsRequest.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

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