Interface PutEventsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<PutEventsRequest.Builder,PutEventsRequest>, PersonalizeEventsRequest.Builder, SdkBuilder<PutEventsRequest.Builder,PutEventsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

PutEventsRequest

@Mutable
@NotThreadSafe
public static interface PutEventsRequest.Builder
extends PersonalizeEventsRequest.Builder, SdkPojo, CopyableBuilder<PutEventsRequest.Builder,PutEventsRequest>

Method Summary

Modifier and Type	Method	Description
PutEventsRequest.Builder	eventList(Collection<Event> eventList)	A list of event data from the session.
PutEventsRequest.Builder	eventList(Consumer<Event.Builder>... eventList)	A list of event data from the session.
PutEventsRequest.Builder	eventList(Event... eventList)	A list of event data from the session.
PutEventsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
PutEventsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
PutEventsRequest.Builder	sessionId(String sessionId)	The session ID associated with the user's visit.
PutEventsRequest.Builder	trackingId(String trackingId)	The tracking ID for the event.
PutEventsRequest.Builder	userId(String userId)	The user associated with the event.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.personalizeevents.model.PersonalizeEventsRequest.Builder

build

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

trackingId

PutEventsRequest.Builder trackingId(String trackingId)

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

Parameters:

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

Returns:

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

userId

PutEventsRequest.Builder userId(String userId)

The user associated with the event.

Parameters:

userId - The user associated with the event.

Returns:

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

sessionId

PutEventsRequest.Builder sessionId(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.

Parameters:

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:

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

eventList

PutEventsRequest.Builder eventList(Collection<Event> eventList)

A list of event data from the session.

Parameters:

eventList - A list of event data from the session.

Returns:

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

eventList

PutEventsRequest.Builder eventList(Event... eventList)

A list of event data from the session.

Parameters:

eventList - A list of event data from the session.

Returns:

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

eventList

PutEventsRequest.Builder eventList(Consumer<Event.Builder>... eventList)

A list of event data from the session.

This is a convenience method that creates an instance of the Event.Builder avoiding the need to create one manually via Event.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to eventList(List<Event>).

Parameters:

eventList - a consumer that will call methods on Event.Builder

Returns:

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

See Also:

• eventList(java.util.Collection<Event>)

overrideConfiguration

PutEventsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

PutEventsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.