org.apache.beam.sdk.extensions.ml

Class RecommendationAIImportCatalogItems

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.RecommendationAIImportCatalogItems

All Implemented Interfaces:

java.io.Serializable, HasDisplayData

public abstract class RecommendationAIImportCatalogItems
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 CatalogItems. *

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

The transform consumes KV of String and GenericJsons (assumed to be the catalog item id as key and contents as value) and 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, name, resourceHints

Constructor Summary

Constructors

Constructor and Description
RecommendationAIImportCatalogItems()

Method Summary

Modifier and Type	Method and Description
abstract java.lang.Integer	batchSize()
abstract @Nullable java.lang.String	catalogName()
PCollectionTuple	expand(PCollection<KV<java.lang.String,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 Duration	maxBufferingDuration()
abstract @Nullable java.lang.String	projectId()
RecommendationAIImportCatalogItems	withBatchSize(java.lang.Integer batchSize)
RecommendationAIImportCatalogItems	withCatalogName(java.lang.String catalogName)
RecommendationAIImportCatalogItems	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.CatalogItem> SUCCESS_TAG

FAILURE_TAG

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

Constructor Detail

RecommendationAIImportCatalogItems

public RecommendationAIImportCatalogItems()

Method Detail

projectId

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

Returns:

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

catalogName

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

Returns:

Name of the catalog where the catalog items 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 RecommendationAIImportCatalogItems withProjectId(java.lang.String projectId)

withCatalogName

public RecommendationAIImportCatalogItems withCatalogName(java.lang.String catalogName)

withBatchSize

public RecommendationAIImportCatalogItems 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 CatalogItems and then calls the Recommendation AI service to create the catalog item.

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