software.amazon.awssdk.services.cloudwatchlogs.model

Interface StartQueryRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CloudWatchLogsRequest.Builder, CopyableBuilder<StartQueryRequest.Builder,StartQueryRequest>, SdkBuilder<StartQueryRequest.Builder,StartQueryRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

StartQueryRequest

public static interface StartQueryRequest.Builder
extends CloudWatchLogsRequest.Builder, SdkPojo, CopyableBuilder<StartQueryRequest.Builder,StartQueryRequest>

Method Summary

Modifier and Type	Method and Description
StartQueryRequest.Builder	endTime(Long endTime) The end of the time range to query.
StartQueryRequest.Builder	limit(Integer limit) The maximum number of log events to return in the query.
StartQueryRequest.Builder	logGroupIdentifiers(Collection<String> logGroupIdentifiers) The list of log groups to query.
StartQueryRequest.Builder	logGroupIdentifiers(String... logGroupIdentifiers) The list of log groups to query.
StartQueryRequest.Builder	logGroupName(String logGroupName) The log group on which to perform the query.
StartQueryRequest.Builder	logGroupNames(Collection<String> logGroupNames) The list of log groups to be queried.
StartQueryRequest.Builder	logGroupNames(String... logGroupNames) The list of log groups to be queried.
StartQueryRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
StartQueryRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
StartQueryRequest.Builder	queryString(String queryString) The query string to use.
StartQueryRequest.Builder	startTime(Long startTime) The beginning of the time range to query.

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

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

logGroupName

StartQueryRequest.Builder logGroupName(String logGroupName)

The log group on which to perform the query.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Parameters:

logGroupName - The log group on which to perform the query.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Returns:

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

logGroupNames

StartQueryRequest.Builder logGroupNames(Collection<String> logGroupNames)

The list of log groups to be queried. You can include up to 50 log groups.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Parameters:

logGroupNames - The list of log groups to be queried. You can include up to 50 log groups.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Returns:

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

logGroupNames

StartQueryRequest.Builder logGroupNames(String... logGroupNames)

The list of log groups to be queried. You can include up to 50 log groups.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Parameters:

logGroupNames - The list of log groups to be queried. You can include up to 50 log groups.

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Returns:

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

logGroupIdentifiers

StartQueryRequest.Builder logGroupIdentifiers(Collection<String> logGroupIdentifiers)

The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, the ARN can't end with an asterisk (*).

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Parameters:

logGroupIdentifiers - The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, the ARN can't end with an asterisk (*).

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Returns:

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

logGroupIdentifiers

StartQueryRequest.Builder logGroupIdentifiers(String... logGroupIdentifiers)

The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, the ARN can't end with an asterisk (*).

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Parameters:

logGroupIdentifiers - The list of log groups to query. You can include up to 50 log groups.

You can specify them by the log group name or ARN. If a log group that you're querying is in a source account and you're using a monitoring account, you must specify the ARN of the log group here. The query definition must also be defined in the monitoring account.

If you specify an ARN, the ARN can't end with an asterisk (*).

A StartQuery operation must include exactly one of the following parameters: logGroupName, logGroupNames, or logGroupIdentifiers.

Returns:

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

startTime

StartQueryRequest.Builder startTime(Long startTime)

The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Parameters:

startTime - The beginning of the time range to query. The range is inclusive, so the specified start time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Returns:

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

endTime

StartQueryRequest.Builder endTime(Long endTime)

The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Parameters:

endTime - The end of the time range to query. The range is inclusive, so the specified end time is included in the query. Specified as epoch time, the number of seconds since January 1, 1970, 00:00:00 UTC.

Returns:

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

queryString

StartQueryRequest.Builder queryString(String queryString)

The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

Parameters:

queryString - The query string to use. For more information, see CloudWatch Logs Insights Query Syntax.

Returns:

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

limit

StartQueryRequest.Builder limit(Integer limit)

The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.

Parameters:

limit - The maximum number of log events to return in the query. If the query string uses the fields command, only the specified fields and their values are returned. The default is 1000.

Returns:

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

overrideConfiguration

StartQueryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

StartQueryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder