Interface SearchResult.Builder

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

  • Method Details

    • searchId

      SearchResult.Builder searchId(String searchId)

      The identifier of the search that produced this result.

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

    • workspaceName

      SearchResult.Builder workspaceName(String workspaceName)

      The name of the workspace the search ran against.

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

    • datasetId

      SearchResult.Builder datasetId(String datasetId)

      The identifier of the dataset that contains the matching data.

      Parameters:
      datasetId - The identifier of the dataset that contains the matching data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeSeriesId

      SearchResult.Builder timeSeriesId(String timeSeriesId)

      The identifier of the time series that contains the matching data.

      Parameters:
      timeSeriesId - The identifier of the time series that contains the matching data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTimestamp

      SearchResult.Builder startTimestamp(TimeInNanos startTimestamp)

      The start of the matching time-series segment, in nanoseconds since the Unix epoch.

      Parameters:
      startTimestamp - The start of the matching time-series segment, in nanoseconds since the Unix epoch.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTimestamp

      default SearchResult.Builder startTimestamp(Consumer<TimeInNanos.Builder> startTimestamp)

      The start of the matching time-series segment, in nanoseconds since the Unix epoch.

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

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

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

    • endTimestamp

      SearchResult.Builder endTimestamp(TimeInNanos endTimestamp)

      The end of the matching time-series segment, in nanoseconds since the Unix epoch.

      Parameters:
      endTimestamp - The end of the matching time-series segment, in nanoseconds since the Unix epoch.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTimestamp

      default SearchResult.Builder endTimestamp(Consumer<TimeInNanos.Builder> endTimestamp)

      The end of the matching time-series segment, in nanoseconds since the Unix epoch.

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

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

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

    • topTimestamp

      SearchResult.Builder topTimestamp(TimeInNanos topTimestamp)

      The timestamp of the most relevant point within the matching segment, in nanoseconds since the Unix epoch.

      Parameters:
      topTimestamp - The timestamp of the most relevant point within the matching segment, in nanoseconds since the Unix epoch.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • topTimestamp

      default SearchResult.Builder topTimestamp(Consumer<TimeInNanos.Builder> topTimestamp)

      The timestamp of the most relevant point within the matching segment, in nanoseconds since the Unix epoch.

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

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

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

    • score

      SearchResult.Builder score(Float score)

      The relevance score of this result. Higher scores indicate a stronger match.

      Parameters:
      score - The relevance score of this result. Higher scores indicate a stronger match.
      Returns:
      Returns a reference to this object so that method calls can be chained together.