GetLogEventsRequest (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class GetLogEventsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable
```
Lists log events from the specified log stream. You can list all the log events or filter using a time range.

By default, this operation returns as many log events as can fit in a response size of 1MB (up to 10,000 log events). You can get additional log events by specifying one of the tokens in a subsequent call.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`GetLogEventsRequest()` Default constructor for GetLogEventsRequest object.
`GetLogEventsRequest(java.lang.String logGroupName, java.lang.String logStreamName)` Constructs a new GetLogEventsRequest object.

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.Integer`	`getLimit()` The maximum number of log events returned.
`java.lang.String`	`getLogGroupName()` The name of the log group.
`java.lang.String`	`getLogStreamName()` The name of the log stream.
`java.lang.String`	`getNextToken()` The token for the next set of items to return.
`java.lang.Boolean`	`getStartFromHead()` If the value is true, the earliest log events are returned first.
`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`	`isStartFromHead()` If the value is true, the earliest log events are returned first.
`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`	`setLimit(java.lang.Integer limit)` The maximum number of log events returned.
`void`	`setLogGroupName(java.lang.String logGroupName)` The name of the log group.
`void`	`setLogStreamName(java.lang.String logStreamName)` The name of the log stream.
`void`	`setNextToken(java.lang.String nextToken)` The token for the next set of items to return.
`void`	`setStartFromHead(java.lang.Boolean startFromHead)` If the value is true, the earliest log events are returned first.
`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.
`GetLogEventsRequest`	`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.
`GetLogEventsRequest`	`withLimit(java.lang.Integer limit)` The maximum number of log events returned.
`GetLogEventsRequest`	`withLogGroupName(java.lang.String logGroupName)` The name of the log group.
`GetLogEventsRequest`	`withLogStreamName(java.lang.String logStreamName)` The name of the log stream.
`GetLogEventsRequest`	`withNextToken(java.lang.String nextToken)` The token for the next set of items to return.
`GetLogEventsRequest`	`withStartFromHead(java.lang.Boolean startFromHead)` If the value is true, the earliest log events are returned first.
`GetLogEventsRequest`	`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
  - GetLogEventsRequest
```
public GetLogEventsRequest()
```
    Default constructor for GetLogEventsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
  - GetLogEventsRequest
```
public GetLogEventsRequest(java.lang.String logGroupName,
                           java.lang.String logStreamName)
```
    Constructs a new GetLogEventsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.
    
    Parameters:
    
    logGroupName -
    The name of the log group.
    
    logStreamName -
    The name of the log stream.
- Method Detail
  - getLogGroupName
```
public java.lang.String getLogGroupName()
```
    The name of the log group.
    
    Constraints:
    Length: 1 - 512
    Pattern: [\.\-_/#A-Za-z0-9]+
    
    Returns:
    
    The name of the log group.
  - setLogGroupName
```
public void setLogGroupName(java.lang.String logGroupName)
```
    The name of the log group.
    
    Constraints:
    Length: 1 - 512
    Pattern: [\.\-_/#A-Za-z0-9]+
    
    Parameters:
    
    logGroupName -
    The name of the log group.
  - withLogGroupName
```
public GetLogEventsRequest withLogGroupName(java.lang.String logGroupName)
```
    The name of the log group.
    
    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.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getLogStreamName
```
public java.lang.String getLogStreamName()
```
    The name of the log stream.
    
    Constraints:
    Length: 1 - 512
    Pattern: [^:*]*
    
    Returns:
    
    The name of the log stream.
  - setLogStreamName
```
public void setLogStreamName(java.lang.String logStreamName)
```
    The name of the log stream.
    
    Constraints:
    Length: 1 - 512
    Pattern: [^:*]*
    
    Parameters:
    
    logStreamName -
    The name of the log stream.
  - withLogStreamName
```
public GetLogEventsRequest withLogStreamName(java.lang.String logStreamName)
```
    The name of the log stream.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 512
    Pattern: [^:*]*
    
    Parameters:
    
    logStreamName -
    The name of the log stream.
    
    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 equal to this time or later than this time are included. Events with a time stamp earlier than this time are not included.
    
    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 equal to this time or later than this time are included. Events with a time stamp earlier than this time are not included.
  - 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 equal to this time or later than this time are included. Events with a time stamp earlier than this time are not included.
    
    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 equal to this time or later than this time are included. Events with a time stamp earlier than this time are not included.
  - withStartTime
```
public GetLogEventsRequest 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 equal to this time or later than this time are included. Events with a time stamp earlier than this time are not included.
    
    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 equal to this time or later than this time are included. Events with a time stamp earlier than this time are not included.
    
    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 equal to or later than this time are not included.
    
    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 equal to or later than this time are not included.
  - 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 equal to or later than this time are not included.
    
    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 equal to or later than this time are not included.
  - withEndTime
```
public GetLogEventsRequest 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 equal to or later than this time are not included.
    
    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 equal to or later than this time are not included.
    
    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 items to return. (You received this token from a previous call.)
    
    Constraints:
    Length: 1 -
    
    Returns:
    
    The token for the next set of items 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 items to return. (You received this token from a previous call.)
    
    Constraints:
    Length: 1 -
    
    Parameters:
    
    nextToken -
    The token for the next set of items to return. (You received this token from a previous call.)
  - withNextToken
```
public GetLogEventsRequest withNextToken(java.lang.String nextToken)
```
    The token for the next set of items 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 items 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 log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events.
    
    Constraints:
    Range: 1 - 10000
    
    Returns:
    
    The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events.
  - setLimit
```
public void setLimit(java.lang.Integer limit)
```
    The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events.
    
    Constraints:
    Range: 1 - 10000
    
    Parameters:
    
    limit -
    The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events.
  - withLimit
```
public GetLogEventsRequest withLimit(java.lang.Integer limit)
```
    The maximum number of log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log 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 log events returned. If you don't specify a value, the maximum is as many log events as can fit in a response size of 1 MB, up to 10,000 log events.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isStartFromHead
```
public java.lang.Boolean isStartFromHead()
```
    If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.
    
    Returns:
    
    If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.
  - getStartFromHead
```
public java.lang.Boolean getStartFromHead()
```
    If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.
    
    Returns:
    
    If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.
  - setStartFromHead
```
public void setStartFromHead(java.lang.Boolean startFromHead)
```
    If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.
    
    Parameters:
    
    startFromHead -
    If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.
  - withStartFromHead
```
public GetLogEventsRequest withStartFromHead(java.lang.Boolean startFromHead)
```
    If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value is false.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    startFromHead -
    If the value is true, the earliest log events are returned first. If the value is false, the latest log events are returned first. The default value 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 GetLogEventsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GetLogEventsRequest

GetLogEventsRequest

Method Detail

getLogGroupName

setLogGroupName

withLogGroupName

getLogStreamName

setLogStreamName

withLogStreamName

getStartTime

setStartTime

withStartTime

getEndTime

setEndTime

withEndTime

getNextToken

setNextToken

withNextToken

getLimit

setLimit

withLimit

isStartFromHead

getStartFromHead

setStartFromHead

withStartFromHead

toString

hashCode

equals