com.amazonaws.services.logs.model

Class GetLogEventsRequest

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

Modifier and Type	Method and Description
GetLogEventsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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	getLogGroupIdentifier() Specify either the name or ARN of the log group to view events from.
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.
Boolean	getUnmask() Specify true to display the log event fields with all sensitive data unmasked and visible.
int	hashCode()
Boolean	isStartFromHead() If the value is true, the earliest log events are returned first.
Boolean	isUnmask() Specify true to display the log event fields with all sensitive data unmasked and visible.
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	setLogGroupIdentifier(String logGroupIdentifier) Specify either the name or ARN of the log group to view events from.
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.
void	setUnmask(Boolean unmask) Specify true to display the log event fields with all sensitive data unmasked and visible.
String	toString() Returns a string representation of this object.
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	withLogGroupIdentifier(String logGroupIdentifier) Specify either the name or ARN of the log group to view events from.
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.
GetLogEventsRequest	withUnmask(Boolean unmask) Specify true to display the log event fields with all sensitive data unmasked and visible.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

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

You must include either logGroupIdentifier or logGroupName, but not both.

logStreamName - The name of the log stream.

Method Detail

setLogGroupName

public void setLogGroupName(String logGroupName)

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

Parameters:

logGroupName - The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

getLogGroupName

public String getLogGroupName()

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

Returns:

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

withLogGroupName

public GetLogEventsRequest withLogGroupName(String logGroupName)

The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

Parameters:

logGroupName - The name of the log group.

You must include either logGroupIdentifier or logGroupName, but not both.

Returns:

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

setLogGroupIdentifier

public void setLogGroupIdentifier(String logGroupIdentifier)

Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

Parameters:

logGroupIdentifier - Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

getLogGroupIdentifier

public String getLogGroupIdentifier()

Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

Returns:

Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

withLogGroupIdentifier

public GetLogEventsRequest withLogGroupIdentifier(String logGroupIdentifier)

Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

Parameters:

logGroupIdentifier - Specify either the name or ARN of the log group to view events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

You must include either logGroupIdentifier or logGroupName, but not both.

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 timestamp equal to this time or later than this time are included. Events with a timestamp 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 timestamp equal to this time or later than this time are included. Events with a timestamp 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 timestamp equal to this time or later than this time are included. Events with a timestamp 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 timestamp equal to this time or later than this time are included. Events with a timestamp 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 timestamp equal to this time or later than this time are included. Events with a timestamp 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 timestamp equal to this time or later than this time are included. Events with a timestamp 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 timestamp equal to or 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 timestamp equal to or 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 timestamp equal to or 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 timestamp equal to or 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 timestamp equal to or 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 timestamp equal to or 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 limit, the default 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 limit, the default 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 limit, the default 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 limit, the default 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 limit, the default 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 limit, the default 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.

If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

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.

If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

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.

If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

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.

If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

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.

If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

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.

If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

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.

If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

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.

If you are using a previous nextForwardToken value as the nextToken in this operation, you must specify true for startFromHead.

setUnmask

public void setUnmask(Boolean unmask)

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

Parameters:

unmask - Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

getUnmask

public Boolean getUnmask()

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

Returns:

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

withUnmask

public GetLogEventsRequest withUnmask(Boolean unmask)

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

Parameters:

unmask - Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

Returns:

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

isUnmask

public Boolean isUnmask()

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

Returns:

Specify true to display the log event fields with all sensitive data unmasked and visible. The default is false.

To use this operation with this parameter, you must be signed into an account with the logs:Unmask permission.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

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

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()