software.amazon.awssdk.services.cloudwatchlogs.model

Interface GetLogEventsRequest.Builder

All Superinterfaces:

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

Enclosing class:

GetLogEventsRequest

public static interface GetLogEventsRequest.Builder
extends CloudWatchLogsRequest.Builder, 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	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	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
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.

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

build

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

requestOverrideConfig, requestOverrideConfig

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

copy

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

apply, build

Method Detail

logGroupName

GetLogEventsRequest.Builder logGroupName(String logGroupName)

The name of the log group.

Parameters:

logGroupName - The name of the log group.

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 time stamp 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 time stamp 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 time stamp 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 time stamp 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 value, the maximum 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 value, the maximum 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.

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.

Returns:

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

requestOverrideConfig

GetLogEventsRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.