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 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	setTimestampsInSnapshotsEnabled(boolean value) Enables the use of Timestamps for timestamp fields in DocumentSnapshots.
FirestoreOptions.Builder	setTransportOptions(TransportOptions transportOptions) Sets the TransportOptions to use with this Firestore client.

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

self, 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
                                                             TransportOptions transportOptions)

Sets the TransportOptions to use with this Firestore client.

Overrides:

setTransportOptions in class 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

@Nonnull
public FirestoreOptions.Builder setTimestampsInSnapshotsEnabled(boolean value)

Enables the use of Timestamps for timestamp fields in DocumentSnapshots.

Currently, Firestore returns 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.

Setting setTimestampsInSnapshotsEnabled(true) will cause Firestore to return Timestamp values instead of Date, avoiding this kind of problem. To make this work you must also change any code that uses Date to use Timestamp instead.

NOTE: in the future FirestoreOptions.areTimestampsInSnapshotsEnabled() will default to true and this option will be removed so you should change your code to use Timestamp now and opt-in to this new behavior as soon as you can.

Returns:

A settings object on which the return type for timestamp fields is configured as specified by the given value.

build

@Nonnull
public FirestoreOptions build()

Specified by:

build in class ServiceOptions.Builder<Firestore,FirestoreOptions,FirestoreOptions.Builder>