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>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	FirestoreOptions.Builder.FakeCredentials

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	setTimestampsInSnapshotsEnabled(boolean value) Deprecated. This setting now defaults to true and will be removed in a future release. If you are already setting it to true, just remove the setting. If you are setting it to false, you should update your code to expect Timestamps instead of Dates and then remove the setting.
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, 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.

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.

setTimestampsInSnapshotsEnabled

@Deprecated
 @Nonnull
public FirestoreOptions.Builder setTimestampsInSnapshotsEnabled(boolean value)

Deprecated. This setting now defaults to true and will be removed in a future release. If you are already setting it to true, just remove the setting. If you are setting it to false, you should update your code to expect Timestamps instead of Dates and then remove the setting.

Specifies whether to use Timestamps for timestamp fields in DocumentSnapshots. This is now enabled by default and should not be disabled.

Previously, Firestore returned timestamp fields as Date but Date only supports millisecond precision, which leads to truncation and causes unexpected behavior when using a timestamp from a snapshot as a part of a subsequent query.

So now Firestore returns Timestamp values instead of Date, avoiding this kind of problem.

To opt into the old behavior of returning Dates, you can temporarily set FirestoreOptions.areTimestampsInSnapshotsEnabled() to false.

build

@Nonnull
public FirestoreOptions build()

Specified by:

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