Package org.apache.beam.sdk.io.gcp.firestore

Class FirestoreV1.BatchWriteWithSummary

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<PCollection<com.google.firestore.v1.Write>,PCollection<FirestoreV1.WriteSuccessSummary>>

org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.BatchWriteWithSummary

All Implemented Interfaces:

Serializable, HasDisplayData

Enclosing class:

FirestoreV1

public static final class FirestoreV1.BatchWriteWithSummary
extends PTransform<PCollection<com.google.firestore.v1.Write>,PCollection<FirestoreV1.WriteSuccessSummary>>

Concrete class representing a PTransform<PCollection<Write>, PDone> which will write to Firestore.

If an error is encountered while trying to write to Cloud Firestore a FirestoreV1.FailedWritesException will be thrown. If you would like a failed write to not result in a FirestoreV1.FailedWritesException, you can instead use FirestoreV1.BatchWriteWithDeadLetterQueue which will instead output any failed write. FirestoreV1.BatchWriteWithDeadLetterQueue can be used by including FirestoreV1.BatchWriteWithSummary.Builder.withDeadLetterQueue() when constructing the write handler.

This class is part of the Firestore Connector DSL, it has a type safe builder accessible via FirestoreIO.v1().write().batchWrite().

All request quality-of-service for an instance of this PTransform is scoped to the worker and configured via FirestoreV1.Transform.Builder.withRpcQosOptions(RpcQosOptions).

Writes performed against Firestore will be ordered and grouped to maximize throughput while maintaining a high request success rate. Batch sizes will be determined by the QOS layer.

See Also:

• FirestoreIO.v1()
• FirestoreV1.write()
• FirestoreV1.Write.batchWrite()
• FirestoreV1.BatchWriteWithSummary.Builder
• FirestoreV1.BatchWriteWithDeadLetterQueue
• BatchWriteRequest
• BatchWriteResponse
• google.firestore.v1.Firestore.BatchWrite
• google.firestore.v1.BatchWriteRequest
• google.firestore.v1.BatchWriteResponse
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	FirestoreV1.BatchWriteWithSummary.Builder	A type safe builder for FirestoreV1.BatchWriteWithSummary allowing configuration and instantiation.

Field Summary

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

annotations, displayData, name, resourceHints

Constructor Summary

Constructors

Constructor	Description
BatchWriteWithSummary(org.apache.beam.sdk.io.gcp.firestore.JodaClock clock, org.apache.beam.sdk.io.gcp.firestore.FirestoreStatefulComponentFactory firestoreStatefulComponentFactory, RpcQosOptions rpcQosOptions, @Nullable String projectId, @Nullable String databaseId)

Method Summary

Modifier and Type	Method	Description
PCollection<FirestoreV1.WriteSuccessSummary>	expand(PCollection<com.google.firestore.v1.Write> input)	Override this method to specify how this PTransform should be expanded on the given InputT.
final void	populateDisplayData(DisplayData.Builder builder)	Register display data for the given transform or component.
FirestoreV1.BatchWriteWithSummary.Builder	toBuilder()	Create a new Builder from the current instance.

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

BatchWriteWithSummary

public BatchWriteWithSummary(org.apache.beam.sdk.io.gcp.firestore.JodaClock clock,
 org.apache.beam.sdk.io.gcp.firestore.FirestoreStatefulComponentFactory firestoreStatefulComponentFactory,
 RpcQosOptions rpcQosOptions,
 @Nullable String projectId,
 @Nullable String databaseId)

Method Details

expand

public PCollection<FirestoreV1.WriteSuccessSummary> expand(PCollection<com.google.firestore.v1.Write> 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.firestore.v1.Write>,PCollection<FirestoreV1.WriteSuccessSummary>>

toBuilder

public FirestoreV1.BatchWriteWithSummary.Builder toBuilder()

Create a new Builder from the current instance.

Returns:

a new instance of a Builder initialized to the current state of this instance

populateDisplayData

public final void populateDisplayData(DisplayData.Builder builder)

Description copied from class: PTransform

Register display data for the given transform or component.

populateDisplayData(DisplayData.Builder) is invoked by Pipeline runners to collect display data via DisplayData.from(HasDisplayData). Implementations may call super.populateDisplayData(builder) in order to register display data in the current namespace, but should otherwise use subcomponent.populateDisplayData(builder) to use the namespace of the subcomponent.

By default, does not register any display data. Implementors may override this method to provide their own display data.

Specified by:

populateDisplayData in interface HasDisplayData

Overrides:

populateDisplayData in class PTransform<InT extends PInput,OutT extends POutput>

Parameters:

builder - The builder to populate with display data.

See Also:

• HasDisplayData