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

Class FirestoreV1.BatchWriteWithDeadLetterQueue

java.lang.Object
org.apache.beam.sdk.transforms.PTransform<PCollection<com.google.firestore.v1.Write>,PCollection<FirestoreV1.WriteFailure>>
org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.BatchWriteWithDeadLetterQueue
All Implemented Interfaces:
Serializable, HasDisplayData
Enclosing class:
FirestoreV1
public static final class FirestoreV1.BatchWriteWithDeadLetterQueue extends PTransform<PCollection<com.google.firestore.v1.Write>,PCollection<FirestoreV1.WriteFailure>>
Concrete class representing a PTransform<PCollection<Write>, PCollection<FirestoreV1.WriteFailure > which will write to Firestore. FirestoreV1.WriteFailures output by this PTransform are those writes which were not able to be applied to Cloud Firestore.

Use this BatchWrite when you do not want a failed write to error an entire bundle.

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

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:

  • Method Details

    • expand

      public PCollection<FirestoreV1.WriteFailure> 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.WriteFailure>>

    • toBuilder

      public FirestoreV1.BatchWriteWithDeadLetterQueue.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: