org.apache.beam.sdk.extensions.ml

Class RecommendationAIImportUserEvents

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<KV<java.lang.String,com.google.api.client.json.GenericJson>>,PCollectionTuple>

org.apache.beam.sdk.extensions.ml.RecommendationAIImportUserEvents

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

public abstract class RecommendationAIImportUserEvents
extends PTransform<PCollection<KV<java.lang.String,com.google.api.client.json.GenericJson>>,PCollectionTuple>

A PTransform connecting to the Recommendations AI API (https://cloud.google.com/recommendations) and creating UserEvents. *

Batch size defines how many items are at once per batch (max: 5000).

The transform consumes KV of String and GenericJsons (assumed to be the user event id as key and contents as value) and outputs a PCollectionTuple which will contain the successfully created and failed user events.

It is possible to provide a catalog name to which you want to add the catalog item (defaults to "default_catalog"). It is possible to provide a event store to which you want to add the user event (defaults to "default_event_store").

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static TupleTag<com.google.cloud.recommendationengine.v1beta1.UserEvent>	FAILURE_TAG
static TupleTag<com.google.cloud.recommendationengine.v1beta1.UserEvent>	SUCCESS_TAG

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

annotations, name, resourceHints

Constructor Summary

Constructors

Constructor and Description
RecommendationAIImportUserEvents()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Integer	batchSize()
abstract @Nullable java.lang.String	catalogName()
abstract @Nullable java.lang.String	eventStore()
PCollectionTuple	expand(PCollection<KV<java.lang.String,com.google.api.client.json.GenericJson>> input) The transform converts the contents of input PCollection into UserEvents and then calls the Recommendation AI service to create the user event.
abstract Duration	maxBufferingDuration()
abstract @Nullable java.lang.String	projectId()
RecommendationAIImportUserEvents	withBatchSize(java.lang.Integer batchSize)
RecommendationAIImportUserEvents	withCatalogName(java.lang.String catalogName)
RecommendationAIImportUserEvents	withEventStore(java.lang.String eventStore)
RecommendationAIImportUserEvents	withProjectId(java.lang.String projectId)

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

addAnnotation, compose, compose, getAdditionalInputs, getAnnotations, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, populateDisplayData, setResourceHints, toString, validate, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SUCCESS_TAG

public static final TupleTag<com.google.cloud.recommendationengine.v1beta1.UserEvent> SUCCESS_TAG

FAILURE_TAG

public static final TupleTag<com.google.cloud.recommendationengine.v1beta1.UserEvent> FAILURE_TAG

Constructor Detail

RecommendationAIImportUserEvents

public RecommendationAIImportUserEvents()

Method Detail

projectId

public abstract @Nullable java.lang.String projectId()

Returns:

ID of Google Cloud project to be used for creating user events.

catalogName

public abstract @Nullable java.lang.String catalogName()

Returns:

Name of the catalog where the user events will be created.

eventStore

public abstract @Nullable java.lang.String eventStore()

Returns:

Name of the event store where the user events will be created.

batchSize

public abstract java.lang.Integer batchSize()

Returns:

Size of input elements batch to be sent in one request.

maxBufferingDuration

public abstract Duration maxBufferingDuration()

Returns:

Time limit (in processing time) on how long an incomplete batch of elements is allowed to be buffered.

withProjectId

public RecommendationAIImportUserEvents withProjectId(java.lang.String projectId)

withCatalogName

public RecommendationAIImportUserEvents withCatalogName(java.lang.String catalogName)

withEventStore

public RecommendationAIImportUserEvents withEventStore(java.lang.String eventStore)

withBatchSize

public RecommendationAIImportUserEvents withBatchSize(java.lang.Integer batchSize)

expand

public PCollectionTuple expand(PCollection<KV<java.lang.String,com.google.api.client.json.GenericJson>> input)

The transform converts the contents of input PCollection into UserEvents and then calls the Recommendation AI service to create the user event.

Specified by:

expand in class PTransform<PCollection<KV<java.lang.String,com.google.api.client.json.GenericJson>>,PCollectionTuple>

Parameters:

input - input PCollection

Returns:

PCollection after transformations