Package software.amazon.awssdk.services.cloudwatchlogs.model

Interface FilterLogEventsRequest.Builder

All Superinterfaces:

CopyableBuilder<FilterLogEventsRequest.Builder,FilterLogEventsRequest>, SdkBuilder<FilterLogEventsRequest.Builder,FilterLogEventsRequest>

Enclosing class:

FilterLogEventsRequest

public static interface FilterLogEventsRequest.Builder
extends CopyableBuilder<FilterLogEventsRequest.Builder,FilterLogEventsRequest>

Method Summary

Modifier and Type	Method	Description
FilterLogEventsRequest.Builder	endTime(Long endTime)	The end of the time range, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
FilterLogEventsRequest.Builder	filterPattern(String filterPattern)	The filter pattern to use.
FilterLogEventsRequest.Builder	interleaved(Boolean interleaved)	If the value is true, the operation makes a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response.
FilterLogEventsRequest.Builder	limit(Integer limit)	The maximum number of events to return.
FilterLogEventsRequest.Builder	logGroupName(String logGroupName)	The name of the log group.
FilterLogEventsRequest.Builder	logStreamNames(String... logStreamNames)	Optional list of log stream names.
FilterLogEventsRequest.Builder	logStreamNames(Collection<String> logStreamNames)	Optional list of log stream names.
FilterLogEventsRequest.Builder	nextToken(String nextToken)	The token for the next set of events to return.
FilterLogEventsRequest.Builder	startTime(Long startTime)	The start of the time range, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

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

FilterLogEventsRequest.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.

logStreamNames

FilterLogEventsRequest.Builder logStreamNames(Collection<String> logStreamNames)

Optional list of log stream names.

Parameters:

logStreamNames - Optional list of log stream names.

Returns:

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

logStreamNames

FilterLogEventsRequest.Builder logStreamNames(String... logStreamNames)

Optional list of log stream names.

NOTE: This method appends the values to the existing list (if any). Use #setLogStreamNames(java.util.Collection) or #withLogStreamNames(java.util.Collection) if you want to override the existing values.

Parameters:

logStreamNames - Optional list of log stream names.

Returns:

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

startTime

FilterLogEventsRequest.Builder startTime(Long startTime)

The start of the time range, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp prior to this time are not returned.

Parameters:

startTime - The start of the time range, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp prior to this time are not returned.

Returns:

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

endTime

FilterLogEventsRequest.Builder endTime(Long endTime)

The end of the time range, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.

Parameters:

endTime - The end of the time range, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. Events with a timestamp later than this time are not returned.

Returns:

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

filterPattern

FilterLogEventsRequest.Builder filterPattern(String filterPattern)

The filter pattern to use. If not provided, all the events are matched.

Parameters:

filterPattern - The filter pattern to use. If not provided, all the events are matched.

Returns:

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

nextToken

FilterLogEventsRequest.Builder nextToken(String nextToken)

The token for the next set of events to return. (You received this token from a previous call.)

Parameters:

nextToken - The token for the next set of events 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

FilterLogEventsRequest.Builder limit(Integer limit)

The maximum number of events to return. The default is 10,000 events.

Parameters:

limit - The maximum number of events to return. The default is 10,000 events.

Returns:

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

interleaved

FilterLogEventsRequest.Builder interleaved(Boolean interleaved)

If the value is true, the operation makes a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If the value is false all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. The default is false.

Parameters:

interleaved - If the value is true, the operation makes a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If the value is false all the matched log events in the first log stream are searched first, then those in the next log stream, and so on. The default is false.

Returns:

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