com.amazonaws.services.logs.model

Class FilterLogEventsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.FilterLogEventsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class FilterLogEventsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the FilterLogEvents operation.

Retrieves log events, optionally filtered by a filter pattern from the specified log group. You can provide an optional time range to filter the results on the event timestamp . You can limit the streams searched to an explicit list of logStreamNames .

By default, this operation returns as much matching log events as can fit in a response size of 1MB, up to 10,000 log events, or all the events found within a time-bounded scan window. If the response includes a nextToken , then there is more data to search, and the search can be resumed with a new request providing the nextToken. The response will contain a list of searchedLogStreams that contains information about which streams were searched in the request and whether they have been searched completely or require further pagination. The limit parameter in the request. can be used to specify the maximum number of events to return in a page.

See Also:

AWSLogs.filterLogEvents(FilterLogEventsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
FilterLogEventsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
FilterLogEventsRequest	clone()
boolean	equals(Object obj)
Long	getEndTime() A unix timestamp indicating the end time of the range for the request.
String	getFilterPattern() A valid CloudWatch Logs filter pattern to use for filtering the response.
Boolean	getInterleaved() If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response.
Integer	getLimit() The maximum number of events to return in a page of results.
String	getLogGroupName() The name of the log group to query.
List<String>	getLogStreamNames() Optional list of log stream names within the specified log group to search.
String	getNextToken() A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results.
Long	getStartTime() A unix timestamp indicating the start time of the range for the request.
int	hashCode()
Boolean	isInterleaved() If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response.
void	setEndTime(Long endTime) A unix timestamp indicating the end time of the range for the request.
void	setFilterPattern(String filterPattern) A valid CloudWatch Logs filter pattern to use for filtering the response.
void	setInterleaved(Boolean interleaved) If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response.
void	setLimit(Integer limit) The maximum number of events to return in a page of results.
void	setLogGroupName(String logGroupName) The name of the log group to query.
void	setLogStreamNames(Collection<String> logStreamNames) Optional list of log stream names within the specified log group to search.
void	setNextToken(String nextToken) A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results.
void	setStartTime(Long startTime) A unix timestamp indicating the start time of the range for the request.
String	toString() Returns a string representation of this object; useful for testing and debugging.
FilterLogEventsRequest	withEndTime(Long endTime) A unix timestamp indicating the end time of the range for the request.
FilterLogEventsRequest	withFilterPattern(String filterPattern) A valid CloudWatch Logs filter pattern to use for filtering the response.
FilterLogEventsRequest	withInterleaved(Boolean interleaved) If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response.
FilterLogEventsRequest	withLimit(Integer limit) The maximum number of events to return in a page of results.
FilterLogEventsRequest	withLogGroupName(String logGroupName) The name of the log group to query.
FilterLogEventsRequest	withLogStreamNames(Collection<String> logStreamNames) Optional list of log stream names within the specified log group to search.
FilterLogEventsRequest	withLogStreamNames(String... logStreamNames) Optional list of log stream names within the specified log group to search.
FilterLogEventsRequest	withNextToken(String nextToken) A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results.
FilterLogEventsRequest	withStartTime(Long startTime) A unix timestamp indicating the start time of the range for the request.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterLogEventsRequest

public FilterLogEventsRequest()

Method Detail

getLogGroupName

public String getLogGroupName()

The name of the log group to query.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Returns:

The name of the log group to query.

setLogGroupName

public void setLogGroupName(String logGroupName)

The name of the log group to query.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Parameters:

logGroupName - The name of the log group to query.

withLogGroupName

public FilterLogEventsRequest withLogGroupName(String logGroupName)

The name of the log group to query.

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

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Parameters:

logGroupName - The name of the log group to query.

Returns:

A reference to this updated object so that method calls can be chained together.

getLogStreamNames

public List<String> getLogStreamNames()

Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.

Constraints:
Length: 1 - 100

Returns:

Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.

setLogStreamNames

public void setLogStreamNames(Collection<String> logStreamNames)

Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.

Constraints:
Length: 1 - 100

Parameters:

logStreamNames - Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.

withLogStreamNames

public FilterLogEventsRequest withLogStreamNames(String... logStreamNames)

Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.

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.

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

Constraints:
Length: 1 - 100

Parameters:

logStreamNames - Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.

Returns:

A reference to this updated object so that method calls can be chained together.

withLogStreamNames

public FilterLogEventsRequest withLogStreamNames(Collection<String> logStreamNames)

Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.

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

Constraints:
Length: 1 - 100

Parameters:

logStreamNames - Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.

Returns:

A reference to this updated object so that method calls can be chained together.

getStartTime

public Long getStartTime()

A unix timestamp indicating the start time of the range for the request. If provided, events with a timestamp prior to this time will not be returned.

Constraints:
Range: 0 -

Returns:

A unix timestamp indicating the start time of the range for the request. If provided, events with a timestamp prior to this time will not be returned.

setStartTime

public void setStartTime(Long startTime)

A unix timestamp indicating the start time of the range for the request. If provided, events with a timestamp prior to this time will not be returned.

Constraints:
Range: 0 -

Parameters:

startTime - A unix timestamp indicating the start time of the range for the request. If provided, events with a timestamp prior to this time will not be returned.

withStartTime

public FilterLogEventsRequest withStartTime(Long startTime)

A unix timestamp indicating the start time of the range for the request. If provided, events with a timestamp prior to this time will not be returned.

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

Constraints:
Range: 0 -

Parameters:

startTime - A unix timestamp indicating the start time of the range for the request. If provided, events with a timestamp prior to this time will not be returned.

Returns:

A reference to this updated object so that method calls can be chained together.

getEndTime

public Long getEndTime()

A unix timestamp indicating the end time of the range for the request. If provided, events with a timestamp later than this time will not be returned.

Constraints:
Range: 0 -

Returns:

A unix timestamp indicating the end time of the range for the request. If provided, events with a timestamp later than this time will not be returned.

setEndTime

public void setEndTime(Long endTime)

A unix timestamp indicating the end time of the range for the request. If provided, events with a timestamp later than this time will not be returned.

Constraints:
Range: 0 -

Parameters:

endTime - A unix timestamp indicating the end time of the range for the request. If provided, events with a timestamp later than this time will not be returned.

withEndTime

public FilterLogEventsRequest withEndTime(Long endTime)

A unix timestamp indicating the end time of the range for the request. If provided, events with a timestamp later than this time will not be returned.

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

Constraints:
Range: 0 -

Parameters:

endTime - A unix timestamp indicating the end time of the range for the request. If provided, events with a timestamp later than this time will not be returned.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilterPattern

public String getFilterPattern()

A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.

Constraints:
Length: 0 - 512

Returns:

A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.

setFilterPattern

public void setFilterPattern(String filterPattern)

A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.

Constraints:
Length: 0 - 512

Parameters:

filterPattern - A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.

withFilterPattern

public FilterLogEventsRequest withFilterPattern(String filterPattern)

A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.

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

Constraints:
Length: 0 - 512

Parameters:

filterPattern - A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results.

Constraints:
Length: 1 -

Returns:

A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results.

setNextToken

public void setNextToken(String nextToken)

A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results.

Constraints:
Length: 1 -

Parameters:

nextToken - A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results.

withNextToken

public FilterLogEventsRequest withNextToken(String nextToken)

A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results.

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

Constraints:
Length: 1 -

Parameters:

nextToken - A pagination token obtained from a FilterLogEvents response to continue paginating the FilterLogEvents results.

Returns:

A reference to this updated object so that method calls can be chained together.

getLimit

public Integer getLimit()

The maximum number of events to return in a page of results. Default is 10,000 events.

Constraints:
Range: 1 - 10000

Returns:

The maximum number of events to return in a page of results. Default is 10,000 events.

setLimit

public void setLimit(Integer limit)

The maximum number of events to return in a page of results. Default is 10,000 events.

Constraints:
Range: 1 - 10000

Parameters:

limit - The maximum number of events to return in a page of results. Default is 10,000 events.

withLimit

public FilterLogEventsRequest withLimit(Integer limit)

The maximum number of events to return in a page of results. Default is 10,000 events.

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

Constraints:
Range: 1 - 10000

Parameters:

limit - The maximum number of events to return in a page of results. Default is 10,000 events.

Returns:

A reference to this updated object so that method calls can be chained together.

isInterleaved

public Boolean isInterleaved()

If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.

Returns:

If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.

setInterleaved

public void setInterleaved(Boolean interleaved)

If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.

Parameters:

interleaved - If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.

withInterleaved

public FilterLogEventsRequest withInterleaved(Boolean interleaved)

If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.

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

Parameters:

interleaved - If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.

Returns:

A reference to this updated object so that method calls can be chained together.

getInterleaved

public Boolean getInterleaved()

If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.

Returns:

If provided, the API will make a best effort to provide responses that contain events from multiple log streams within the log group interleaved in a single response. If not provided, all the matched log events in the first log stream will be searched first, then those in the next log stream, etc.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public FilterLogEventsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest