Package software.amazon.awssdk.services.personalizeevents.model

Class PutEventsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.personalizeevents.model.PersonalizeEventsRequest

software.amazon.awssdk.services.personalizeevents.model.PutEventsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<PutEventsRequest.Builder,PutEventsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PutEventsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static PutEventsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Event>	eventList()	A list of event data from the session.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasEventList()	For responses, this returns true if the service returned a value for the EventList property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends PutEventsRequest.Builder>	serializableBuilderClass()
String	sessionId()	The session ID associated with the user's visit.
PutEventsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	trackingId()	The tracking ID for the event.
String	userId()	The user associated with the event.

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

trackingId

public final String trackingId()

The tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.

Returns:

The tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.

userId

public final String userId()

The user associated with the event.

Returns:

The user associated with the event.

sessionId

public final String sessionId()

The session ID associated with the user's visit. Your application generates the sessionId when a user first visits your website or uses your application. Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information, see Recording item interaction events.

Returns:

The session ID associated with the user's visit. Your application generates the sessionId when a user first visits your website or uses your application. Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information, see Recording item interaction events.

hasEventList

public final boolean hasEventList()

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

eventList

public final List<Event> eventList()

A list of event data from the session.

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

Returns:

A list of event data from the session.

toBuilder

public PutEventsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PutEventsRequest.Builder,PutEventsRequest>

Specified by:

toBuilder in class PersonalizeEventsRequest

builder

public static PutEventsRequest.Builder builder()

serializableBuilderClass

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