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

Class FirestoreV1.Write

java.lang.Object

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

Enclosing class:

FirestoreV1

@Immutable
public static final class FirestoreV1.Write
extends 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

Modifier and Type	Method	Description
FirestoreV1.BatchWriteWithSummary.Builder	batchWrite()
FirestoreV1.Write	withDatabaseId(String databaseId)
FirestoreV1.Write	withProjectId(String projectId)	Factory method to create a new type safe builder for Write operations.

Methods inherited from class java.lang.Object

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

Method Details

withProjectId

public FirestoreV1.Write withProjectId(String projectId)

Factory method to create a new type safe builder for Write 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 a FirestoreV1.FailedWritesException, you can instead use FirestoreV1.BatchWriteWithDeadLetterQueue which will output any failed write. FirestoreV1.BatchWriteWithDeadLetterQueue can be used by including FirestoreV1.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 the RpcQosOptions specified via this builder.

Returns:

A new type safe builder providing configuration for processing of Writes

See Also:

• FirestoreIO.v1()
• FirestoreV1.BatchWriteWithSummary
• BatchWriteRequest
• BatchWriteResponse
• google.firestore.v1.Firestore.BatchWrite
• google.firestore.v1.BatchWriteRequest
• google.firestore.v1.BatchWriteResponse

withDatabaseId

public FirestoreV1.Write withDatabaseId(String databaseId)

batchWrite

public FirestoreV1.BatchWriteWithSummary.Builder batchWrite()