org.apache.beam.sdk.extensions.ml

Class RecommendationAIPredict

java.lang.Object

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

org.apache.beam.sdk.extensions.ml.RecommendationAIPredict

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

public abstract class RecommendationAIPredict
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 creates PredictResponse.PredictionResults.

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"). A placement id for the recommendation engine placement to be used.

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.PredictResponse.PredictionResult>	SUCCESS_TAG

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

name, resourceHints

Constructor Summary

Constructors

Constructor and Description
RecommendationAIPredict()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	catalogName()
abstract java.lang.String	eventStore()
PCollectionTuple	expand(PCollection<com.google.api.client.json.GenericJson> input) Override this method to specify how this PTransform should be expanded on the given InputT.
abstract java.lang.String	placementId()
abstract java.lang.String	projectId()
RecommendationAIPredict	withCatalogName(java.lang.String catalogName)
RecommendationAIPredict	withEventStore(java.lang.String eventStore)
RecommendationAIPredict	withPlacementId(java.lang.String placementId)
RecommendationAIPredict	withProjectId(java.lang.String projectId)

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

compose, compose, getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, populateDisplayData, setResourceHints, toString, 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.PredictResponse.PredictionResult> SUCCESS_TAG

FAILURE_TAG

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

Constructor Detail

RecommendationAIPredict

public RecommendationAIPredict()

Method Detail

projectId

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

Returns:

ID of Google Cloud project to be used for creating catalog items.

catalogName

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

Returns:

Name of the catalog where the catalog items will be created.

eventStore

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

Returns:

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

placementId

public abstract java.lang.String placementId()

Returns:

ID of the recommendation engine placement.

withProjectId

public RecommendationAIPredict withProjectId(java.lang.String projectId)

withCatalogName

public RecommendationAIPredict withCatalogName(java.lang.String catalogName)

withEventStore

public RecommendationAIPredict withEventStore(java.lang.String eventStore)

withPlacementId

public RecommendationAIPredict withPlacementId(java.lang.String placementId)

expand

public PCollectionTuple expand(PCollection<com.google.api.client.json.GenericJson> input)

Description copied from class: PTransform

Override this method to specify how this PTransform should be expanded on the given InputT.

NOTE: This method should not be called directly. Instead apply the PTransform should be applied to the InputT using the apply method.

Composite transforms, which are defined in terms of other transforms, should return the output of one of the composed transforms. Non-composite transforms, which do not apply any transforms internally, should return a new unbound output and register evaluators (via backend-specific registration methods).

Specified by:

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