Interface GetLogEventsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CloudWatchLogsRequest.Builder
,CopyableBuilder<GetLogEventsRequest.Builder,
,GetLogEventsRequest> SdkBuilder<GetLogEventsRequest.Builder,
,GetLogEventsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
GetLogEventsRequest
-
Method Summary
Modifier and TypeMethodDescriptionThe end of the time range, expressed as the number of milliseconds afterJan 1, 1970 00:00:00 UTC
.The maximum number of log events returned.logGroupIdentifier
(String logGroupIdentifier) Specify either the name or ARN of the log group to view events from.logGroupName
(String logGroupName) The name of the log group.logStreamName
(String logStreamName) The name of the log stream.The token for the next set of items to return.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.startFromHead
(Boolean startFromHead) If the value is true, the earliest log events are returned first.The start of the time range, expressed as the number of milliseconds afterJan 1, 1970 00:00:00 UTC
.Specifytrue
to display the log event fields with all sensitive data unmasked and visible.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 name of the log group.
You must include either
logGroupIdentifier
orlogGroupName
, but not both.- Parameters:
logGroupName
- The name of the log group.You must include either
logGroupIdentifier
orlogGroupName
, but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logGroupIdentifier
Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.
You must include either
logGroupIdentifier
orlogGroupName
, but not both.- Parameters:
logGroupIdentifier
- Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.You must include either
logGroupIdentifier
orlogGroupName
, but not both.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
logStreamName
The name of the log stream.
- Parameters:
logStreamName
- The name of the log stream.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startTime
The start of the time range, expressed as the number of milliseconds after
Jan 1, 1970 00:00:00 UTC
. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.- Parameters:
startTime
- The start of the time range, expressed as the number of milliseconds afterJan 1, 1970 00:00:00 UTC
. Events with a timestamp equal to this time or later than this time are included. Events with a timestamp earlier than this time are not included.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
endTime
The end of the time range, expressed as the number of milliseconds after
Jan 1, 1970 00:00:00 UTC
. Events with a timestamp equal to or later than this time are not included.- Parameters:
endTime
- The end of the time range, expressed as the number of milliseconds afterJan 1, 1970 00:00:00 UTC
. Events with a timestamp equal to or later than this time are not included.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
The token for the next set of items to return. (You received this token from a previous call.)
- Parameters:
nextToken
- The token for the next set of items to return. (You received this token from a previous call.)- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
limit
The maximum number of log events returned. If you don't specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events).
- Parameters:
limit
- The maximum number of log events returned. If you don't specify a limit, the default is as many log events as can fit in a response size of 1 MB (up to 10,000 log events).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
startFromHead
If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.
If you are using a previous
nextForwardToken
value as thenextToken
in this operation, you must specifytrue
forstartFromHead
.- Parameters:
startFromHead
- If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.If you are using a previous
nextForwardToken
value as thenextToken
in this operation, you must specifytrue
forstartFromHead
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
unmask
Specify
true
to display the log event fields with all sensitive data unmasked and visible. The default isfalse
.To use this operation with this parameter, you must be signed into an account with the
logs:Unmask
permission.- Parameters:
unmask
- Specifytrue
to display the log event fields with all sensitive data unmasked and visible. The default isfalse
.To use this operation with this parameter, you must be signed into an account with the
logs:Unmask
permission.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
GetLogEventsRequest.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
GetLogEventsRequest.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.
-