Package software.amazon.awssdk.services.rum.model

Class PutRumEventsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.rum.model.RumRequest

software.amazon.awssdk.services.rum.model.PutRumEventsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutRumEventsRequest.Builder,PutRumEventsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutRumEventsRequest.Builder

Method Summary

Modifier and Type	Method	Description
AppMonitorDetails	appMonitorDetails()	A structure that contains information about the app monitor that collected this telemetry information.
String	batchId()	A unique identifier for this batch of RUM event data.
static PutRumEventsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRumEvents()	For responses, this returns true if the service returned a value for the RumEvents property.
String	id()	The ID of the app monitor that is sending this data.
List<RumEvent>	rumEvents()	An array of structures that contain the telemetry event data.
List<SdkField<?>>	sdkFields()
static Class<? extends PutRumEventsRequest.Builder>	serializableBuilderClass()
PutRumEventsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
UserDetails	userDetails()	A structure that contains information about the user session that this batch of events was collected from.

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

appMonitorDetails

public final AppMonitorDetails appMonitorDetails()

A structure that contains information about the app monitor that collected this telemetry information.

Returns:

A structure that contains information about the app monitor that collected this telemetry information.

batchId

public final String batchId()

A unique identifier for this batch of RUM event data.

Returns:

A unique identifier for this batch of RUM event data.

id

public final String id()

The ID of the app monitor that is sending this data.

Returns:

The ID of the app monitor that is sending this data.

hasRumEvents

public final boolean hasRumEvents()

For responses, this returns true if the service returned a value for the RumEvents 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.

rumEvents

public final List<RumEvent> rumEvents()

An array of structures that contain the telemetry event data.

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 hasRumEvents() method.

Returns:

An array of structures that contain the telemetry event data.

userDetails

public final UserDetails userDetails()

A structure that contains information about the user session that this batch of events was collected from.

Returns:

A structure that contains information about the user session that this batch of events was collected from.

toBuilder

public PutRumEventsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutRumEventsRequest.Builder,PutRumEventsRequest>

Specified by:

toBuilder in class RumRequest

builder

public static PutRumEventsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends PutRumEventsRequest.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