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(value="software.amazon.awssdk:codegen")
public final class SearchIndexRequest
extends IotRequest
implements ToCopyableBuilder<SearchIndexRequest.Builder,SearchIndexRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchIndexRequest.Builder

Method Summary

Modifier and Type	Method and Description
static SearchIndexRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	indexName() The search index name.
Integer	maxResults() The maximum number of results to return 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.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchIndexRequest.Builder>	serializableBuilderClass()
SearchIndexRequest.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

indexName

public String indexName()

The search index name.

Returns:

The search index name.

queryString

public String queryString()

The search query string.

Returns:

The search query string.

nextToken

public 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 Integer maxResults()

The maximum number of results to return at one time.

Returns:

The maximum number of results to return at one time.

queryVersion

public String queryVersion()

The query version.

Returns:

The query version.

toBuilder

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

Specified by:

toBuilder in class IotRequest

Returns:

a builder for type T

builder

public static SearchIndexRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SearchIndexRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

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