Class SearchResourcesRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.resourcegroups.model.ResourceGroupsRequest
-
- software.amazon.awssdk.services.resourcegroups.model.SearchResourcesRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<SearchResourcesRequest.Builder,SearchResourcesRequest>
@Generated("software.amazon.awssdk:codegen") public final class SearchResourcesRequest extends ResourceGroupsRequest implements ToCopyableBuilder<SearchResourcesRequest.Builder,SearchResourcesRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceSearchResourcesRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static SearchResourcesRequest.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()IntegermaxResults()The total number of results that you want included on each page of the response.StringnextToken()The parameter for receiving additional results if you receive aNextTokenresponse in a previous request.ResourceQueryresourceQuery()The search query, using the same formats that are supported for resource group definition.List<SdkField<?>>sdkFields()static Class<? extends SearchResourcesRequest.Builder>serializableBuilderClass()SearchResourcesRequest.BuildertoBuilder()StringtoString()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
-
resourceQuery
public final ResourceQuery resourceQuery()
The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.
- Returns:
- The search query, using the same formats that are supported for resource group definition. For more information, see CreateGroup.
-
maxResults
public final Integer maxResults()
The total 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 that is specific to the operation. If additional items exist beyond the maximum you specify, the
NextTokenresponse element is present and has a value (is not null). Include that value as theNextTokenrequest parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should checkNextTokenafter every operation to ensure that you receive all of the results.- Returns:
- The total 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 that is specific to the operation. If additional items exist
beyond the maximum you specify, the
NextTokenresponse element is present and has a value (is not null). Include that value as theNextTokenrequest parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should checkNextTokenafter 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
NextTokenresponse in a previous request. ANextTokenresponse indicates that more output is available. Set this parameter to the value provided by a previous call'sNextTokenresponse to indicate where the output should continue from.- Returns:
- The parameter for receiving additional results if you receive a
NextTokenresponse in a previous request. ANextTokenresponse indicates that more output is available. Set this parameter to the value provided by a previous call'sNextTokenresponse to indicate where the output should continue from.
-
toBuilder
public SearchResourcesRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<SearchResourcesRequest.Builder,SearchResourcesRequest>- Specified by:
toBuilderin classResourceGroupsRequest
-
builder
public static SearchResourcesRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends SearchResourcesRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
-