Interface DescribeQueryResponse.Builder

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

  • Method Details

    • queryId

      DescribeQueryResponse.Builder queryId(String queryId)

      The ID of the query.

      Parameters:
      queryId - The ID of the query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryString

      DescribeQueryResponse.Builder queryString(String queryString)

      The SQL code of a query.

      Parameters:
      queryString - The SQL code of a query.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryStatus

      DescribeQueryResponse.Builder queryStatus(String queryStatus)

      The status of a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED

      Parameters:
      queryStatus - The status of a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • queryStatus

      DescribeQueryResponse.Builder queryStatus(QueryStatus queryStatus)

      The status of a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED

      Parameters:
      queryStatus - The status of a query. Values for QueryStatus include QUEUED, RUNNING, FINISHED, FAILED, TIMED_OUT, or CANCELLED
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • queryStatistics

      DescribeQueryResponse.Builder queryStatistics(QueryStatisticsForDescribeQuery queryStatistics)

      Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.

      Parameters:
      queryStatistics - Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • queryStatistics

      default DescribeQueryResponse.Builder queryStatistics(Consumer<QueryStatisticsForDescribeQuery.Builder> queryStatistics)

      Metadata about a query, including the number of events that were matched, the total number of events scanned, the query run time in milliseconds, and the query's creation time.

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

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

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

    • errorMessage

      DescribeQueryResponse.Builder errorMessage(String errorMessage)

      The error message returned if a query failed.

      Parameters:
      errorMessage - The error message returned if a query failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deliveryS3Uri

      DescribeQueryResponse.Builder deliveryS3Uri(String deliveryS3Uri)

      The URI for the S3 bucket where CloudTrail delivered query results, if applicable.

      Parameters:
      deliveryS3Uri - The URI for the S3 bucket where CloudTrail delivered query results, if applicable.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deliveryStatus

      DescribeQueryResponse.Builder deliveryStatus(String deliveryStatus)

      The delivery status.

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

    • deliveryStatus

      DescribeQueryResponse.Builder deliveryStatus(DeliveryStatus deliveryStatus)

      The delivery status.

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

    • prompt

      DescribeQueryResponse.Builder prompt(String prompt)

      The prompt used for a generated query. For information about generated queries, see Create CloudTrail Lake queries from natural language prompts in the CloudTrail user guide.

      Parameters:
      prompt - The prompt used for a generated query. For information about generated queries, see Create CloudTrail Lake queries from natural language prompts in the CloudTrail user guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventDataStoreOwnerAccountId

      DescribeQueryResponse.Builder eventDataStoreOwnerAccountId(String eventDataStoreOwnerAccountId)

      The account ID of the event data store owner.

      Parameters:
      eventDataStoreOwnerAccountId - The account ID of the event data store owner.
      Returns:
      Returns a reference to this object so that method calls can be chained together.