Interface GetSearchResultsRequest.Builder

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

  • Method Details

    • searchId

      GetSearchResultsRequest.Builder searchId(String searchId)

      The identifier of the search whose results are retrieved.

      Parameters:
      searchId - The identifier of the search whose results are retrieved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceName

      GetSearchResultsRequest.Builder workspaceName(String workspaceName)

      The name of the workspace the search belongs to.

      Parameters:
      workspaceName - The name of the workspace the search belongs to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      GetSearchResultsRequest.Builder maxResults(Integer maxResults)

      The maximum number of results to return in a single page. Valid range is 1 to 10,000; if omitted, a service-defined default is used.

      Parameters:
      maxResults - The maximum number of results to return in a single page. Valid range is 1 to 10,000; if omitted, a service-defined default is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      GetSearchResultsRequest.Builder nextToken(String nextToken)

      The pagination token returned by a previous GetSearchResults call. Provide it to retrieve the next page of results; omit it to retrieve the first page.

      Parameters:
      nextToken - The pagination token returned by a previous GetSearchResults call. Provide it to retrieve the next page of results; omit it to retrieve the first page.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetSearchResultsRequest.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

      GetSearchResultsRequest.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.