Class FirestoreOptions.Builder (3.32.1)
Note: Some or all of the information on this page might not apply
to Trusted Cloud. For a list of services that are available in
Trusted Cloud, see Services available for
Trusted Cloud .
Version latestkeyboard_arrow_down
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.setApiTracerFactory(com.google.api.gax.tracing.ApiTracerFactory)
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)
com.google.cloud.ServiceOptions.Builder.setUniverseDomain(java.lang.String)
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.
setOpenTelemetryOptions(FirestoreOpenTelemetryOptions openTelemetryOptions)
public FirestoreOptions . Builder setOpenTelemetryOptions ( FirestoreOpenTelemetryOptions openTelemetryOptions )
Beta
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
Sets the FirestoreOpenTelemetryOptions to be used for this Firestore instance.
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 2025-08-18 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 2025-08-18 UTC."],[],[]]
