software.amazon.awssdk.services.cloudwatchlogs.model

Interface GetLogEventsRequest.Builder

All Superinterfaces:

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

Enclosing class:

GetLogEventsRequest

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

Method Summary

Modifier and Type	Method and Description
GetLogEventsRequest.Builder	endTime(Long endTime) The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
GetLogEventsRequest.Builder	limit(Integer limit) The maximum number of log events returned.
GetLogEventsRequest.Builder	logGroupIdentifier(String logGroupIdentifier) Specify either the name or ARN of the log group to view events from.
GetLogEventsRequest.Builder	logGroupName(String logGroupName) The name of the log group.
GetLogEventsRequest.Builder	logStreamName(String logStreamName) The name of the log stream.
GetLogEventsRequest.Builder	nextToken(String nextToken) The token for the next set of items to return.
GetLogEventsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetLogEventsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetLogEventsRequest.Builder	startFromHead(Boolean startFromHead) If the value is true, the earliest log events are returned first.
GetLogEventsRequest.Builder	startTime(Long startTime) The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
GetLogEventsRequest.Builder	unmask(Boolean unmask) Specify true to display the log event fields with all sensitive data unmasked and visible.

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

GetLogEventsRequest.Builder logGroupName(String logGroupName)

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

Parameters:

logGroupName - The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

Returns:

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

logGroupIdentifier

GetLogEventsRequest.Builder logGroupIdentifier(String 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 or logGroupName, 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 or logGroupName, but not both.

Returns:

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

logStreamName

GetLogEventsRequest.Builder logStreamName(String 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

GetLogEventsRequest.Builder startTime(Long 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 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.

Returns:

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

endTime

GetLogEventsRequest.Builder endTime(Long 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 after Jan 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

GetLogEventsRequest.Builder nextToken(String 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

GetLogEventsRequest.Builder limit(Integer 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

GetLogEventsRequest.Builder startFromHead(Boolean 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 the nextToken in this operation, you must specify true for startFromHead.

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 the nextToken in this operation, you must specify true for startFromHead.

Returns:

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

unmask

GetLogEventsRequest.Builder unmask(Boolean unmask)

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

Parameters:

unmask - Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder