FilterLogEventsRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.logs.model.FilterLogEventsRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class FilterLogEventsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Lists log events from the specified log group. You can list all the log events or filter the results using a filter pattern, a time range, and the name of the log stream.

By default, this operation returns as many log events as can fit in 1 MB (up to 10,000 log events), or all the events found within the time range that you specify. If the results include a token, then there are more log events available, and you can get additional results by specifying the token in a subsequent call.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

FilterLogEventsRequest()

Constructors
Constructor and Description
`FilterLogEventsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Long`	`getEndTime()` The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
`java.lang.String`	`getFilterPattern()` The filter pattern to use.
`java.lang.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.
`java.lang.Integer`	`getLimit()` The maximum number of events to return.
`java.lang.String`	`getLogGroupName()` The name of the log group to search.
`java.lang.String`	`getLogStreamNamePrefix()` Filters the results to include only events from log streams that have names starting with this prefix.
`java.util.List<java.lang.String>`	`getLogStreamNames()` Filters the results to only logs from the log streams in this list.
`java.lang.String`	`getNextToken()` The token for the next set of events to return.
`java.lang.Long`	`getStartTime()` The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
`int`	`hashCode()`
`java.lang.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.
`void`	`setEndTime(java.lang.Long endTime)` The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
`void`	`setFilterPattern(java.lang.String filterPattern)` The filter pattern to use.
`void`	`setInterleaved(java.lang.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.
`void`	`setLimit(java.lang.Integer limit)` The maximum number of events to return.
`void`	`setLogGroupName(java.lang.String logGroupName)` The name of the log group to search.
`void`	`setLogStreamNamePrefix(java.lang.String logStreamNamePrefix)` Filters the results to include only events from log streams that have names starting with this prefix.
`void`	`setLogStreamNames(java.util.Collection<java.lang.String> logStreamNames)` Filters the results to only logs from the log streams in this list.
`void`	`setNextToken(java.lang.String nextToken)` The token for the next set of events to return.
`void`	`setStartTime(java.lang.Long startTime)` The start of the time range, expressed as the number of milliseconds after 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)` The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
`FilterLogEventsRequest`	`withFilterPattern(java.lang.String filterPattern)` The filter pattern to use.
`FilterLogEventsRequest`	`withInterleaved(java.lang.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.
`FilterLogEventsRequest`	`withLimit(java.lang.Integer limit)` The maximum number of events to return.
`FilterLogEventsRequest`	`withLogGroupName(java.lang.String logGroupName)` The name of the log group to search.
`FilterLogEventsRequest`	`withLogStreamNamePrefix(java.lang.String logStreamNamePrefix)` Filters the results to include only events from log streams that have names starting with this prefix.
`FilterLogEventsRequest`	`withLogStreamNames(java.util.Collection<java.lang.String> logStreamNames)` Filters the results to only logs from the log streams in this list.
`FilterLogEventsRequest`	`withLogStreamNames(java.lang.String... logStreamNames)` Filters the results to only logs from the log streams in this list.
`FilterLogEventsRequest`	`withNextToken(java.lang.String nextToken)` The token for the next set of events to return.
`FilterLogEventsRequest`	`withStartTime(java.lang.Long startTime)` The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FilterLogEventsRequest
```
public FilterLogEventsRequest()
```
- Method Detail
  - getLogGroupName
```
public java.lang.String getLogGroupName()
```
    The name of the log group to search.
    
    Constraints:
    Length: 1 - 512
    Pattern: [\.\-_/#A-Za-z0-9]+
    
    Returns:
    
    The name of the log group to search.
  - setLogGroupName
```
public void setLogGroupName(java.lang.String logGroupName)
```
    The name of the log group to search.
    
    Constraints:
    Length: 1 - 512
    Pattern: [\.\-_/#A-Za-z0-9]+
    
    Parameters:
    
    logGroupName -
    The name of the log group to search.
  - withLogGroupName
```
public FilterLogEventsRequest withLogGroupName(java.lang.String logGroupName)
```
    The name of the log group to search.
    
    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 search.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLogStreamNames
```
public java.util.List<java.lang.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, 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 only logs from the log streams in this list.
    
    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.
  - setLogStreamNames
