Class FilterLogEventsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.A valid CloudWatch Logs filter pattern to use for filtering the response.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.getLimit()
The maximum number of events to return in a page of results.The name of the log group to query.Optional list of log stream names within the specified log group to search.A pagination token obtained from aFilterLogEvents
response to continue paginating the FilterLogEvents results.A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.int
hashCode()
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 point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.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
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 aFilterLogEvents
response to continue paginating the FilterLogEvents results.void
setStartTime
(Long startTime) A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.toString()
Returns a string representation of this object; useful for testing and debugging.withEndTime
(Long endTime) A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.withFilterPattern
(String filterPattern) A valid CloudWatch Logs filter pattern to use for filtering the response.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.The maximum number of events to return in a page of results.withLogGroupName
(String logGroupName) The name of the log group to query.withLogStreamNames
(String... logStreamNames) Optional list of log stream names within the specified log group to search.withLogStreamNames
(Collection<String> logStreamNames) Optional list of log stream names within the specified log group to search.withNextToken
(String nextToken) A pagination token obtained from aFilterLogEvents
response to continue paginating the FilterLogEvents results.withStartTime
(Long startTime) A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
FilterLogEventsRequest
public FilterLogEventsRequest()
-
-
Method Details
-
setLogGroupName
The name of the log group to query.
- Parameters:
logGroupName
- The name of the log group to query.
-
getLogGroupName
The name of the log group to query.
- Returns:
- The name of the log group to query.
-
withLogGroupName
The name of the log group to query.
- Parameters:
logGroupName
- The name of the log group to query.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getLogStreamNames
Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.
- 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
Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.
- 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
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)
orwithLogStreamNames(java.util.Collection)
if you want to override the existing values.- 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:
- Returns a reference to this object so that method calls can be chained together.
-
withLogStreamNames
Optional list of log stream names within the specified log group to search. Defaults to all the log streams in the log group.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setStartTime
A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp prior to this time are not returned.
- Parameters:
startTime
- A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp prior to this time are not returned.
-
getStartTime
A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp prior to this time are not returned.
- Returns:
- A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp prior to this time are not returned.
-
withStartTime
A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp prior to this time are not returned.
- Parameters:
startTime
- A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, 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.
-
setEndTime
A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp later than this time are not returned.
- Parameters:
endTime
- A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp later than this time are not returned.
-
getEndTime
A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp later than this time are not returned.
- Returns:
- A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp later than this time are not returned.
-
withEndTime
A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, events with a timestamp later than this time are not returned.
- Parameters:
endTime
- A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC. If provided, 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.
-
setFilterPattern
A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.
- Parameters:
filterPattern
- A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.
-
getFilterPattern
A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.
- Returns:
- A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.
-
withFilterPattern
A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.
- Parameters:
filterPattern
- A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNextToken
A pagination token obtained from a
FilterLogEvents
response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display.- Parameters:
nextToken
- A pagination token obtained from aFilterLogEvents
response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display.
-
getNextToken
A pagination token obtained from a
FilterLogEvents
response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display.- Returns:
- A pagination token obtained from a
FilterLogEvents
response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display.
-
withNextToken
A pagination token obtained from a
FilterLogEvents
response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display.- Parameters:
nextToken
- A pagination token obtained from aFilterLogEvents
response to continue paginating the FilterLogEvents results. This token is omitted from the response when there are no other events to display.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLimit
The maximum number of events to return in a page of results. Default is 10,000 events.
- Parameters:
limit
- The maximum number of events to return in a page of results. Default is 10,000 events.
-
getLimit
The maximum number of events to return in a page of results. Default is 10,000 events.
- Returns:
- The maximum number of events to return in a page of results. Default is 10,000 events.
-
withLimit
The maximum number of events to return in a page of results. Default is 10,000 events.
- Parameters:
limit
- The maximum number of events to return in a page of results. Default is 10,000 events.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setInterleaved
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.
-
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.
-
withInterleaved
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.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-