Package software.amazon.awssdk.services.cloudwatchlogs.model

Interface GetQueryResultsResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CloudWatchLogsResponse.Builder, CopyableBuilder<GetQueryResultsResponse.Builder,GetQueryResultsResponse>, SdkBuilder<GetQueryResultsResponse.Builder,GetQueryResultsResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetQueryResultsResponse

public static interface GetQueryResultsResponse.Builder
extends CloudWatchLogsResponse.Builder, SdkPojo, CopyableBuilder<GetQueryResultsResponse.Builder,GetQueryResultsResponse>

Method Summary

Modifier and Type	Method	Description
GetQueryResultsResponse.Builder	encryptionKey(String encryptionKey)	If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays the ARN of the key that's used to encrypt the query results when StartQuery stores them.
GetQueryResultsResponse.Builder	results(Collection<? extends Collection<ResultField>> results)	The log events that matched the query criteria during the most recent time it ran.
GetQueryResultsResponse.Builder	results(Collection<ResultField>... results)	The log events that matched the query criteria during the most recent time it ran.
default GetQueryResultsResponse.Builder	statistics(Consumer<QueryStatistics.Builder> statistics)	Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the scanned log events.
GetQueryResultsResponse.Builder	statistics(QueryStatistics statistics)	Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the scanned log events.
GetQueryResultsResponse.Builder	status(String status)	The status of the most recent running of the query.
GetQueryResultsResponse.Builder	status(QueryStatus status)	The status of the most recent running of the query.

Methods inherited from interface software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

results

GetQueryResultsResponse.Builder results(Collection<? extends Collection<ResultField>> results)

The log events that matched the query criteria during the most recent time it ran.

The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field/value pairs.

Parameters:

results - The log events that matched the query criteria during the most recent time it ran.

The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field/value pairs.

Returns:

Returns a reference to this object so that method calls can be chained together.

results

GetQueryResultsResponse.Builder results(Collection<ResultField>... results)

The log events that matched the query criteria during the most recent time it ran.

The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field/value pairs.

Parameters:

results - The log events that matched the query criteria during the most recent time it ran.

The results value is an array of arrays. Each log event is one object in the top-level array. Each of these log event objects is an array of field/value pairs.

Returns:

Returns a reference to this object so that method calls can be chained together.

statistics

GetQueryResultsResponse.Builder statistics(QueryStatistics statistics)

Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the scanned log events. These values reflect the full raw results of the query.

Parameters:

statistics - Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the scanned log events. These values reflect the full raw results of the query.

Returns:

Returns a reference to this object so that method calls can be chained together.

statistics

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

Includes the number of log events scanned by the query, the number of log events that matched the query criteria, and the total number of bytes in the scanned log events. These values reflect the full raw results of the query.

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:

statistics(QueryStatistics)

status

GetQueryResultsResponse.Builder status(String status)

The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown.

Queries time out after 60 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.

Parameters:

status - The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown.

Queries time out after 60 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

QueryStatus, QueryStatus

status

GetQueryResultsResponse.Builder status(QueryStatus status)

The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown.

Queries time out after 60 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.

Parameters:

status - The status of the most recent running of the query. Possible values are Cancelled, Complete, Failed, Running, Scheduled, Timeout, and Unknown.

Queries time out after 60 minutes of runtime. To avoid having your queries time out, reduce the time range being searched or partition your query into a number of queries.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

QueryStatus, QueryStatus

encryptionKey

GetQueryResultsResponse.Builder encryptionKey(String encryptionKey)

If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays the ARN of the key that's used to encrypt the query results when StartQuery stores them.

Parameters:

encryptionKey - If you associated an KMS key with the CloudWatch Logs Insights query results in this account, this field displays the ARN of the key that's used to encrypt the query results when StartQuery stores them.

Returns:

Returns a reference to this object so that method calls can be chained together.