com.amazonaws.services.logs.model

Class GetLogEventsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.GetLogEventsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class GetLogEventsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the GetLogEvents operation.

Retrieves log events from the specified log stream. You can provide an optional time range to filter the results on the event timestamp .

By default, this operation returns as much log events as can fit in a response size of 1MB, up to 10,000 log events. The response will always include a nextForwardToken and a nextBackwardToken in the response body. You can use any of these tokens in subsequent GetLogEvents requests to paginate through events in either forward or backward direction. You can also limit the number of log events returned in the response by specifying the limit parameter in the request.

See Also:

AWSLogs.getLogEvents(GetLogEventsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
GetLogEventsRequest	clone()
boolean	equals(Object obj)
Long	getEndTime() A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
Integer	getLimit() The maximum number of log events returned in the response.
String	getLogGroupName() The name of the log group to query.
String	getLogStreamName() The name of the log stream to query.
String	getNextToken() A string token used for pagination that points to the next page of results.
Boolean	getStartFromHead() If set to true, the earliest log events would be returned first.
Long	getStartTime() A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
int	hashCode()
Boolean	isStartFromHead() If set to true, the earliest log events would be returned first.
void	setEndTime(Long endTime) A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
void	setLimit(Integer limit) The maximum number of log events returned in the response.
void	setLogGroupName(String logGroupName) The name of the log group to query.
void	setLogStreamName(String logStreamName) The name of the log stream to query.
void	setNextToken(String nextToken) A string token used for pagination that points to the next page of results.
void	setStartFromHead(Boolean startFromHead) If set to true, the earliest log events would be returned first.
void	setStartTime(Long startTime) A point in time expressed as the number of milliseconds since 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) A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.
GetLogEventsRequest	withLimit(Integer limit) The maximum number of log events returned in the response.
GetLogEventsRequest	withLogGroupName(String logGroupName) The name of the log group to query.
GetLogEventsRequest	withLogStreamName(String logStreamName) The name of the log stream to query.
GetLogEventsRequest	withNextToken(String nextToken) A string token used for pagination that points to the next page of results.
GetLogEventsRequest	withStartFromHead(Boolean startFromHead) If set to true, the earliest log events would be returned first.
GetLogEventsRequest	withStartTime(Long startTime) A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetLogEventsRequest

public GetLogEventsRequest()

Default constructor for a new GetLogEventsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this 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 to query.

logStreamName - The name of the log stream to query.

Method Detail

getLogGroupName

public String getLogGroupName()

The name of the log group to query.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Returns:

The name of the log group to query.

setLogGroupName

public void setLogGroupName(String logGroupName)

The name of the log group to query.

Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+

Parameters:

logGroupName - The name of the log group to query.

withLogGroupName

public GetLogEventsRequest withLogGroupName(String logGroupName)

The name of the log group to query.

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 query.

Returns:

A reference to this updated object so that method calls can be chained together.

getLogStreamName

public String getLogStreamName()

The name of the log stream to query.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Returns:

The name of the log stream to query.

setLogStreamName

public void setLogStreamName(String logStreamName)

The name of the log stream to query.

Constraints:
Length: 1 - 512
Pattern: [^:*]*

Parameters:

logStreamName - The name of the log stream to query.

withLogStreamName

public GetLogEventsRequest withLogStreamName(String logStreamName)

The name of the log stream to query.

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 to query.

Returns:

A reference to this updated object so that method calls can be chained together.

getStartTime

public Long getStartTime()

A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

Returns:

A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

setStartTime

public void setStartTime(Long startTime)

A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

Parameters:

startTime - A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

withStartTime

public GetLogEventsRequest withStartTime(Long startTime)

A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 0 -

Parameters:

startTime - A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

Returns:

A reference to this updated object so that method calls can be chained together.

getEndTime

public Long getEndTime()

A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

Returns:

A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

setEndTime

public void setEndTime(Long endTime)

A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

Constraints:
Range: 0 -

Parameters:

endTime - A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

withEndTime

public GetLogEventsRequest withEndTime(Long endTime)

A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Range: 0 -

Parameters:

endTime - A point in time expressed as the number of milliseconds since Jan 1, 1970 00:00:00 UTC.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

A string token used for pagination that points to the next page of results. It must be a value obtained from the nextForwardToken or nextBackwardToken fields in the response of the previous GetLogEvents request.

Constraints:
Length: 1 -

Returns:

A string token used for pagination that points to the next page of results. It must be a value obtained from the nextForwardToken or nextBackwardToken fields in the response of the previous GetLogEvents request.

setNextToken

public void setNextToken(String nextToken)

A string token used for pagination that points to the next page of results. It must be a value obtained from the nextForwardToken or nextBackwardToken fields in the response of the previous GetLogEvents request.

Constraints:
Length: 1 -

Parameters:

nextToken - A string token used for pagination that points to the next page of results. It must be a value obtained from the nextForwardToken or nextBackwardToken fields in the response of the previous GetLogEvents request.

withNextToken

public GetLogEventsRequest withNextToken(String nextToken)

A string token used for pagination that points to the next page of results. It must be a value obtained from the nextForwardToken or nextBackwardToken fields in the response of the previous GetLogEvents request.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 -

Parameters:

nextToken - A string token used for pagination that points to the next page of results. It must be a value obtained from the nextForwardToken or nextBackwardToken fields in the response of the previous GetLogEvents request.

Returns:

A reference to this updated object so that method calls can be chained together.

getLimit

public Integer getLimit()

The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events.

Constraints:
Range: 1 - 10000

Returns:

The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events.

setLimit

public void setLimit(Integer limit)

The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events.

Constraints:
Range: 1 - 10000

Parameters:

limit - The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events.

withLimit

public GetLogEventsRequest withLimit(Integer limit)

The maximum number of log events returned in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, 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 in the response. If you don't specify a value, the request would return as many log events as can fit in a response size of 1MB, up to 10,000 log events.

Returns:

A reference to this updated object so that method calls can be chained together.

isStartFromHead

public Boolean isStartFromHead()

If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).

Returns:

If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).

setStartFromHead

public void setStartFromHead(Boolean startFromHead)

If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).

Parameters:

startFromHead - If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).

withStartFromHead

public GetLogEventsRequest withStartFromHead(Boolean startFromHead)

If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).

Returns a reference to this object so that method calls can be chained together.

Parameters:

startFromHead - If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).

Returns:

A reference to this updated object so that method calls can be chained together.

getStartFromHead

public Boolean getStartFromHead()

If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).

Returns:

If set to true, the earliest log events would be returned first. The default is false (the latest log events are returned first).

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()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public GetLogEventsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest