Package software.amazon.awssdk.services.iot.model

Class SearchIndexRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.SearchIndexRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SearchIndexRequest.Builder,SearchIndexRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SearchIndexRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SearchIndexRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	indexName()	The search index name.
Integer	maxResults()	The maximum number of results to return per page at one time.
String	nextToken()	The token used to get the next set of results, or null if there are no additional results.
String	queryString()	The search query string.
String	queryVersion()	The query version.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SearchIndexRequest.Builder>	serializableBuilderClass()
SearchIndexRequest.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

indexName

public final String indexName()

The search index name.

Returns:

The search index name.

queryString

public final String queryString()

The search query string. For more information about the search query syntax, see Query syntax.

Returns:

The search query string. For more information about the search query syntax, see Query syntax.

nextToken

public final String nextToken()

The token used to get the next set of results, or null if there are no additional results.

Returns:

The token used to get the next set of results, or null if there are no additional results.

maxResults

public final Integer maxResults()

The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use nextToken to retrieve the next set of results until nextToken returns NULL.

Returns:

The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use nextToken to retrieve the next set of results until nextToken returns NULL.

queryVersion

public final String queryVersion()

The query version.

Returns:

The query version.

toBuilder

public SearchIndexRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchIndexRequest.Builder,SearchIndexRequest>

Specified by:

toBuilder in class IotRequest

builder

public static SearchIndexRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo