org.apache.beam.sdk.extensions.ml

Class RecommendationAICreateCatalogItem

java.lang.Object

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

org.apache.beam.sdk.extensions.ml.RecommendationAICreateCatalogItem

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

public abstract class RecommendationAICreateCatalogItem
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 CatalogItems. It outputs a PCollectionTuple which will contain the successfully created and failed catalog items.

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

See Also:

Serialized Form

Field Summary

Fields

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

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

annotations, displayData, name, resourceHints

Constructor Summary

Constructors

Constructor and Description
RecommendationAICreateCatalogItem()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	catalogName()
PCollectionTuple	expand(PCollection<com.google.api.client.json.GenericJson> input) The transform converts the contents of input PCollection into CatalogItems and then calls the Recommendation AI service to create the catalog item.
abstract java.lang.String	projectId()
RecommendationAICreateCatalogItem	withCatalogName(java.lang.String catalogName)
RecommendationAICreateCatalogItem	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, setDisplayData, 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.CatalogItem> SUCCESS_TAG

FAILURE_TAG

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

Constructor Detail

RecommendationAICreateCatalogItem

public RecommendationAICreateCatalogItem()

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 (defaults to "default_catalog").

withProjectId

public RecommendationAICreateCatalogItem withProjectId(java.lang.String projectId)

withCatalogName

public RecommendationAICreateCatalogItem withCatalogName(java.lang.String catalogName)

expand

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

The transform converts the contents of input PCollection into CatalogItems and then calls the Recommendation AI service to create the catalog item.

Specified by:

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

Parameters:

input - input PCollection

Returns:

PCollectionTuple with successful and failed CatalogItems