public class FilterLogEventsRequest extends AmazonWebServiceRequest implements java.io.Serializable, java.lang.Cloneable
Modifier and Type | Field and Description |
---|---|
private java.lang.Long |
endTime
A point in time expressed as the number of milliseconds since Jan 1, 1970
00:00:00 UTC.
|
private java.lang.String |
filterPattern
A valid CloudWatch Logs filter pattern to use for filtering the response.
|
private java.lang.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.
|
private java.lang.Integer |
limit
The maximum number of events to return in a page of results.
|
private java.lang.String |
logGroupName
The name of the log group to query.
|
private SdkInternalList<java.lang.String> |
logStreamNames
Optional list of log stream names within the specified log group to
search.
|
private java.lang.String |
nextToken
A pagination token obtained from a
FilterLogEvents response to continue paginating
the FilterLogEvents results. |
private java.lang.Long |
startTime
A point in time expressed as the number of milliseconds since Jan 1, 1970
00:00:00 UTC.
|
NOOP
Constructor and Description |
---|
FilterLogEventsRequest() |
Modifier and Type | Method and Description |
---|---|
FilterLogEventsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(java.lang.Object obj) |
java.lang.Long |
getEndTime()
A point in time expressed as the number of milliseconds since Jan 1, 1970
00:00:00 UTC.
|
java.lang.String |
getFilterPattern()
A valid CloudWatch Logs filter pattern to use for filtering the response.
|
java.lang.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.
|
java.lang.Integer |
getLimit()
The maximum number of events to return in a page of results.
|
java.lang.String |
getLogGroupName()
The name of the log group to query.
|
java.util.List<java.lang.String> |
getLogStreamNames()
Optional list of log stream names within the specified log group to
search.
|
java.lang.String |
getNextToken()
A pagination token obtained from a
FilterLogEvents response to continue paginating
the FilterLogEvents results. |
java.lang.Long |
getStartTime()
A point in time expressed as the number of milliseconds since Jan 1, 1970
00:00:00 UTC.
|
int |
hashCode() |
java.lang.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(java.lang.Long endTime)
A point in time expressed as the number of milliseconds since Jan 1, 1970
00:00:00 UTC.
|
void |
setFilterPattern(java.lang.String filterPattern)
A valid CloudWatch Logs filter pattern to use for filtering the response.
|
void |
setInterleaved(java.lang.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(java.lang.Integer limit)
The maximum number of events to return in a page of results.
|
void |
setLogGroupName(java.lang.String logGroupName)
The name of the log group to query.
|
void |
setLogStreamNames(java.util.Collection<java.lang.String> logStreamNames)
Optional list of log stream names within the specified log group to
search.
|
void |
setNextToken(java.lang.String nextToken)
A pagination token obtained from a
FilterLogEvents response to continue paginating
the FilterLogEvents results. |
void |
setStartTime(java.lang.Long startTime)
A point in time expressed as the number of milliseconds since Jan 1, 1970
00:00:00 UTC.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
FilterLogEventsRequest |
withEndTime(java.lang.Long endTime)
A point in time expressed as the number of milliseconds since Jan 1, 1970
00:00:00 UTC.
|
FilterLogEventsRequest |
withFilterPattern(java.lang.String filterPattern)
A valid CloudWatch Logs filter pattern to use for filtering the response.
|
FilterLogEventsRequest |
withInterleaved(java.lang.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(java.lang.Integer limit)
The maximum number of events to return in a page of results.
|
FilterLogEventsRequest |
withLogGroupName(java.lang.String logGroupName)
The name of the log group to query.
|
FilterLogEventsRequest |
withLogStreamNames(java.util.Collection<java.lang.String> logStreamNames)
Optional list of log stream names within the specified log group to
search.
|
FilterLogEventsRequest |
withLogStreamNames(java.lang.String... logStreamNames)
Optional list of log stream names within the specified log group to
search.
|
FilterLogEventsRequest |
withNextToken(java.lang.String nextToken)
A pagination token obtained from a
FilterLogEvents response to continue paginating
the FilterLogEvents results. |
FilterLogEventsRequest |
withStartTime(java.lang.Long startTime)
A point in time expressed as the number of milliseconds since Jan 1, 1970
00:00:00 UTC.
|
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
private java.lang.String logGroupName
The name of the log group to query.
private SdkInternalList<java.lang.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.
private java.lang.Long 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.
private java.lang.Long 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.
private java.lang.String filterPattern
A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.
private java.lang.String nextToken
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.
private java.lang.Integer limit
The maximum number of events to return in a page of results. Default is 10,000 events.
private java.lang.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.
public void setLogGroupName(java.lang.String logGroupName)
The name of the log group to query.
logGroupName
- The name of the log group to query.public java.lang.String getLogGroupName()
The name of the log group to query.
public FilterLogEventsRequest withLogGroupName(java.lang.String logGroupName)
The name of the log group to query.
logGroupName
- The name of the log group to query.public java.util.List<java.lang.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.
public void setLogStreamNames(java.util.Collection<java.lang.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.
logStreamNames
- Optional list of log stream names within the specified log group
to search. Defaults to all the log streams in the log group.public FilterLogEventsRequest withLogStreamNames(java.lang.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.
logStreamNames
- Optional list of log stream names within the specified log group
to search. Defaults to all the log streams in the log group.public FilterLogEventsRequest withLogStreamNames(java.util.Collection<java.lang.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.
logStreamNames
- Optional list of log stream names within the specified log group
to search. Defaults to all the log streams in the log group.public void setStartTime(java.lang.Long 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.
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.public java.lang.Long 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.
public FilterLogEventsRequest withStartTime(java.lang.Long 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.
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.public void setEndTime(java.lang.Long 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.
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.public java.lang.Long 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.
public FilterLogEventsRequest withEndTime(java.lang.Long 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.
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.public void setFilterPattern(java.lang.String filterPattern)
A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.
filterPattern
- A valid CloudWatch Logs filter pattern to use for filtering the
response. If not provided, all the events are matched.public java.lang.String getFilterPattern()
A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.
public FilterLogEventsRequest withFilterPattern(java.lang.String filterPattern)
A valid CloudWatch Logs filter pattern to use for filtering the response. If not provided, all the events are matched.
filterPattern
- A valid CloudWatch Logs filter pattern to use for filtering the
response. If not provided, all the events are matched.public void setNextToken(java.lang.String nextToken)
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.
nextToken
- 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.public java.lang.String 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.
FilterLogEvents
response to continue
paginating the FilterLogEvents results. This token is omitted
from the response when there are no other events to display.public FilterLogEventsRequest withNextToken(java.lang.String nextToken)
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.
nextToken
- 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.public void setLimit(java.lang.Integer limit)
The maximum number of events to return in a page of results. Default is 10,000 events.
limit
- The maximum number of events to return in a page of results.
Default is 10,000 events.public java.lang.Integer getLimit()
The maximum number of events to return in a page of results. Default is 10,000 events.
public FilterLogEventsRequest withLimit(java.lang.Integer limit)
The maximum number of events to return in a page of results. Default is 10,000 events.
limit
- The maximum number of events to return in a page of results.
Default is 10,000 events.public void setInterleaved(java.lang.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.
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.public java.lang.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.
public FilterLogEventsRequest withInterleaved(java.lang.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.
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.public java.lang.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.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public FilterLogEventsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()