public static final class FirestoreV1.BatchWriteWithSummary
extends org.apache.beam.sdk.transforms.PTransform<InT,OutT>
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.
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 FormModifier and Type | Class and Description |
---|---|
static class |
FirestoreV1.BatchWriteWithSummary.Builder
A type safe builder for
FirestoreV1.BatchWriteWithSummary allowing configuration and
instantiation. |
Modifier and Type | Method and Description |
---|---|
org.apache.beam.sdk.values.PCollection<FirestoreV1.WriteSuccessSummary> |
expand(org.apache.beam.sdk.values.PCollection<com.google.firestore.v1.Write> input) |
FirestoreV1.BatchWriteWithSummary.Builder |
toBuilder()
Create a new
Builder from the current instance. |
public org.apache.beam.sdk.values.PCollection<FirestoreV1.WriteSuccessSummary> expand(org.apache.beam.sdk.values.PCollection<com.google.firestore.v1.Write> input)
expand
in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<com.google.firestore.v1.Write>,org.apache.beam.sdk.values.PCollection<FirestoreV1.WriteSuccessSummary>>
public FirestoreV1.BatchWriteWithSummary.Builder toBuilder()
Builder
from the current instance.Builder
initialized to the current state of this
instance