software.amazon.awssdk.services.cloudwatchlogs.model

Class FilterLogEventsRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.cloudwatchlogs.model.FilterLogEventsRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, software.amazon.awssdk.utils.builder.ToCopyableBuilder<FilterLogEventsRequest.Builder,FilterLogEventsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class FilterLogEventsRequest
extends AmazonWebServiceRequest
implements software.amazon.awssdk.utils.builder.ToCopyableBuilder<FilterLogEventsRequest.Builder,FilterLogEventsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FilterLogEventsRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method and Description
static FilterLogEventsRequest.Builder	builder()
Long	endTime() The end of the time range, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
boolean	equals(Object obj)
String	filterPattern() The filter pattern to use.
int	hashCode()
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.
Integer	limit() The maximum number of events to return.
String	logGroupName() The name of the log group.
List<String>	logStreamNames() Optional list of log stream names.
String	nextToken() The token for the next set of events to return.
static Class<? extends FilterLogEventsRequest.Builder>	serializableBuilderClass()
Long	startTime() The start of the time range, expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
FilterLogEventsRequest.Builder	toBuilder()
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

logGroupName

public String logGroupName()

The name of the log group.

Returns:

The name of the log group.

logStreamNames

public List<String> logStreamNames()

Optional list of log stream names.

Returns:

Optional list of log stream names.

startTime

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

Returns:

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.

endTime

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

Returns:

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.

filterPattern

public String filterPattern()

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

Returns:

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

nextToken

public String nextToken()

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

Returns:

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

limit

public Integer limit()

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

Returns:

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

interleaved

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

Returns:

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.

toBuilder

public FilterLogEventsRequest.Builder toBuilder()

Specified by:

toBuilder in interface software.amazon.awssdk.utils.builder.ToCopyableBuilder<FilterLogEventsRequest.Builder,FilterLogEventsRequest>

builder

public static FilterLogEventsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends FilterLogEventsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object