Package software.amazon.awssdk.services.opensearchserverless.model

Class ListCollectionsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opensearchserverless.model.OpenSearchServerlessRequest

software.amazon.awssdk.services.opensearchserverless.model.ListCollectionsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListCollectionsRequest.Builder,ListCollectionsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListCollectionsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListCollectionsRequest.Builder	builder()
CollectionFilters	collectionFilters()	A list of filter names and values that you can use for requests.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	The maximum number of results to return.
String	nextToken()	If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.
List<SdkField<?>>	sdkFields()
static Class<? extends ListCollectionsRequest.Builder>	serializableBuilderClass()
ListCollectionsRequest.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

collectionFilters

public final CollectionFilters collectionFilters()

A list of filter names and values that you can use for requests.

Returns:

A list of filter names and values that you can use for requests.

maxResults

public final Integer maxResults()

The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

Returns:

The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

nextToken

public final String nextToken()

If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.

Returns:

If your initial ListCollections operation returns a nextToken, you can include the returned nextToken in subsequent ListCollections operations, which returns results in the next page.

toBuilder

public ListCollectionsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListCollectionsRequest.Builder,ListCollectionsRequest>

Specified by:

toBuilder in class OpenSearchServerlessRequest

builder

public static ListCollectionsRequest.Builder builder()

serializableBuilderClass

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