Class FirestoreV1.PartitionQuery.Builder
- java.lang.Object
-
- org.apache.beam.sdk.io.gcp.firestore.FirestoreV1.PartitionQuery.Builder
-
- Enclosing class:
- FirestoreV1.PartitionQuery
public static final class FirestoreV1.PartitionQuery.Builder extends java.lang.Object
A type safe builder forFirestoreV1.PartitionQuery
allowing configuration and instantiation.This class is part of the Firestore Connector DSL, it has a type safe builder accessible via
FirestoreIO.v1()
.
read()
.
partitionQuery()
.- See Also:
FirestoreIO.v1()
,FirestoreV1.read()
,FirestoreV1.Read.partitionQuery()
,FirestoreV1.PartitionQuery
,PartitionQueryRequest
,RunQueryResponse
, google.firestore.v1.Firestore.PartitionQuery, google.firestore.v1.PartitionQueryRequest, google.firestore.v1.PartitionQueryResponse
-
-
Constructor Summary
Constructors Constructor Description Builder(org.apache.beam.sdk.io.gcp.firestore.JodaClock clock, org.apache.beam.sdk.io.gcp.firestore.FirestoreStatefulComponentFactory firestoreStatefulComponentFactory, RpcQosOptions rpcQosOptions, boolean nameOnlyQuery, @Nullable org.joda.time.Instant readTime)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FirestoreV1.PartitionQuery
build()
Create a new instance ofTransform
from the current builder state.FirestoreV1.PartitionQuery.Builder
withNameOnlyQuery()
Update produced queries to only retrieve their__name__
thereby not retrieving any fields and reducing resource requirements.BldrT
withReadTime(@Nullable org.joda.time.Instant readTime)
BldrT
withRpcQosOptions(RpcQosOptions rpcQosOptions)
Specify theRpcQosOptions
that will be used when bootstrapping the QOS of each running instance of theTransform
created by this builder.
-
-
-
Constructor Detail
-
Builder
public Builder(org.apache.beam.sdk.io.gcp.firestore.JodaClock clock, org.apache.beam.sdk.io.gcp.firestore.FirestoreStatefulComponentFactory firestoreStatefulComponentFactory, RpcQosOptions rpcQosOptions, boolean nameOnlyQuery, @Nullable org.joda.time.Instant readTime)
-
-
Method Detail
-
build
public FirestoreV1.PartitionQuery build()
Create a new instance ofTransform
from the current builder state.- Returns:
- a new instance of
Transform
from the current builder state.
-
withNameOnlyQuery
public FirestoreV1.PartitionQuery.Builder withNameOnlyQuery()
Update produced queries to only retrieve their__name__
thereby not retrieving any fields and reducing resource requirements.- Returns:
- this builder
-
withReadTime
public final BldrT withReadTime(@Nullable org.joda.time.Instant readTime)
-
withRpcQosOptions
public final BldrT withRpcQosOptions(RpcQosOptions rpcQosOptions)
Specify theRpcQosOptions
that will be used when bootstrapping the QOS of each running instance of theTransform
created by this builder.NOTE This method behaves as set, mutating the value in this builder instance.
- Parameters:
rpcQosOptions
- The QOS Options to use when bootstrapping and running the builtTransform
.- Returns:
- this builder
- See Also:
RpcQosOptions
,RpcQosOptions.defaultOptions()
,RpcQosOptions.newBuilder()
-
-