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

Class FirestoreV1.ListDocuments.Builder

java.lang.Object

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

Enclosing class:

FirestoreV1.ListDocuments

public static final class FirestoreV1.ListDocuments.Builder
extends Object

A type safe builder for FirestoreV1.ListDocuments allowing configuration and instantiation.

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

See Also:

• FirestoreIO.v1()
• FirestoreV1.read()
• FirestoreV1.Read.listDocuments()
• FirestoreV1.ListDocuments
• ListDocumentsRequest
• ListDocumentsResponse
• google.firestore.v1.Firestore.ListDocuments
• google.firestore.v1.ListDocumentsRequest
• google.firestore.v1.ListDocumentsResponse

Method Summary

Modifier and Type	Method	Description
FirestoreV1.ListDocuments	build()	Create a new instance of Transform from the current builder state.
final FirestoreV1.ListDocuments.Builder	setDatabaseId(@Nullable String databaseId)
final FirestoreV1.ListDocuments.Builder	setProjectId(@Nullable String projectId)
final FirestoreV1.ListDocuments.Builder	withDatabaseId(@Nullable String databaseId)
final FirestoreV1.ListDocuments.Builder	withProjectId(@Nullable String projectId)
final FirestoreV1.ListDocuments.Builder	withReadTime(@Nullable Instant readTime)
final FirestoreV1.ListDocuments.Builder	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

Method Details

build

public FirestoreV1.ListDocuments build()

Create a new instance of Transform from the current builder state.

Returns:

a new instance of Transform from the current builder state.

withReadTime

public final FirestoreV1.ListDocuments.Builder withReadTime(@Nullable Instant readTime)

withProjectId

public final FirestoreV1.ListDocuments.Builder withProjectId(@Nullable String projectId)

withDatabaseId

public final FirestoreV1.ListDocuments.Builder withDatabaseId(@Nullable String databaseId)

withRpcQosOptions

public final FirestoreV1.ListDocuments.Builder 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 FirestoreV1.ListDocuments.Builder setProjectId(@Nullable String projectId)

setDatabaseId

public final FirestoreV1.ListDocuments.Builder setDatabaseId(@Nullable String databaseId)