@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SearchRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
SearchRequest() |
| Modifier and Type | Method and Description |
|---|---|
SearchRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Integer |
getMaxResults()
The maximum number of results that you want included on each page of the response.
|
String |
getNextToken()
The parameter for receiving additional results if you receive a
NextToken response in a previous
request. |
String |
getQueryString()
A string that includes keywords and filters that specify the resources that you want to include in the results.
|
String |
getViewArn()
Specifies the Amazon
resource name (ARN) of the view to use for the query.
|
int |
hashCode() |
void |
setMaxResults(Integer maxResults)
The maximum number of results that you want included on each page of the response.
|
void |
setNextToken(String nextToken)
The parameter for receiving additional results if you receive a
NextToken response in a previous
request. |
void |
setQueryString(String queryString)
A string that includes keywords and filters that specify the resources that you want to include in the results.
|
void |
setViewArn(String viewArn)
Specifies the Amazon
resource name (ARN) of the view to use for the query.
|
String |
toString()
Returns a string representation of this object.
|
SearchRequest |
withMaxResults(Integer maxResults)
The maximum number of results that you want included on each page of the response.
|
SearchRequest |
withNextToken(String nextToken)
The parameter for receiving additional results if you receive a
NextToken response in a previous
request. |
SearchRequest |
withQueryString(String queryString)
A string that includes keywords and filters that specify the resources that you want to include in the results.
|
SearchRequest |
withViewArn(String viewArn)
Specifies the Amazon
resource name (ARN) of the view to use for the query.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setMaxResults(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.
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.
public Integer getMaxResults()
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 SearchRequest withMaxResults(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.
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.
public void setNextToken(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.
The pagination tokens expire after 24 hours.
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. The pagination tokens expire after 24 hours.public String getNextToken()
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.
The pagination tokens expire after 24 hours.
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. The pagination tokens expire after 24 hours.public SearchRequest withNextToken(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.
The pagination tokens expire after 24 hours.
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. The pagination tokens expire after 24 hours.public void setQueryString(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.
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.
public String getQueryString()
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 SearchRequest withQueryString(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.
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.
public void setViewArn(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.
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.public String getViewArn()
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 withViewArn(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.
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.public String toString()
toString in class ObjectObject.toString()public SearchRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()