Class FirestoreOptions.Builder (3.10.0)
3.38.0 (latest)
3.37.0
3.36.0
3.35.1
3.33.4
3.32.2
3.31.9
3.30.11
3.28.0
3.27.2
3.26.5
3.25.1
3.24.3
3.22.0
3.21.4
3.20.0
3.17.0
3.16.3
3.15.7
3.14.4
3.13.2
3.12.1
3.11.0
3.10.0
3.9.6
3.8.2
3.7.10
3.6.0
3.5.0
3.4.2
3.3.0
3.2.0
3.1.0
3.0.21
public static class FirestoreOptions . Builder extends ServiceOptions . Builder<Firestore , FirestoreOptions , FirestoreOptions . Builder >
Inheritance
java.lang.Object >
com.google.cloud.ServiceOptions.Builder >
FirestoreOptions.Builder
Inherited Members
com.google.cloud.ServiceOptions.Builder.build()
com.google.cloud.ServiceOptions.Builder.getAllowedClientLibTokens()
com.google.cloud.ServiceOptions.Builder.self()
com.google.cloud.ServiceOptions.Builder.setClientLibToken(java.lang.String)
com.google.cloud.ServiceOptions.Builder.setClock(com.google.api.core.ApiClock)
com.google.cloud.ServiceOptions.Builder.setCredentials(com.google.auth.Credentials)
com.google.cloud.ServiceOptions.Builder.setHeaderProvider(com.google.api.gax.rpc.HeaderProvider)
com.google.cloud.ServiceOptions.Builder.setHost(java.lang.String)
com.google.cloud.ServiceOptions.Builder.setProjectId(java.lang.String)
com.google.cloud.ServiceOptions.Builder.setQuotaProjectId(java.lang.String)
com.google.cloud.ServiceOptions.Builder.setRetrySettings(com.google.api.gax.retrying.RetrySettings)
com.google.cloud.ServiceOptions.Builder.setServiceFactory(com.google.cloud.ServiceFactory<ServiceT,OptionsT>)
com.google.cloud.ServiceOptions.Builder.setServiceRpcFactory(com.google.cloud.spi.ServiceRpcFactory<OptionsT>)
com.google.cloud.ServiceOptions.Builder.setTransportOptions(com.google.cloud.TransportOptions)
Methods
build()
public FirestoreOptions build ()
Overrides
com.google.cloud.ServiceOptions.Builder.build()
setChannelProvider(TransportChannelProvider channelProvider)
public FirestoreOptions . Builder setChannelProvider ( TransportChannelProvider channelProvider )
Parameter
Name Description
channelProviderTransportChannelProvider A InstantiatingGrpcChannelProvider object that defines the transport
provider for this client.
setCredentialsProvider(CredentialsProvider credentialsProvider)
public FirestoreOptions . Builder setCredentialsProvider ( CredentialsProvider credentialsProvider )
Parameter
Name Description
credentialsProviderCredentialsProvider A CredentialsProvider object that defines the credential provider
for this client.
setDatabaseId(String databaseId)
public FirestoreOptions . Builder setDatabaseId ( String databaseId )
Sets the database ID to use with this Firestore client.
Parameter
Name Description
databaseIdString The Firestore database ID to use with this client.
setEmulatorHost(String emulatorHost)
public FirestoreOptions . Builder setEmulatorHost ( 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.
Parameter
Name Description
emulatorHostString The Firestore emulator host to use with this client.
setTransportOptions(TransportOptions transportOptions)
public FirestoreOptions . Builder setTransportOptions ( TransportOptions transportOptions )
Sets the TransportOptions to use with this Firestore client.
Parameter
Name Description
transportOptionscom.google.cloud.TransportOptions A GrpcTransportOptions object that defines the transport options for
this client.
Overrides
com.google.cloud.ServiceOptions.Builder.setTransportOptions(com.google.cloud.TransportOptions)
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]
