Interface SearchSummary.Builder

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

  • Method Details

    • searchId

      SearchSummary.Builder searchId(String searchId)

      The unique identifier of the search.

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

    • workspaceName

      SearchSummary.Builder workspaceName(String workspaceName)

      The name of the workspace the search runs against.

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

    • status

      SearchSummary.Builder status(String status)

      The current status of the search.

      Parameters:
      status - The current status of the search.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      SearchSummary.Builder status(SearchStatus status)

      The current status of the search.

      Parameters:
      status - The current status of the search.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • queryStatement

      SearchSummary.Builder queryStatement(String queryStatement)

      The natural-language query that was submitted for the search.

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

    • searchType

      SearchSummary.Builder searchType(String searchType)

      The search strategy used for the search.

      Parameters:
      searchType - The search strategy used for the search.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • searchType

      SearchSummary.Builder searchType(SearchType searchType)

      The search strategy used for the search.

      Parameters:
      searchType - The search strategy used for the search.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusReason

      SearchSummary.Builder statusReason(String statusReason)

      A human-readable explanation of the current status. Populated when the search has FAILED.

      Parameters:
      statusReason - A human-readable explanation of the current status. Populated when the search has FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startedAt

      SearchSummary.Builder startedAt(Instant startedAt)

      The time at which the search was started.

      Parameters:
      startedAt - The time at which the search was started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupId

      SearchSummary.Builder groupId(String groupId)

      The group identifier associated with the search, if one was supplied on the request.

      Parameters:
      groupId - The group identifier associated with the search, if one was supplied on the request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.