Interface StartQueryRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CloudWatchLogsRequest.Builder
,CopyableBuilder<StartQueryRequest.Builder,
,StartQueryRequest> SdkBuilder<StartQueryRequest.Builder,
,StartQueryRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
StartQueryRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe end of the time range to query.The maximum number of log events to return in the query.logGroupIdentifiers
(String... logGroupIdentifiers) The list of log groups to query.logGroupIdentifiers
(Collection<String> logGroupIdentifiers) The list of log groups to query.logGroupName
(String logGroupName) The log group on which to perform the query.logGroupNames
(String... logGroupNames) The list of log groups to be queried.logGroupNames
(Collection<String> logGroupNames) The list of log groups to be queried.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.queryString
(String queryString) The query string to use.The beginning of the time range to query.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest.Builder
build
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, sdkFields
-
Method Details
-
logGroupName
The log group on which to perform the query.
A
StartQuery
operation must include exactly one of the following parameters:logGroupName
,logGroupNames
, orlogGroupIdentifiers
.- Parameters:
logGroupName
- The log group on which to perform the query.A
StartQuery
operation must include exactly one of the following parameters:logGroupName
,logGroupNames
, orlogGroupIdentifiers
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
, orlogGroupIdentifiers
.- 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
, orlogGroupIdentifiers
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
, orlogGroupIdentifiers
.- 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
, orlogGroupIdentifiers
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
, orlogGroupIdentifiers
.- 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
, orlogGroupIdentifiers
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
, orlogGroupIdentifiers
.- 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
, orlogGroupIdentifiers
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 sinceJanuary 1, 1970, 00:00:00 UTC
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 sinceJanuary 1, 1970, 00:00:00 UTC
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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
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 thefields
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) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
StartQueryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-