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

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 for FirestoreV1.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, @Nullable java.lang.String projectId, @Nullable java.lang.String databaseId)

Method Summary

Modifier and Type	Method	Description
FirestoreV1.PartitionQuery	build()	Create a new instance of Transform from the current builder state.
BldrT	setDatabaseId(@Nullable java.lang.String databaseId)
BldrT	setProjectId(@Nullable java.lang.String projectId)
BldrT	withDatabaseId(@Nullable java.lang.String databaseId)
FirestoreV1.PartitionQuery.Builder	withNameOnlyQuery()	Update produced queries to only retrieve their __name__ thereby not retrieving any fields and reducing resource requirements.
BldrT	withProjectId(@Nullable java.lang.String projectId)
BldrT	withReadTime(@Nullable org.joda.time.Instant readTime)
BldrT	withRpcQosOptions(RpcQosOptions rpcQosOptions)	Specify the RpcQosOptions that will be used when bootstrapping the QOS of each running instance of the Transform created by this builder.

Methods inherited from class java.lang.Object

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

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,
               @Nullable java.lang.String projectId,
               @Nullable java.lang.String databaseId)

Method Detail

build

public FirestoreV1.PartitionQuery build()

Create a new instance of Transform 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)

withProjectId

public final BldrT withProjectId(@Nullable java.lang.String projectId)

withDatabaseId

public final BldrT withDatabaseId(@Nullable java.lang.String databaseId)

withRpcQosOptions

public final BldrT withRpcQosOptions(RpcQosOptions rpcQosOptions)

Specify the RpcQosOptions that will be used when bootstrapping the QOS of each running instance of the Transform 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 built Transform.

Returns:

this builder

See Also:

RpcQosOptions, RpcQosOptions.defaultOptions(), RpcQosOptions.newBuilder()

setProjectId

public final BldrT setProjectId(@Nullable java.lang.String projectId)

setDatabaseId

public final BldrT setDatabaseId(@Nullable java.lang.String databaseId)