@Experimental(SOURCE_SINK)

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

Provides an API for reading from and writing to Google Cloud Firestore.

Interface Summary

Interface	Description
FirestoreOptions

Class Summary

Class	Description
FirestoreIO	FirestoreIO provides an API for reading from and writing to Google Cloud Firestore.
FirestoreV1	FirestoreV1 provides an API which provides lifecycle managed PTransforms for Cloud Firestore v1 API.
FirestoreV1.BatchGetDocuments	Concrete class representing a PTransform<PCollection<BatchGetDocumentsRequest>, PTransform<BatchGetDocumentsResponse>> which will read from Firestore.
FirestoreV1.BatchGetDocuments.Builder	A type safe builder for FirestoreV1.BatchGetDocuments allowing configuration and instantiation.
FirestoreV1.BatchWriteWithDeadLetterQueue	Concrete class representing a PTransform<PCollection<Write>, PCollection<FirestoreV1.WriteFailure > which will write to Firestore.
FirestoreV1.BatchWriteWithDeadLetterQueue.Builder	A type safe builder for FirestoreV1.BatchWriteWithDeadLetterQueue allowing configuration and instantiation.
FirestoreV1.BatchWriteWithSummary	Concrete class representing a PTransform<PCollection<Write>, PDone> which will write to Firestore.
FirestoreV1.BatchWriteWithSummary.Builder	A type safe builder for FirestoreV1.BatchWriteWithSummary allowing configuration and instantiation.
FirestoreV1.ListCollectionIds	Concrete class representing a PTransform<PCollection<ListCollectionIdsRequest>, PTransform<ListCollectionIdsResponse>> which will read from Firestore.
FirestoreV1.ListCollectionIds.Builder	A type safe builder for FirestoreV1.ListCollectionIds allowing configuration and instantiation.
FirestoreV1.ListDocuments	Concrete class representing a PTransform<PCollection<ListDocumentsRequest>, PTransform<ListDocumentsResponse >> which will read from Firestore.
FirestoreV1.ListDocuments.Builder	A type safe builder for FirestoreV1.ListDocuments allowing configuration and instantiation.
FirestoreV1.PartitionQuery	Concrete class representing a PTransform<PCollection<PartitionQueryRequest>, PTransform<RunQueryRequest>> which will read from Firestore.
FirestoreV1.PartitionQuery.Builder	A type safe builder for FirestoreV1.PartitionQuery allowing configuration and instantiation.
FirestoreV1.Read	Type safe builder factory for read operations.
FirestoreV1.RunQuery	Concrete class representing a PTransform<PCollection<RunQueryRequest>, PTransform<RunQueryResponse>> which will read from Firestore.
FirestoreV1.RunQuery.Builder	A type safe builder for FirestoreV1.RunQuery allowing configuration and instantiation.
FirestoreV1.Write	Type safe builder factory for write operations.
FirestoreV1.WriteFailure	Failure details for an attempted Write.
FirestoreV1.WriteSuccessSummary	Summary object produced when a number of writes are successfully written to Firestore in a single BatchWrite.
RpcQosOptions	Quality of Service manager options for Firestore RPCs.
RpcQosOptions.Builder	Mutable Builder class for creating instances of RpcQosOptions.

Exception Summary

Exception	Description
FirestoreV1.FailedWritesException	Exception that is thrown if one or more Writes is unsuccessful with a non-retryable status code.