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
-
Method Summary
Modifier and TypeMethodDescriptionstatic SearchIndexRequest.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
The search index name.final Integer
The maximum number of results to return per page at one time.final String
The token used to get the next set of results, ornull
if there are no additional results.final String
The search query string.final String
The query version.static Class
<? extends SearchIndexRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
indexName
The search index name.
- Returns:
- The search index name.
-
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
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
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 untilnextToken
returnsNULL
.- 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 untilnextToken
returnsNULL
.
-
queryVersion
The query version.
- Returns:
- The query version.
-
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 interfaceToCopyableBuilder<SearchIndexRequest.Builder,
SearchIndexRequest> - Specified by:
toBuilder
in classIotRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-