Interface SearchRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<SearchRequest.Builder,SearchRequest>, ResourceExplorer2Request.Builder, SdkBuilder<SearchRequest.Builder,SearchRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
SearchRequest
@Mutable @NotThreadSafe public static interface SearchRequest.Builder extends ResourceExplorer2Request.Builder, SdkPojo, CopyableBuilder<SearchRequest.Builder,SearchRequest>

  • Method Details

    • maxResults

      SearchRequest.Builder maxResults(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      SearchRequest.Builder nextToken(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryString

      SearchRequest.Builder queryString(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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • viewArn

      SearchRequest.Builder viewArn(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      SearchRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      SearchRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.