```
public void setLogStreamNames(java.util.Collection<java.lang.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, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.
    
    Parameters:
    
    logStreamNames -
    Filters the results to only logs from the log streams in this list.
    
    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.
  - withLogStreamNames
```
public FilterLogEventsRequest withLogStreamNames(java.lang.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, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    logStreamNames -
    Filters the results to only logs from the log streams in this list.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - withLogStreamNames
```
public FilterLogEventsRequest withLogStreamNames(java.util.Collection<java.lang.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, but the value for logStreamNamePrefix does not match any log stream names specified in logStreamNames, the action returns an InvalidParameterException error.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    logStreamNames -
    Filters the results to only logs from the log streams in this list.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getLogStreamNamePrefix
```
public java.lang.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.
    
    Constraints:
    Length: 1 - 512
    Pattern: [^:*]*
    
    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.
  - setLogStreamNamePrefix
```
public void setLogStreamNamePrefix(java.lang.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.
    
    Constraints:
    Length: 1 - 512
    Pattern: [^:*]*
    
    Parameters:
    
    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.
  - withLogStreamNamePrefix
```
public FilterLogEventsRequest withLogStreamNamePrefix(java.lang.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 a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 512
    Pattern: [^:*]*
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getStartTime
```
public java.lang.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 time stamp before this time are not returned.
    
    Constraints:
    Range: 0 -
    
    Returns:
    
    The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp before this time are not returned.
  - setStartTime
```
public void setStartTime(java.lang.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 time stamp before this time are not returned.
    
    Constraints:
    Range: 0 -
    
    Parameters:
    
    startTime -
    The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp before this time are not returned.
  - withStartTime
```
public FilterLogEventsRequest withStartTime(java.lang.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 time stamp before this time are not returned.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 -
    
    Parameters:
    
    startTime -
    The start of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp before this time are not returned.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getEndTime
```
public java.lang.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 time stamp later than this time are not returned.
    
    Constraints:
    Range: 0 -
    
    Returns:
    
    The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not returned.
  - setEndTime
```
public void setEndTime(java.lang.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 time stamp later than this time are not returned.
    
    Constraints:
    Range: 0 -
    
    Parameters:
    
    endTime -
    The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not returned.
  - withEndTime
```
public FilterLogEventsRequest withEndTime(java.lang.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 time stamp later than this time are not returned.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 -
    
    Parameters:
    
    endTime -
    The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. Events with a time stamp later than this time are not returned.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getFilterPattern
```
public java.lang.String getFilterPattern()
```
    The filter pattern to use. For more information, see Filter and Pattern Syntax.
    
    If not provided, all the events are matched.
    
    Constraints:
    Length: 0 - 1024
    
    Returns:
    
    The filter pattern to use. For more information, see Filter and Pattern Syntax.
    
    If not provided, all the events are matched.
  - setFilterPattern
```
public void setFilterPattern(java.lang.String filterPattern)
```
    The filter pattern to use. For more information, see Filter and Pattern Syntax.
    
    If not provided, all the events are matched.
    
    Constraints:
    Length: 0 - 1024
    
    Parameters:
    
    filterPattern -
    The filter pattern to use. For more information, see Filter and Pattern Syntax.
    
    If not provided, all the events are matched.
  - withFilterPattern
```
public FilterLogEventsRequest withFilterPattern(java.lang.String filterPattern)
```
    The filter pattern to use. For more information, see Filter and Pattern Syntax.
    
    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 - 1024
    
    Parameters:
    
    filterPattern -
    The filter pattern to use. For more information, see Filter and Pattern Syntax.
    
    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 java.lang.String getNextToken()
```
    The token for the next set of events to return. (You received this token from a previous call.)
    
    Constraints:
    Length: 1 -
    
    Returns:
    
    The token for the next set of events to return. (You received this token from a previous call.)
  - setNextToken
```
public void setNextToken(java.lang.String nextToken)
```
    The token for the next set of events to return. (You received this token from a previous call.)
    
    Constraints:
    Length: 1 -
    
    Parameters:
    
    nextToken -
    The token for the next set of events to return. (You received this token from a previous call.)
  - withNextToken
```
public FilterLogEventsRequest withNextToken(java.lang.String nextToken)
```
    The token for the next set of events to return. (You received this token from a previous call.)
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 -
    
    Parameters:
    
    nextToken -
    The token for the next set of events to return. (You received this token from a previous call.)
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLimit
```
public java.lang.Integer getLimit()
```
    The maximum number of events to return. The default is 10,000 events.
    
    Constraints:
    Range: 1 - 10000
    
    Returns:
    
    The maximum number of events to return. The default is 10,000 events.
  - setLimit
```
public void setLimit(java.lang.Integer limit)
```
    The maximum number of events to return. The default is 10,000 events.
    
    Constraints:
    Range: 1 - 10000
    
    Parameters:
    
    limit -
    The maximum number of events to return. The default is 10,000 events.
  - withLimit
```
public FilterLogEventsRequest withLimit(java.lang.Integer limit)
```
    The maximum number of events to return. The 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. The default is 10,000 events.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isInterleaved
```
public java.lang.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.
    
    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.
  - getInterleaved
```
public java.lang.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.
    
    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.
  - setInterleaved
```
public void setInterleaved(java.lang.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.
    
    Parameters:
    
    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.
  - withInterleaved
```
public FilterLogEventsRequest withInterleaved(java.lang.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 a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class FilterLogEventsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

FilterLogEventsRequest

Method Detail

getLogGroupName

setLogGroupName

withLogGroupName

getLogStreamNames

setLogStreamNames

withLogStreamNames

withLogStreamNames

getLogStreamNamePrefix

setLogStreamNamePrefix

withLogStreamNamePrefix

getStartTime

setStartTime

withStartTime

getEndTime

setEndTime

withEndTime

getFilterPattern

setFilterPattern

withFilterPattern

getNextToken

setNextToken

withNextToken

getLimit

setLimit

withLimit

isInterleaved

getInterleaved

setInterleaved

withInterleaved

toString

hashCode

equals