com.google.cloud.firestore

Class FirestoreOptions.Builder

java.lang.Object

com.google.cloud.ServiceOptions.Builder<Firestore,FirestoreOptions,FirestoreOptions.Builder>

com.google.cloud.firestore.FirestoreOptions.Builder

Enclosing class:

FirestoreOptions

public static class FirestoreOptions.Builder
extends com.google.cloud.ServiceOptions.Builder<Firestore,FirestoreOptions,FirestoreOptions.Builder>

Field Summary

Fields inherited from class com.google.cloud.ServiceOptions.Builder

credentials

Method Summary

Modifier and Type	Method and Description
FirestoreOptions	build()
FirestoreOptions.Builder	setChannelProvider(com.google.api.gax.rpc.TransportChannelProvider channelProvider) Sets the TransportChannelProvider to use with this Firestore client.
FirestoreOptions.Builder	setCredentialsProvider(com.google.api.gax.core.CredentialsProvider credentialsProvider) Sets the CredentialsProvider to use with this Firestore client.
FirestoreOptions.Builder	setDatabaseId(String databaseId) Sets the database ID to use with this Firestore client.
FirestoreOptions.Builder	setEmulatorHost(String emulatorHost) Sets the emulator host to use with this Firestore client.
FirestoreOptions.Builder	setTransportOptions(com.google.cloud.TransportOptions transportOptions) Sets the TransportOptions to use with this Firestore client.

Methods inherited from class com.google.cloud.ServiceOptions.Builder

getAllowedClientLibTokens, self, setClientLibToken, setClock, setCredentials, setHeaderProvider, setHost, setProjectId, setQuotaProjectId, setRetrySettings, setServiceFactory, setServiceRpcFactory

Methods inherited from class java.lang.Object

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

Method Detail

setTransportOptions

@Nonnull
public FirestoreOptions.Builder setTransportOptions(@Nonnull
                                                             com.google.cloud.TransportOptions transportOptions)

Sets the TransportOptions to use with this Firestore client.

Overrides:

setTransportOptions in class com.google.cloud.ServiceOptions.Builder<Firestore,FirestoreOptions,FirestoreOptions.Builder>

Parameters:

transportOptions - A GrpcTransportOptions object that defines the transport options for this client.

setChannelProvider

@Nonnull
public FirestoreOptions.Builder setChannelProvider(@Nonnull
                                                            com.google.api.gax.rpc.TransportChannelProvider channelProvider)

Sets the TransportChannelProvider to use with this Firestore client.

Parameters:

channelProvider - A InstantiatingGrpcChannelProvider object that defines the transport provider for this client.

setCredentialsProvider

@Nonnull
public FirestoreOptions.Builder setCredentialsProvider(@Nonnull
                                                                com.google.api.gax.core.CredentialsProvider credentialsProvider)

Sets the CredentialsProvider to use with this Firestore client.

Parameters:

credentialsProvider - A CredentialsProvider object that defines the credential provider for this client.

setEmulatorHost

public FirestoreOptions.Builder setEmulatorHost(@Nonnull
                                                String emulatorHost)

Sets the emulator host to use with this Firestore client. The value passed to this method will take precedent if the FIRESTORE_EMULATOR_HOST environment variable is also set.

Parameters:

emulatorHost - The Firestore emulator host to use with this client.

setDatabaseId

public FirestoreOptions.Builder setDatabaseId(@Nonnull
                                              String databaseId)

Sets the database ID to use with this Firestore client.

Parameters:

databaseId - The Firestore database ID to use with this client.

build

@Nonnull
public FirestoreOptions build()

Specified by:

build in class com.google.cloud.ServiceOptions.Builder<Firestore,FirestoreOptions,FirestoreOptions.Builder>