software.amazon.awssdk.services.personalizeevents.model

Interface Event.Builder

All Superinterfaces:

Buildable, CopyableBuilder<Event.Builder,Event>, SdkBuilder<Event.Builder,Event>, SdkPojo

Enclosing class:

Event

public static interface Event.Builder
extends SdkPojo, CopyableBuilder<Event.Builder,Event>

Method Summary

Modifier and Type	Method and Description
Event.Builder	eventId(String eventId) An ID associated with the event.
Event.Builder	eventType(String eventType) The type of event, such as click or download.
Event.Builder	eventValue(Float eventValue) The event value that corresponds to the EVENT_VALUE field of the Interactions schema.
Event.Builder	impression(Collection<String> impression) A list of item IDs that represents the sequence of items you have shown the user.
Event.Builder	impression(String... impression) A list of item IDs that represents the sequence of items you have shown the user.
Event.Builder	itemId(String itemId) The item ID key that corresponds to the ITEM_ID field of the Interactions schema.
default Event.Builder	metricAttribution(Consumer<MetricAttribution.Builder> metricAttribution) Contains information about the metric attribution associated with an event.
Event.Builder	metricAttribution(MetricAttribution metricAttribution) Contains information about the metric attribution associated with an event.
Event.Builder	properties(String properties) A string map of event-specific data that you might choose to record.
Event.Builder	recommendationId(String recommendationId) The ID of the list of recommendations that contains the item the user interacted with.
Event.Builder	sentAt(Instant sentAt) The timestamp (in Unix time) on the client side when the event occurred.

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

eventId

Event.Builder eventId(String eventId)

An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinquish unique events. Any subsequent events after the first with the same event ID are not used in model training.

Parameters:

eventId - An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinquish unique events. Any subsequent events after the first with the same event ID are not used in model training.

Returns:

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

eventType

Event.Builder eventType(String eventType)

The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of your Interactions schema and depends on the types of events you are tracking.

Parameters:

eventType - The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of your Interactions schema and depends on the types of events you are tracking.

Returns:

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

eventValue

Event.Builder eventValue(Float eventValue)

The event value that corresponds to the EVENT_VALUE field of the Interactions schema.

Parameters:

eventValue - The event value that corresponds to the EVENT_VALUE field of the Interactions schema.

Returns:

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

itemId

Event.Builder itemId(String itemId)

The item ID key that corresponds to the ITEM_ID field of the Interactions schema.

Parameters:

itemId - The item ID key that corresponds to the ITEM_ID field of the Interactions schema.

Returns:

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

properties

Event.Builder properties(String properties)

A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, other than movie ID (itemId) and rating (eventValue) , you might also send the number of movie ratings made by the user.

Each item in the map consists of a key-value pair. For example,

{"numberOfRatings": "12"}

The keys use camel case names that match the fields in the Interactions schema. In the above example, the numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema.

Parameters:

properties - A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, other than movie ID (itemId) and rating (eventValue) , you might also send the number of movie ratings made by the user.

Each item in the map consists of a key-value pair. For example,

{"numberOfRatings": "12"}

The keys use camel case names that match the fields in the Interactions schema. In the above example, the numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema.

Returns:

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

sentAt

Event.Builder sentAt(Instant sentAt)

The timestamp (in Unix time) on the client side when the event occurred.

Parameters:

sentAt - The timestamp (in Unix time) on the client side when the event occurred.

Returns:

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

recommendationId

Event.Builder recommendationId(String recommendationId)

The ID of the list of recommendations that contains the item the user interacted with. Provide a recommendationId to have Amazon Personalize implicitly record the recommendations you show your user as impressions data. Or provide a recommendationId if you use a metric attribution to measure the impact of recommendations.

For more information on recording impressions data, see Recording impressions data. For more information on creating a metric attribution see Measuring impact of recommendations.

Parameters:

recommendationId - The ID of the list of recommendations that contains the item the user interacted with. Provide a recommendationId to have Amazon Personalize implicitly record the recommendations you show your user as impressions data. Or provide a recommendationId if you use a metric attribution to measure the impact of recommendations.

For more information on recording impressions data, see Recording impressions data. For more information on creating a metric attribution see Measuring impact of recommendations.

Returns:

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

impression

Event.Builder impression(Collection<String> impression)

A list of item IDs that represents the sequence of items you have shown the user. For example, ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions data for an event. For more information on recording impressions data, see Recording impressions data.

Parameters:

impression - A list of item IDs that represents the sequence of items you have shown the user. For example, ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions data for an event. For more information on recording impressions data, see Recording impressions data.

Returns:

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

impression

Event.Builder impression(String... impression)

A list of item IDs that represents the sequence of items you have shown the user. For example, ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions data for an event. For more information on recording impressions data, see Recording impressions data.

Parameters:

impression - A list of item IDs that represents the sequence of items you have shown the user. For example, ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions data for an event. For more information on recording impressions data, see Recording impressions data.

Returns:

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

metricAttribution

Event.Builder metricAttribution(MetricAttribution metricAttribution)

Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.

Parameters:

metricAttribution - Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.

Returns:

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

metricAttribution

default Event.Builder metricAttribution(Consumer<MetricAttribution.Builder> metricAttribution)

Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metricAttribution(MetricAttribution).

Parameters:

metricAttribution - a consumer that will call methods on MetricAttribution.Builder

Returns:

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

See Also:

metricAttribution(MetricAttribution)