public class PutLogEventsRequest extends AmazonWebServiceRequest implements java.io.Serializable
Uploads a batch of log events to the specified log stream.
You must include the sequence token obtained from the response of the
previous call. An upload in a newly created log stream does not require a
sequence token. You can also get the sequence token using
DescribeLogStreams. If you call PutLogEvents
twice within
a narrow time period using the same value for sequenceToken
,
both calls may be successful, or one may be rejected.
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 time stamp. The time stamp is the time the event occurred, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC. (In AWS Tools for PowerShell and the AWS SDK for .NET, the timestamp is specified in .NET format: yyyy-mm-ddThh:mm:ss. For example, 2017-09-15T13:45:30.)
The maximum number of log events in a batch is 10,000.
A batch of log events in a single request cannot span more than 24 hours. Otherwise, the operation fails.
If a call to PutLogEvents returns "UnrecognizedClientException" the most likely cause is an invalid AWS access key ID or secret key.
Constructor and Description |
---|
PutLogEventsRequest()
Default constructor for PutLogEventsRequest object.
|
PutLogEventsRequest(java.lang.String logGroupName,
java.lang.String logStreamName,
java.util.List<InputLogEvent> logEvents)
Constructs a new PutLogEventsRequest object.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
java.util.List<InputLogEvent> |
getLogEvents()
The log events.
|
java.lang.String |
getLogGroupName()
The name of the log group.
|
java.lang.String |
getLogStreamName()
The name of the log stream.
|
java.lang.String |
getSequenceToken()
The sequence token obtained from the response of the previous
PutLogEvents call. |
int |
hashCode() |
void |
setLogEvents(java.util.Collection<InputLogEvent> logEvents)
The log events.
|
void |
setLogGroupName(java.lang.String logGroupName)
The name of the log group.
|
void |
setLogStreamName(java.lang.String logStreamName)
The name of the log stream.
|
void |
setSequenceToken(java.lang.String sequenceToken)
The sequence token obtained from the response of the previous
PutLogEvents call. |
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
PutLogEventsRequest |
withLogEvents(java.util.Collection<InputLogEvent> logEvents)
The log events.
|
PutLogEventsRequest |
withLogEvents(InputLogEvent... logEvents)
The log events.
|
PutLogEventsRequest |
withLogGroupName(java.lang.String logGroupName)
The name of the log group.
|
PutLogEventsRequest |
withLogStreamName(java.lang.String logStreamName)
The name of the log stream.
|
PutLogEventsRequest |
withSequenceToken(java.lang.String sequenceToken)
The sequence token obtained from the response of the previous
PutLogEvents call. |
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public PutLogEventsRequest()
public PutLogEventsRequest(java.lang.String logGroupName, java.lang.String logStreamName, java.util.List<InputLogEvent> logEvents)
logGroupName
- The name of the log group.
logStreamName
- The name of the log stream.
logEvents
- The log events.
public java.lang.String getLogGroupName()
The name of the log group.
Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+
The name of the log group.
public void setLogGroupName(java.lang.String logGroupName)
The name of the log group.
Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+
logGroupName
- The name of the log group.
public PutLogEventsRequest withLogGroupName(java.lang.String logGroupName)
The name of the log group.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 512
Pattern: [\.\-_/#A-Za-z0-9]+
logGroupName
- The name of the log group.
public java.lang.String getLogStreamName()
The name of the log stream.
Constraints:
Length: 1 - 512
Pattern: [^:*]*
The name of the log stream.
public void setLogStreamName(java.lang.String logStreamName)
The name of the log stream.
Constraints:
Length: 1 - 512
Pattern: [^:*]*
logStreamName
- The name of the log stream.
public PutLogEventsRequest withLogStreamName(java.lang.String logStreamName)
The name of the log stream.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 - 512
Pattern: [^:*]*
logStreamName
- The name of the log stream.
public java.util.List<InputLogEvent> getLogEvents()
The log events.
The log events.
public void setLogEvents(java.util.Collection<InputLogEvent> logEvents)
The log events.
logEvents
- The log events.
public PutLogEventsRequest withLogEvents(InputLogEvent... logEvents)
The log events.
Returns a reference to this object so that method calls can be chained together.
logEvents
- The log events.
public PutLogEventsRequest withLogEvents(java.util.Collection<InputLogEvent> logEvents)
The log events.
Returns a reference to this object so that method calls can be chained together.
logEvents
- The log events.
public java.lang.String getSequenceToken()
The sequence token obtained from the response of the previous
PutLogEvents
call. An upload in a newly created log stream
does not require a sequence token. You can also get the sequence token
using DescribeLogStreams. If you call PutLogEvents
twice within a narrow time period using the same value for
sequenceToken
, both calls may be successful, or one may be
rejected.
Constraints:
Length: 1 -
The sequence token obtained from the response of the previous
PutLogEvents
call. An upload in a newly created log
stream does not require a sequence token. You can also get the
sequence token using DescribeLogStreams. If you call
PutLogEvents
twice within a narrow time period using
the same value for sequenceToken
, both calls may be
successful, or one may be rejected.
public void setSequenceToken(java.lang.String sequenceToken)
The sequence token obtained from the response of the previous
PutLogEvents
call. An upload in a newly created log stream
does not require a sequence token. You can also get the sequence token
using DescribeLogStreams. If you call PutLogEvents
twice within a narrow time period using the same value for
sequenceToken
, both calls may be successful, or one may be
rejected.
Constraints:
Length: 1 -
sequenceToken
-
The sequence token obtained from the response of the previous
PutLogEvents
call. An upload in a newly created
log stream does not require a sequence token. You can also get
the sequence token using DescribeLogStreams. If you
call PutLogEvents
twice within a narrow time
period using the same value for sequenceToken
,
both calls may be successful, or one may be rejected.
public PutLogEventsRequest withSequenceToken(java.lang.String sequenceToken)
The sequence token obtained from the response of the previous
PutLogEvents
call. An upload in a newly created log stream
does not require a sequence token. You can also get the sequence token
using DescribeLogStreams. If you call PutLogEvents
twice within a narrow time period using the same value for
sequenceToken
, both calls may be successful, or one may be
rejected.
Returns a reference to this object so that method calls can be chained together.
Constraints:
Length: 1 -
sequenceToken
-
The sequence token obtained from the response of the previous
PutLogEvents
call. An upload in a newly created
log stream does not require a sequence token. You can also get
the sequence token using DescribeLogStreams. If you
call PutLogEvents
twice within a narrow time
period using the same value for sequenceToken
,
both calls may be successful, or one may be rejected.
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.