Package org.apache.beam.sdk.extensions.ml

Class RecommendationAIWriteUserEvent

java.lang.Object

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

org.apache.beam.sdk.extensions.ml.RecommendationAIWriteUserEvent

All Implemented Interfaces:

Serializable, HasDisplayData

public abstract class RecommendationAIWriteUserEvent
extends PTransform<PCollection<com.google.api.client.json.GenericJson>,PCollectionTuple>

A PTransform using the Recommendations AI API (https://cloud.google.com/recommendations). Takes an input PCollection of GenericJsons and converts them to and creates UserEvents.

It is possible to provide a catalog name to which you want to add the user event (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	Description
static final TupleTag<com.google.cloud.recommendationengine.v1beta1.UserEvent>	FAILURE_TAG
static final TupleTag<com.google.cloud.recommendationengine.v1beta1.UserEvent>	SUCCESS_TAG

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

annotations, displayData, name, resourceHints

Constructor Summary

Constructors

Constructor	Description
RecommendationAIWriteUserEvent()

Method Summary

Modifier and Type	Method	Description
abstract String	catalogName()	Returns name of the catalog where the user events will be created.
abstract String	eventStore()	Returns name of the event store where the user events will be created.
PCollectionTuple	expand(PCollection<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 String	projectId()	Returns ID of Google Cloud project to be used for creating user events.
RecommendationAIWriteUserEvent	withCatalogName(String catalogName)
RecommendationAIWriteUserEvent	withEventStore(String eventStore)
RecommendationAIWriteUserEvent	withProjectId(String projectId)

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

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

Methods inherited from class java.lang.Object

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

Field Details

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 Details

RecommendationAIWriteUserEvent

public RecommendationAIWriteUserEvent()

Method Details

projectId

@Nullable
public abstract String projectId()

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

catalogName

@Nullable
public abstract String catalogName()

Returns name of the catalog where the user events will be created.

eventStore

@Nullable
public abstract String eventStore()

Returns name of the event store where the user events will be created.

expand

public PCollectionTuple expand(PCollection<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<com.google.api.client.json.GenericJson>,PCollectionTuple>

Parameters:

input - input PCollection

Returns:

PCollectionTuple with successful and failed UserEvents

withProjectId

public RecommendationAIWriteUserEvent withProjectId(String projectId)

withCatalogName

public RecommendationAIWriteUserEvent withCatalogName(String catalogName)

withEventStore

public RecommendationAIWriteUserEvent withEventStore(String eventStore)