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

Class FirestoreV1.ListDocuments

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<InT,OutT>

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

All Implemented Interfaces:

java.io.Serializable, org.apache.beam.sdk.transforms.display.HasDisplayData

Enclosing class:

FirestoreV1

public static final class FirestoreV1.ListDocuments
extends org.apache.beam.sdk.transforms.PTransform<InT,OutT>

Concrete class representing a PTransform<PCollection<ListDocumentsRequest>, PTransform<ListDocumentsResponse>> which will read from Firestore.

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

All request quality-of-service for an instance of this PTransform is scoped to the worker and configured via FirestoreV1.Transform.Builder.withRpcQosOptions(RpcQosOptions).

See Also:

FirestoreIO.v1(), FirestoreV1.read(), FirestoreV1.Read.listDocuments(), FirestoreV1.ListDocuments.Builder, ListDocumentsRequest, ListDocumentsResponse, google.firestore.v1.Firestore.ListDocuments, google.firestore.v1.ListDocumentsRequest, google.firestore.v1.ListDocumentsResponse, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FirestoreV1.ListDocuments.Builder A type safe builder for FirestoreV1.ListDocuments allowing configuration and instantiation.

Field Summary

Fields inherited from class org.apache.beam.sdk.transforms.PTransform

name, resourceHints

Method Summary

Modifier and Type	Method and Description
org.apache.beam.sdk.values.PCollection<com.google.firestore.v1.Document>	expand(org.apache.beam.sdk.values.PCollection<com.google.firestore.v1.ListDocumentsRequest> input)
FirestoreV1.ListDocuments.Builder	toBuilder() Create a new Builder from the current instance.

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

compose, compose, getAdditionalInputs, getDefaultOutputCoder, getDefaultOutputCoder, getDefaultOutputCoder, getKindString, getName, getResourceHints, setResourceHints, toString, validate, validate

Methods inherited from class java.lang.Object

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

Method Detail

expand

public org.apache.beam.sdk.values.PCollection<com.google.firestore.v1.Document> expand(org.apache.beam.sdk.values.PCollection<com.google.firestore.v1.ListDocumentsRequest> input)

Specified by:

expand in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<com.google.firestore.v1.ListDocumentsRequest>,org.apache.beam.sdk.values.PCollection<com.google.firestore.v1.Document>>

toBuilder

public FirestoreV1.ListDocuments.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