GetLogEventsRequest (AWS Java SDK for Amazon CloudWatch Logs 1.11.202 API)

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

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetLogEventsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetLogEventsRequest`	`clone()`
`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.
`Integer`	`getLimit()` The maximum number of log events returned.
`String`	`getLogGroupName()` The name of the log group.
`String`	`getLogStreamName()` The name of the log stream.
`String`	`getNextToken()` The token for the next set of items to return.
`Boolean`	`getStartFromHead()` If the value is true, the earliest log events are returned first.
`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`	`isStartFromHead()` If the value is true, the earliest log events are returned first.
`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`	`setLimit(Integer limit)` The maximum number of log events returned.
`void`	`setLogGroupName(String logGroupName)` The name of the log group.
`void`	`setLogStreamName(String logStreamName)` The name of the log stream.
`void`	`setNextToken(String nextToken)` The token for the next set of items to return.
`void`	`setStartFromHead(Boolean startFromHead)` If the value is true, the earliest log events are returned first.
`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; useful for testing and debugging.
`GetLogEventsRequest`	`withEndTime(Long endTime)` The end of the time range, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.
`GetLogEventsRequest`	`withLimit(Integer limit)` The maximum number of log events returned.
`GetLogEventsRequest`	`withLogGroupName(String logGroupName)` The name of the log group.
`GetLogEventsRequest`	`withLogStreamName(String logStreamName)` The name of the log stream.
`GetLogEventsRequest`	`withNextToken(String nextToken)` The token for the next set of items to return.
`GetLogEventsRequest`	`withStartFromHead(Boolean startFromHead)` If the value is true, the earliest log events are returned first.
`GetLogEventsRequest`	`withStartTime(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 java.lang.Object
finalize, 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 the object after creating it.
  - GetLogEventsRequest
```
public GetLogEventsRequest(String logGroupName,
                           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
  - setLogGroupName
```
public void setLogGroupName(String logGroupName)
```
    The name of the log group.
    
    Parameters:
    
    logGroupName - The name of the log group.
  - getLogGroupName
```
public String getLogGroupName()
```
    The name of the log group.
    
    Returns:
    
    The name of the log group.
  - withLogGroupName
```
public GetLogEventsRequest withLogGroupName(String logGroupName)
```
    The name of the log group.
    
    Parameters:
    
    logGroupName - The name of the log group.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLogStreamName
```
public void setLogStreamName(String logStreamName)
```
    The name of the log stream.
    
    Parameters:
    
    logStreamName - The name of the log stream.
  - getLogStreamName
```
public String getLogStreamName()
```
    The name of the log stream.
    
    Returns:
    
    The name of the log stream.
  - withLogStreamName
```
public GetLogEventsRequest withLogStreamName(String logStreamName)
```
    The name of the log stream.
    
    Parameters:
    
    logStreamName - The name of the log stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartTime
```
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 time stamp earlier than this time are not included.
    
    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 earlier than this time are not included.
  - getStartTime
```
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 time stamp earlier than this time are not included.
    
    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 earlier than this time are not included.
  - withStartTime
```
public GetLogEventsRequest 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 time stamp earlier than this time are not included.
    
    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 earlier than this time are not included.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
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 time stamp later than this time are not included.
    
    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 included.
  - getEndTime
```
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 time stamp later than this time are not included.
    
    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 included.
  - withEndTime
```
public GetLogEventsRequest 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 time stamp later than this time are not included.
    
    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 included.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNextToken
```
public void setNextToken(String nextToken)
```
    The token for the next set of items to return. (You received this token from a previous call.)
    
    Parameters:
    
    nextToken - The token for the next set of items to return. (You received this token from a previous call.)
  - getNextToken
```
public String getNextToken()
```
    The token for the next set of items to return. (You received this token from a previous call.)
    
    Returns:
    
    The token for the next set of items to return. (You received this token from a previous call.)
  - withNextToken
```
public GetLogEventsRequest withNextToken(String nextToken)
```
    The token for the next set of items to return. (You received this token from a previous call.)
    
    Parameters:
    
    nextToken - The token for the next set of items to return. (You received this token from a previous call.)
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLimit
```
public void setLimit(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.
    
    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.
  - getLimit
```
public 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.
    
    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.
  - withLimit
```
public GetLogEventsRequest withLimit(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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartFromHead
```
public void setStartFromHead(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.
  - getStartFromHead
```
public 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.
  - withStartFromHead
```
public GetLogEventsRequest withStartFromHead(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isStartFromHead
```
public 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.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetLogEventsRequest clone()
```
    Overrides:
    
    clone in class AmazonWebServiceRequest

Class GetLogEventsRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GetLogEventsRequest

GetLogEventsRequest

Method Detail

setLogGroupName

getLogGroupName

withLogGroupName

setLogStreamName

getLogStreamName

withLogStreamName

setStartTime

getStartTime

withStartTime

setEndTime

getEndTime

withEndTime

setNextToken

getNextToken

withNextToken

setLimit

getLimit

withLimit

setStartFromHead

getStartFromHead

withStartFromHead

isStartFromHead

toString

equals

hashCode

clone