Package software.amazon.awssdk.services.cloudwatchlogs.model

Class PutLogEventsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.CloudWatchLogsRequest

software.amazon.awssdk.services.cloudwatchlogs.model.PutLogEventsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutLogEventsRequest.Builder,PutLogEventsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class PutLogEventsRequest
extends CloudWatchLogsRequest
implements ToCopyableBuilder<PutLogEventsRequest.Builder,PutLogEventsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutLogEventsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutLogEventsRequest.Builder	builder()
Entity	entity()	The entity associated with the log events.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLogEvents()	For responses, this returns true if the service returned a value for the LogEvents property.
List<InputLogEvent>	logEvents()	The log events.
String	logGroupName()	The name of the log group.
String	logStreamName()	The name of the log stream.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
String	sequenceToken()	The sequence token obtained from the response of the previous PutLogEvents call.
static Class<? extends PutLogEventsRequest.Builder>	serializableBuilderClass()
PutLogEventsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

logGroupName

public final String logGroupName()

The name of the log group.

Returns:

The name of the log group.

logStreamName

public final String logStreamName()

The name of the log stream.

Returns:

The name of the log stream.

hasLogEvents

public final boolean hasLogEvents()

For responses, this returns true if the service returned a value for the LogEvents property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

logEvents

public final List<InputLogEvent> logEvents()

The log events.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasLogEvents() method.

Returns:

The log events.

sequenceToken

public final String sequenceToken()

The sequence token obtained from the response of the previous PutLogEvents call.

The sequenceToken parameter is now ignored in PutLogEvents actions. PutLogEvents actions are now accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid.

Returns:

The sequence token obtained from the response of the previous PutLogEvents call.

The sequenceToken parameter is now ignored in PutLogEvents actions. PutLogEvents actions are now accepted and never return InvalidSequenceTokenException or DataAlreadyAcceptedException even if the sequence token is not valid.

entity

public final Entity entity()

The entity associated with the log events.

Returns:

The entity associated with the log events.

toBuilder

public PutLogEventsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutLogEventsRequest.Builder,PutLogEventsRequest>

Specified by:

toBuilder in class CloudWatchLogsRequest

builder

public static PutLogEventsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutLogEventsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo