Class FirestoreV1.Write
- java.lang.Object
-
- org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.Write
-
- Enclosing class:
- FirestoreV1
@Experimental(SOURCE_SINK) @Immutable public static final class FirestoreV1.Write extends java.lang.Object
Type safe builder factory for write operations.This class is part of the Firestore Connector DSL and should be accessed via
FirestoreIO.v1().write()
.This class provides access to a set of type safe builders for supported write operations available in the Firestore V1 API accessed through
FirestoreStub
. Each builder allows configuration before creating an immutable instance which can be used in your pipeline.- See Also:
FirestoreIO.v1()
,FirestoreV1.write()
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FirestoreV1.BatchWriteWithSummary.Builder
batchWrite()
Factory method to create a new type safe builder forWrite
operations.
-
-
-
Method Detail
-
batchWrite
public FirestoreV1.BatchWriteWithSummary.Builder batchWrite()
Factory method to create a new type safe builder forWrite
operations.By default, when 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 aFirestoreV1.FailedWritesException
, you can instead useFirestoreV1.BatchWriteWithDeadLetterQueue
which will output any failed write.FirestoreV1.BatchWriteWithDeadLetterQueue
can be used by includingFirestoreV1.BatchWriteWithSummary.Builder.withDeadLetterQueue()
when constructing the write handler.This method is part of the Firestore Connector DSL and should be accessed via
FirestoreIO.v1()
.All request quality-of-service for the built
FirestoreV1.BatchWriteWithSummary
PTransform is scoped to the worker and configured based on theRpcQosOptions
specified via this builder.- Returns:
- A new type safe builder providing configuration for processing of
Write
s - See Also:
FirestoreIO.v1()
,FirestoreV1.BatchWriteWithSummary
,BatchWriteRequest
,BatchWriteResponse
, google.firestore.v1.Firestore.BatchWrite, google.firestore.v1.BatchWriteRequest, google.firestore.v1.BatchWriteResponse
-
-