Interface StartSearchRequest.Builder

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

  • Method Details

    • workspaceName

      StartSearchRequest.Builder workspaceName(String workspaceName)

      The name of the workspace whose data is searched.

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

    • queryStatement

      StartSearchRequest.Builder queryStatement(String queryStatement)

      The natural-language query describing the data to search for.

      Parameters:
      queryStatement - The natural-language query describing the data to search for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      StartSearchRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier you provide to ensure the request is idempotent. Repeating a StartSearch call with the same clientToken returns the original search rather than starting a new one. If omitted, the SDK autogenerates one.

      Parameters:
      clientToken - A unique, case-sensitive identifier you provide to ensure the request is idempotent. Repeating a StartSearch call with the same clientToken returns the original search rather than starting a new one. If omitted, the SDK autogenerates one.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchType

      StartSearchRequest.Builder searchType(String searchType)

      The search strategy to use. Defaults to QUICK when omitted.

      Parameters:
      searchType - The search strategy to use. Defaults to QUICK when omitted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • searchType

      StartSearchRequest.Builder searchType(SearchType searchType)

      The search strategy to use. Defaults to QUICK when omitted.

      Parameters:
      searchType - The search strategy to use. Defaults to QUICK when omitted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • searchFilters

      StartSearchRequest.Builder searchFilters(SearchFilters searchFilters)

      Optional filters that restrict the search to a subset of the workspace's data.

      Parameters:
      searchFilters - Optional filters that restrict the search to a subset of the workspace's data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • searchFilters

      default StartSearchRequest.Builder searchFilters(Consumer<SearchFilters.Builder> searchFilters)

      Optional filters that restrict the search to a subset of the workspace's data.

      This is a convenience method that creates an instance of the SearchFilters.Builder avoiding the need to create one manually via SearchFilters.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to searchFilters(SearchFilters).

      Parameters:
      searchFilters - a consumer that will call methods on SearchFilters.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • groupId

      StartSearchRequest.Builder groupId(String groupId)

      An optional caller-supplied identifier used to group related searches together.

      Parameters:
      groupId - An optional caller-supplied identifier used to group related searches together.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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