Package software.amazon.awssdk.services.resourceexplorer2.model

Class ListIndexesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.resourceexplorer2.model.ResourceExplorer2Request

software.amazon.awssdk.services.resourceexplorer2.model.ListIndexesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListIndexesRequest.Builder,ListIndexesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListIndexesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListIndexesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRegions()	For responses, this returns true if the service returned a value for the Regions property.
Integer	maxResults()	The maximum number of results that you want included on each page of the response.
String	nextToken()	The parameter for receiving additional results if you receive a NextToken response in a previous request.
List<String>	regions()	If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.
List<SdkField<?>>	sdkFields()
static Class<? extends ListIndexesRequest.Builder>	serializableBuilderClass()
ListIndexesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
IndexType	type()	If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.
String	typeAsString()	If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.

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

maxResults

public final Integer maxResults()

The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Returns:

The maximum number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value appropriate to the operation. If additional items exist beyond those included in the current response, the NextToken response element is present and has a value (is not null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results.

An API operation can return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

nextToken

public final String nextToken()

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from. The pagination tokens expire after 24 hours.

Returns:

The parameter for receiving additional results if you receive a NextToken response in a previous request. A NextToken response indicates that more output is available. Set this parameter to the value of the previous call's NextToken response to indicate where the output should continue from. The pagination tokens expire after 24 hours.

hasRegions

public final boolean hasRegions()

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

regions

public final List<String> regions()

If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.

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

Returns:

If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.

type

public final IndexType type()

If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.

Use this option to discover the aggregator index for your account.

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

Returns:

If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.

Use this option to discover the aggregator index for your account.

See Also:

IndexType

typeAsString

public final String typeAsString()

If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.

Use this option to discover the aggregator index for your account.

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

Returns:

If specified, limits the output to only indexes of the specified Type, either LOCAL or AGGREGATOR.

Use this option to discover the aggregator index for your account.

See Also:

IndexType

toBuilder

public ListIndexesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListIndexesRequest.Builder,ListIndexesRequest>

Specified by:

toBuilder in class ResourceExplorer2Request

builder

public static ListIndexesRequest.Builder builder()

serializableBuilderClass

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