@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class FilterLogEventsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
FilterLogEventsRequest() |
Modifier and Type | Method and Description |
---|---|
FilterLogEventsRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Long |
getEndTime()
The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
|
String |
getFilterPattern()
The filter pattern to use.
|
Boolean |
getInterleaved()
Deprecated.
|
Integer |
getLimit()
The maximum number of events to return.
|
String |
getLogGroupName()
The name of the log group to search.
|
String |
getLogStreamNamePrefix()
Filters the results to include only events from log streams that have names starting with this prefix.
|
List<String> |
getLogStreamNames()
Filters the results to only logs from the log streams in this list.
|
String |
getNextToken()
The token for the next set of events to return.
|
Long |
getStartTime()
The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
|
int |
hashCode() |
Boolean |
isInterleaved()
Deprecated.
|
void |
setEndTime(Long endTime)
The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
|
void |
setFilterPattern(String filterPattern)
The filter pattern to use.
|
void |
setInterleaved(Boolean interleaved)
Deprecated.
|
void |
setLimit(Integer limit)
The maximum number of events to return.
|
void |
setLogGroupName(String logGroupName)
The name of the log group to search.
|
void |
setLogStreamNamePrefix(String logStreamNamePrefix)
Filters the results to include only events from log streams that have names starting with this prefix.
|
void |
setLogStreamNames(Collection<String> logStreamNames)
Filters the results to only logs from the log streams in this list.
|
void |
setNextToken(String nextToken)
The token for the next set of events to return.
|
void |
setStartTime(Long startTime)
The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
|
String |
toString()
Returns a string representation of this object.
|
FilterLogEventsRequest |
withEndTime(Long endTime)
The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
|
FilterLogEventsRequest |
withFilterPattern(String filterPattern)
The filter pattern to use.
|
FilterLogEventsRequest |
withInterleaved(Boolean interleaved)
Deprecated.
|
FilterLogEventsRequest |
withLimit(Integer limit)
The maximum number of events to return.
|
FilterLogEventsRequest |
withLogGroupName(String logGroupName)
The name of the log group to search.
|
FilterLogEventsRequest |
withLogStreamNamePrefix(String logStreamNamePrefix)
Filters the results to include only events from log streams that have names starting with this prefix.
|
FilterLogEventsRequest |
withLogStreamNames(Collection<String> logStreamNames)
Filters the results to only logs from the log streams in this list.
|
FilterLogEventsRequest |
withLogStreamNames(String... logStreamNames)
Filters the results to only logs from the log streams in this list.
|
FilterLogEventsRequest |
withNextToken(String nextToken)
The token for the next set of events to return.
|
FilterLogEventsRequest |
withStartTime(Long startTime)
The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setLogGroupName(String logGroupName)
The name of the log group to search.
logGroupName
- The name of the log group to search.public String getLogGroupName()
The name of the log group to search.
public FilterLogEventsRequest withLogGroupName(String logGroupName)
The name of the log group to search.
logGroupName
- The name of the log group to search.public List<String> getLogStreamNames()
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.
If you specify a value for both logStreamNamePrefix
and logStreamNames
, the
action returns an InvalidParameterException
error.
public void setLogStreamNames(Collection<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.
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.
public FilterLogEventsRequest withLogStreamNames(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.
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
- 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.
public FilterLogEventsRequest withLogStreamNames(Collection<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.
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.
public void setLogStreamNamePrefix(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.
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.
public String getLogStreamNamePrefix()
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.
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.
public FilterLogEventsRequest withLogStreamNamePrefix(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.
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.
public void setStartTime(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.
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.public Long getStartTime()
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.
public FilterLogEventsRequest withStartTime(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.
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.public void setEndTime(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.
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.public Long getEndTime()
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.
public FilterLogEventsRequest withEndTime(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.
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.public void setFilterPattern(String filterPattern)
The filter pattern to use. For more information, see Filter and Pattern Syntax.
If not provided, all the events are matched.
filterPattern
- The filter pattern to use. For more information, see Filter and
Pattern Syntax.
If not provided, all the events are matched.
public String getFilterPattern()
The filter pattern to use. For more information, see Filter and Pattern Syntax.
If not provided, all the events are matched.
If not provided, all the events are matched.
public FilterLogEventsRequest withFilterPattern(String filterPattern)
The filter pattern to use. For more information, see Filter and Pattern Syntax.
If not provided, all the events are matched.
filterPattern
- The filter pattern to use. For more information, see Filter and
Pattern Syntax.
If not provided, all the events are matched.
public void setNextToken(String nextToken)
The token for the next set of events to return. (You received this token from a previous call.)
nextToken
- The token for the next set of events to return. (You received this token from a previous call.)public String getNextToken()
The token for the next set of events to return. (You received this token from a previous call.)
public FilterLogEventsRequest withNextToken(String nextToken)
The token for the next set of events to return. (You received this token from a previous call.)
nextToken
- The token for the next set of events to return. (You received this token from a previous call.)public void setLimit(Integer limit)
The maximum number of events to return. The default is 10,000 events.
limit
- The maximum number of events to return. The default is 10,000 events.public Integer getLimit()
The maximum number of events to return. The default is 10,000 events.
public FilterLogEventsRequest withLimit(Integer limit)
The maximum number of events to return. The default is 10,000 events.
limit
- The maximum number of events to return. The default is 10,000 events.@Deprecated public void setInterleaved(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.
Important: Starting on June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.
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.
Important: Starting on June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.
@Deprecated public Boolean getInterleaved()
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.
Important: Starting on June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.
Important: Starting on June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.
@Deprecated public FilterLogEventsRequest withInterleaved(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.
Important: Starting on June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.
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.
Important: Starting on June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.
@Deprecated public Boolean isInterleaved()
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.
Important: Starting on June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.
Important: Starting on June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.
public String toString()
toString
in class Object
Object.toString()
public FilterLogEventsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()