com.amazonaws.services.opensearchserverless.model

Class ListCollectionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.opensearchserverless.model.ListCollectionsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListCollectionsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListCollectionsRequest()

Method Summary

Modifier and Type	Method and Description
ListCollectionsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
CollectionFilters	getCollectionFilters() A list of filter names and values that you can use for requests.
Integer	getMaxResults() The maximum number of results to return.
String	getNextToken() 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.
int	hashCode()
void	setCollectionFilters(CollectionFilters collectionFilters) A list of filter names and values that you can use for requests.
void	setMaxResults(Integer maxResults) The maximum number of results to return.
void	setNextToken(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.
String	toString() Returns a string representation of this object.
ListCollectionsRequest	withCollectionFilters(CollectionFilters collectionFilters) A list of filter names and values that you can use for requests.
ListCollectionsRequest	withMaxResults(Integer maxResults) The maximum number of results to return.
ListCollectionsRequest	withNextToken(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.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListCollectionsRequest

public ListCollectionsRequest()

Method Detail

setCollectionFilters

public void setCollectionFilters(CollectionFilters collectionFilters)

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

Parameters:

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

getCollectionFilters

public CollectionFilters getCollectionFilters()

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.

withCollectionFilters

public ListCollectionsRequest withCollectionFilters(CollectionFilters collectionFilters)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(Integer maxResults)

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

Parameters:

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

getMaxResults

public Integer getMaxResults()

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.

withMaxResults

public ListCollectionsRequest withMaxResults(Integer maxResults)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(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.

Parameters:

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.

getNextToken

public String getNextToken()

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.

withNextToken

public ListCollectionsRequest withNextToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ListCollectionsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()