Method Detail

• listDocuments

  public 
  FirestoreV1.ListDocuments.Builder
   listDocuments()
  

  Factory method to create a new type safe builder for ListDocumentsRequest operations.

  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.ListDocuments PTransform is scoped to the worker and configured based on the RpcQosOptions specified via this builder.

  All logging for the built instance of FirestoreV1.ListDocuments will be sent to appender org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.ListDocuments .

  The following metrics will be available for the built instance of FirestoreV1.ListDocuments

  1. org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.ListDocuments.throttlingMs A counter tracking the number of milliseconds RPCs are throttled by Qos
  2. org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.ListDocuments.rpcFailures A counter tracking the number of failed RPCs
  3. org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.ListDocuments.rpcSuccesses A counter tracking the number of successful RPCs

  Returns:

  A new type safe builder providing configuration for processing of ListDocumentsRequest s

  See Also:

  FirestoreIO.v1() , FirestoreV1.ListDocuments , ListDocumentsRequest , ListDocumentsResponse , google.firestore.v1.Firestore.ListDocuments , google.firestore.v1.ListDocumentsRequest , google.firestore.v1.ListDocumentsResponse

• listCollectionIds

  public 
  FirestoreV1.ListCollectionIds.Builder
   listCollectionIds()
  

  Factory method to create a new type safe builder for ListCollectionIdsRequest operations.

  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.ListCollectionIds PTransform is scoped to the worker and configured based on the RpcQosOptions specified via this builder.

  All logging for the built instance of FirestoreV1.ListCollectionIds will be sent to appender org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.ListCollectionIds .

  The following metrics will be available for the built instance of FirestoreV1.ListCollectionIds

  1. org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.ListCollectionIds.throttlingMs A counter tracking the number of milliseconds RPCs are throttled by Qos
  2. org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.ListCollectionIds.rpcFailures A counter tracking the number of failed RPCs
  3. org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.ListCollectionIds.rpcSuccesses A counter tracking the number of successful RPCs

  Returns:

  A new type safe builder providing configuration for processing of ListCollectionIdsRequest s

  See Also:

  FirestoreIO.v1() , FirestoreV1.ListCollectionIds , ListCollectionIdsRequest , ListCollectionIdsResponse , google.firestore.v1.Firestore.ListCollectionIds , google.firestore.v1.ListCollectionIdsRequest , google.firestore.v1.ListCollectionIdsResponse

• batchGetDocuments

  public 
  FirestoreV1.BatchGetDocuments.Builder
   batchGetDocuments()
  

  Factory method to create a new type safe builder for BatchGetDocumentsRequest operations.

  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.BatchGetDocuments PTransform is scoped to the worker and configured based on the RpcQosOptions specified via this builder.

  All logging for the built instance of FirestoreV1.BatchGetDocuments will be sent to appender org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.BatchGetDocuments .

  The following metrics will be available for the built instance of FirestoreV1.BatchGetDocuments

  1. org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.BatchGetDocuments.throttlingMs A counter tracking the number of milliseconds RPCs are throttled by Qos
  2. org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.BatchGetDocuments.rpcFailures A counter tracking the number of failed RPCs
  3. org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.BatchGetDocuments.rpcSuccesses A counter tracking the number of successful RPCs
  4. org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.RunQuery.rpcStreamValueReceived A counter tracking the number of values received by a streaming RPC

  Returns:

  A new type safe builder providing configuration for processing of BatchGetDocumentsRequest s

  See Also:

  FirestoreIO.v1() , FirestoreV1.BatchGetDocuments , BatchGetDocumentsRequest , BatchGetDocumentsResponse , google.firestore.v1.Firestore.BatchGetDocuments , google.firestore.v1.BatchGetDocumentsRequest , google.firestore.v1.BatchGetDocumentsResponse

• runQuery

  public 
  FirestoreV1.RunQuery.Builder
   runQuery()
  

  Factory method to create a new type safe builder for RunQueryRequest operations.

  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.RunQuery PTransform is scoped to the worker and configured based on the RpcQosOptions specified via this builder.

  All logging for the built instance of FirestoreV1.RunQuery will be sent to appender org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.RunQuery .

  The following metrics will be available for the built instance of FirestoreV1.RunQuery

  1. org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.RunQuery.throttlingMs A counter tracking the number of milliseconds RPCs are throttled by Qos
  2. org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.RunQuery.rpcFailures A counter tracking the number of failed RPCs
  3. org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.RunQuery.rpcSuccesses A counter tracking the number of successful RPCs
  4. org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.RunQuery.rpcStreamValueReceived A counter tracking the number of values received by a streaming RPC

  Returns:

  A new type safe builder providing configuration for processing of RunQueryRequest s

  See Also:

  FirestoreIO.v1() , FirestoreV1.RunQuery , RunQueryRequest , RunQueryResponse , google.firestore.v1.Firestore.RunQuery , google.firestore.v1.RunQueryRequest , google.firestore.v1.RunQueryResponse

• partitionQuery

  public 
  FirestoreV1.PartitionQuery.Builder
   partitionQuery()
  

  Factory method to create a new type safe builder for PartitionQueryRequest operations.

  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.PartitionQuery 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 PartitionQueryRequest s

  See Also:

  FirestoreIO.v1() , FirestoreV1.PartitionQuery , PartitionQueryRequest , RunQueryResponse , google.firestore.v1.Firestore.PartitionQuery , google.firestore.v1.PartitionQueryRequest , google.firestore.v1.PartitionQueryResponse