@Generated(value="software.amazon.awssdk:codegen") public final class SearchRequest extends ResourceExplorer2Request implements ToCopyableBuilder<SearchRequest.Builder,SearchRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
SearchRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static SearchRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Integer |
maxResults()
The maximum number of results that you want included on each page of the response.
|
String |
nextToken()
The parameter for receiving additional results if you receive a
NextToken response in a previous
request. |
String |
queryString()
A string that includes keywords and filters that specify the resources that you want to include in the results.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends SearchRequest.Builder> |
serializableBuilderClass() |
SearchRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
viewArn()
Specifies the Amazon
resource name (ARN) of the view to use for the query.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final Integer 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 the NextToken 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 response element is present and has a
value (is not null). Include that value as the NextToken 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.
public final String nextToken()
The parameter for receiving additional results if you receive a NextToken response in a previous
request. A NextToken response indicates that more output is available. Set this parameter to the
value of the previous call's NextToken response to indicate where the output should continue from.
NextToken response in a
previous request. A NextToken response indicates that more output is available. Set this
parameter to the value of the previous call's NextToken response to indicate where the
output should continue from.public final String queryString()
A string that includes keywords and filters that specify the resources that you want to include in the results.
For the complete syntax supported by the QueryString parameter, see Search query
syntax reference for Resource Explorer.
The search is completely case insensitive. You can specify an empty string to return all results up to the limit of 1,000 total results.
The operation can return only the first 1,000 results. If the resource you want is not included, then use a
different value for QueryString to refine the results.
For the complete syntax supported by the QueryString parameter, see Search query syntax reference for Resource Explorer.
The search is completely case insensitive. You can specify an empty string to return all results up to the limit of 1,000 total results.
The operation can return only the first 1,000 results. If the resource you want is not included, then use
a different value for QueryString to refine the results.
public final String viewArn()
Specifies the Amazon
resource name (ARN) of the view to use for the query. If you don't specify a value for this parameter, then
the operation automatically uses the default view for the Amazon Web Services Region in which you called this
operation. If the Region either doesn't have a default view or if you don't have permission to use the default
view, then the operation fails with a 401 Unauthorized exception.
401 Unauthorized
exception.public SearchRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<SearchRequest.Builder,SearchRequest>toBuilder in class ResourceExplorer2Requestpublic static SearchRequest.Builder builder()
public static Class<? extends SearchRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.