Interface DescribeQueryResponse.Builder

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

  • Method Details

    • queryId

      DescribeQueryResponse.Builder queryId(String queryId)

      The unique identifier for the query execution.

      Parameters:
      queryId - The unique identifier for the query execution.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      DescribeQueryResponse.Builder status(String status)

      The current query status.

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

    • status

      DescribeQueryResponse.Builder status(QueryStatus status)

      The current query status.

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

    • submittedAt

      DescribeQueryResponse.Builder submittedAt(Instant submittedAt)

      The date and time when the query was submitted, in Unix epoch time.

      Parameters:
      submittedAt - The date and time when the query was submitted, in Unix epoch time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • completedAt

      DescribeQueryResponse.Builder completedAt(Instant completedAt)

      The date and time when the query reached a terminal state, in Unix epoch time. This field is present when the query status is COMPLETED, FAILED, or CANCELED.

      Parameters:
      completedAt - The date and time when the query reached a terminal state, in Unix epoch time. This field is present when the query status is COMPLETED, FAILED, or CANCELED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statistics

      DescribeQueryResponse.Builder statistics(QueryStatistics statistics)

      The query execution statistics. This field is present when the query status is COMPLETED.

      Parameters:
      statistics - The query execution statistics. This field is present when the query status is COMPLETED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statistics

      default DescribeQueryResponse.Builder statistics(Consumer<QueryStatistics.Builder> statistics)

      The query execution statistics. This field is present when the query status is COMPLETED.

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

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

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

    • errorMessage

      DescribeQueryResponse.Builder errorMessage(String errorMessage)

      A human-readable error description. This field is present when the query status is FAILED.

      Parameters:
      errorMessage - A human-readable error description. This field is present when the query status is FAILED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.