com.amazonaws.services.logs.model

Class PutLogEventsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.logs.model.PutLogEventsRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable

public class PutLogEventsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

Container for the parameters to the PutLogEvents operation.

Uploads a batch of log events to the specified log stream.

Every PutLogEvents request must include the sequenceToken obtained from the response of the previous request. An upload in a newly created log stream does not require a sequenceToken .

The batch of events must satisfy the following constraints:

• The maximum batch size is 1,048,576 bytes, and this size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.
• None of the log events in the batch can be more than 2 hours in the future.
• None of the log events in the batch can be older than 14 days or the retention period of the log group.
• The log events in the batch must be in chronological ordered by their timestamp .
• The maximum number of log events in a batch is 10,000.

See Also:

AWSLogs.putLogEvents(PutLogEventsRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutLogEventsRequest() Default constructor for a new PutLogEventsRequest object.
PutLogEventsRequest(String logGroupName, String logStreamName, List<InputLogEvent> logEvents) Constructs a new PutLogEventsRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
PutLogEventsRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
List<InputLogEvent>	getLogEvents() A list of log events belonging to a log stream.
String	getLogGroupName() The name of the log group to put log events to.
String	getLogStreamName() The name of the log stream to put log events to.
String	getSequenceToken() A string token that must be obtained from the response of the previous PutLogEvents request.
int	hashCode()
void	setLogEvents(Collection<InputLogEvent> logEvents) A list of log events belonging to a log stream.
void	setLogGroupName(String logGroupName) The name of the log group to put log events to.
void	setLogStreamName(String logStreamName) The name of the log stream to put log events to.
void	setSequenceToken(String sequenceToken) A string token that must be obtained from the response of the previous PutLogEvents request.
String	toString() Returns a string representation of this object; useful for testing and debugging.
PutLogEventsRequest	withLogEvents(Collection<InputLogEvent> logEvents) A list of log events belonging to a log stream.
PutLogEventsRequest	withLogEvents(InputLogEvent... logEvents) A list of log events belonging to a log stream.
PutLogEventsRequest	withLogGroupName(String logGroupName) The name of the log group to put log events to.
PutLogEventsRequest	withLogStreamName(String logStreamName) The name of the log stream to put log events to.
PutLogEventsRequest	withSequenceToken(String sequenceToken) A string token that must be obtained from the response of the previous PutLogEvents request.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PutLogEventsRequest

public PutLogEventsRequest()

Default constructor for a new PutLogEventsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

PutLogEventsRequest

public PutLogEventsRequest(String logGroupName,
                   String logStreamName,
                   List<InputLogEvent> logEvents)

Constructs a new PutLogEventsRequest 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 put log events to.

logStreamName - The name of the log stream to put log events to.

logEvents - A list of log events belonging to a log stream.

Method Detail

getLogGroupName

public String getLogGroupName()

The name of the log group to put log events to.

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

Returns:

The name of the log group to put log events to.

setLogGroupName

public void setLogGroupName(String logGroupName)

The name of the log group to put log events to.

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

Parameters:

logGroupName - The name of the log group to put log events to.

withLogGroupName

public PutLogEventsRequest withLogGroupName(String logGroupName)

The name of the log group to put log events to.

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 put log events to.

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 put log events to.

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

Returns:

The name of the log stream to put log events to.

setLogStreamName

public void setLogStreamName(String logStreamName)

The name of the log stream to put log events to.

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

Parameters:

logStreamName - The name of the log stream to put log events to.

withLogStreamName

public PutLogEventsRequest withLogStreamName(String logStreamName)

The name of the log stream to put log events to.

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 put log events to.

Returns:

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

getLogEvents

public List<InputLogEvent> getLogEvents()

A list of log events belonging to a log stream.

Constraints:
Length: 1 - 10000

Returns:

A list of log events belonging to a log stream.

setLogEvents

public void setLogEvents(Collection<InputLogEvent> logEvents)

A list of log events belonging to a log stream.

Constraints:
Length: 1 - 10000

Parameters:

logEvents - A list of log events belonging to a log stream.

withLogEvents

public PutLogEventsRequest withLogEvents(InputLogEvent... logEvents)

A list of log events belonging to a log stream.

NOTE: This method appends the values to the existing list (if any). Use setLogEvents(java.util.Collection) or withLogEvents(java.util.Collection) if you want to override the existing values.

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

Constraints:
Length: 1 - 10000

Parameters:

logEvents - A list of log events belonging to a log stream.

Returns:

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

withLogEvents

public PutLogEventsRequest withLogEvents(Collection<InputLogEvent> logEvents)

A list of log events belonging to a log stream.

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

Constraints:
Length: 1 - 10000

Parameters:

logEvents - A list of log events belonging to a log stream.

Returns:

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

getSequenceToken

public String getSequenceToken()

A string token that must be obtained from the response of the previous PutLogEvents request.

Constraints:
Length: 1 -

Returns:

A string token that must be obtained from the response of the previous PutLogEvents request.

setSequenceToken

public void setSequenceToken(String sequenceToken)

A string token that must be obtained from the response of the previous PutLogEvents request.

Constraints:
Length: 1 -

Parameters:

sequenceToken - A string token that must be obtained from the response of the previous PutLogEvents request.

withSequenceToken

public PutLogEventsRequest withSequenceToken(String sequenceToken)

A string token that must be obtained from the response of the previous PutLogEvents request.

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

Constraints:
Length: 1 -

Parameters:

sequenceToken - A string token that must be obtained from the response of the previous PutLogEvents request.

Returns:

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

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 PutLogEventsRequest 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 class AmazonWebServiceRequest

See Also:

Object.clone()