software.amazon.awssdk.services.cloudwatchlogs.model

Class FilterLogEventsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<FilterLogEventsRequest.Builder,FilterLogEventsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FilterLogEventsRequest.Builder

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 after Jan 1, 1970 00:00:00 UTC.
boolean	equals(Object obj)
String	filterPattern() The filter pattern to use.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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 to search.
String	logStreamNamePrefix() Filters the results to include only events from log streams that have names starting with this prefix.
List<String>	logStreamNames() Filters the results to only logs from the log streams in this list.
String	nextToken() The token for the next set of events to return.
List<SdkField<?>>	sdkFields()
static Class<? extends FilterLogEventsRequest.Builder>	serializableBuilderClass()
Long	startTime() The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
FilterLogEventsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

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

copy

Method Detail

logGroupName

public String logGroupName()

The name of the log group to search.

Returns:

The name of the log group to search.

logStreamNames

public List<String> logStreamNames()

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

Filters the results to only logs from the log streams in this list.

If you specify a value for both logStreamNamePrefix and logStreamNames, the action returns an InvalidParameterException error.

logStreamNamePrefix

public String logStreamNamePrefix()

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames , the action returns an InvalidParameterException error.

Returns:

Filters the results to include only events from log streams that have names starting with this prefix.

If you specify a value for both logStreamNamePrefix and logStreamNames, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.

startTime

public 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 before this time are not returned.

Returns:

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

endTime

public 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 later than this time are not returned.

Returns:

The end of the time range, expressed as the number of milliseconds after 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. For more information, see Filter and Pattern Syntax.

If not provided, all the events are matched.

Returns:

The filter pattern to use. For more information, see Filter and Pattern Syntax.

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 ToCopyableBuilder<FilterLogEventsRequest.Builder,FilterLogEventsRequest>

Specified by:

toBuilder in class CloudWatchLogsRequest

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()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo