Class GetLogEventsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
ConstructorsConstructorDescriptionDefault constructor for GetLogEventsRequest object.GetLogEventsRequest
(String logGroupName, String logStreamName) Constructs a new GetLogEventsRequest object. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
getLimit()
The maximum number of log events returned in the response.The name of the log group to query.The name of the log stream to query.A string token used for pagination that points to the next page of results.If set to true, the earliest log events would be returned first.int
hashCode()
If set to true, the earliest log events would be returned first.void
setEndTime
(Long endTime) void
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) toString()
Returns a string representation of this object; useful for testing and debugging.withEndTime
(Long endTime) The maximum number of log events returned in the response.withLogGroupName
(String logGroupName) The name of the log group to query.withLogStreamName
(String logStreamName) The name of the log stream to query.withNextToken
(String nextToken) A string token used for pagination that points to the next page of results.withStartFromHead
(Boolean startFromHead) If set to true, the earliest log events would be returned first.withStartTime
(Long startTime) Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
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
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 Details
-
setLogGroupName
The name of the log group to query.
- Parameters:
logGroupName
- The name of the log group to query.
-
getLogGroupName
The name of the log group to query.
- Returns:
- The name of the log group to query.
-
withLogGroupName
The name of the log group to query.
- Parameters:
logGroupName
- The name of the log group to query.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLogStreamName
The name of the log stream to query.
- Parameters:
logStreamName
- The name of the log stream to query.
-
getLogStreamName
The name of the log stream to query.
- Returns:
- The name of the log stream to query.
-
withLogStreamName
The name of the log stream to query.
- Parameters:
logStreamName
- The name of the log stream to query.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setStartTime
- Parameters:
startTime
-
-
getStartTime
- Returns:
-
withStartTime
- Parameters:
startTime
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setEndTime
- Parameters:
endTime
-
-
getEndTime
- Returns:
-
withEndTime
- Parameters:
endTime
-- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setNextToken
A string token used for pagination that points to the next page of results. It must be a value obtained from the
nextForwardToken
ornextBackwardToken
fields in the response of the previousGetLogEvents
request.- Parameters:
nextToken
- A string token used for pagination that points to the next page of results. It must be a value obtained from thenextForwardToken
ornextBackwardToken
fields in the response of the previousGetLogEvents
request.
-
getNextToken
A string token used for pagination that points to the next page of results. It must be a value obtained from the
nextForwardToken
ornextBackwardToken
fields in the response of the previousGetLogEvents
request.- Returns:
- A string token used for pagination that points to the next page
of results. It must be a value obtained from the
nextForwardToken
ornextBackwardToken
fields in the response of the previousGetLogEvents
request.
-
withNextToken
A string token used for pagination that points to the next page of results. It must be a value obtained from the
nextForwardToken
ornextBackwardToken
fields in the response of the previousGetLogEvents
request.- Parameters:
nextToken
- A string token used for pagination that points to the next page of results. It must be a value obtained from thenextForwardToken
ornextBackwardToken
fields in the response of the previousGetLogEvents
request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setLimit
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.
- 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.
-
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.
- 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.
-
withLimit
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.
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
setStartFromHead
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).
-
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).
-
withStartFromHead
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).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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).
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-