Class ListIndexesRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListIndexesRequest.Builder,
ListIndexesRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ListIndexesRequest.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 boolean
For responses, this returns true if the service returned a value for the Regions property.final Integer
The maximum number of results that you want included on each page of the response.final String
The parameter for receiving additional results if you receive aNextToken
response in a previous request.regions()
If specified, limits the response to only information about the index in the specified list of Amazon Web Services Regions.static Class
<? extends ListIndexesRequest.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.final IndexType
type()
If specified, limits the output to only indexes of the specified Type, eitherLOCAL
orAGGREGATOR
.final String
If specified, limits the output to only indexes of the specified Type, eitherLOCAL
orAGGREGATOR
.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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 theNextToken
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 theNextToken
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
The parameter for receiving additional results if you receive a
NextToken
response in a previous request. ANextToken
response indicates that more output is available. Set this parameter to the value of the previous call'sNextToken
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. ANextToken
response indicates that more output is available. Set this parameter to the value of the previous call'sNextToken
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 theisEmpty()
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
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
If specified, limits the output to only indexes of the specified Type, either
LOCAL
orAGGREGATOR
.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 returnIndexType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- If specified, limits the output to only indexes of the specified Type, either
LOCAL
orAGGREGATOR
.Use this option to discover the aggregator index for your account.
- See Also:
-
typeAsString
If specified, limits the output to only indexes of the specified Type, either
LOCAL
orAGGREGATOR
.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 returnIndexType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- Returns:
- If specified, limits the output to only indexes of the specified Type, either
LOCAL
orAGGREGATOR
.Use this option to discover the aggregator index for your account.
- See Also:
-
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<ListIndexesRequest.Builder,
ListIndexesRequest> - Specified by:
toBuilder
in classResourceExplorer2Request
- 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
-