com.google.cloud.firestore

Class FirestoreOptions

java.lang.Object

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

com.google.cloud.firestore.FirestoreOptions

All Implemented Interfaces:

Serializable

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

A Factory class to create new Firestore instances.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FirestoreOptions.Builder
static class	FirestoreOptions.DefaultFirestoreFactory
static class	FirestoreOptions.DefaultFirestoreRpcFactory

Field Summary

Fields inherited from class com.google.cloud.ServiceOptions

clientLibToken, CREDENTIAL_ENV_NAME, credentials

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FirestoreOptions(FirestoreOptions.Builder builder)

Method Summary

Modifier and Type	Method and Description
boolean	areTimestampsInSnapshotsEnabled() Returns whether or not DocumentSnapshots return timestamp fields as Timestamps.
boolean	equals(Object o)
com.google.api.gax.core.CredentialsProvider	getCredentialsProvider()
String	getDatabaseId()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	getDefaultCredentialsProviderBuilder()
protected String	getDefaultHost()
static FirestoreOptions	getDefaultInstance() Returns a default FirestoreOptions instance.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	getDefaultTransportChannelProviderBuilder()
static com.google.cloud.grpc.GrpcTransportOptions.Builder	getDefaultTransportOptionsBuilder()
protected Set<String>	getScopes()
com.google.api.gax.rpc.TransportChannelProvider	getTransportChannelProvider()
int	hashCode()
static FirestoreOptions.Builder	newBuilder()
protected boolean	projectIdRequired()
FirestoreOptions.Builder	toBuilder()

Methods inherited from class com.google.cloud.ServiceOptions

baseEquals, baseHashCode, defaultRetrySettings, getAppEngineAppId, getAppEngineProjectId, getAppEngineProjectIdFromAppId, getApplicationName, getClientLibToken, getClock, getCredentials, getDefaultProject, getDefaultProjectId, getDefaultRetrySettings, getFromServiceLoader, getGoogApiClientLibName, getGoogleCloudProjectId, getHost, getLibraryName, getLibraryVersion, getMergedHeaderProvider, getNoRetrySettings, getProjectId, getRetrySettings, getRpc, getScopedCredentials, getService, getServiceAccountProjectId, getTransportOptions, getUserAgent, newInstance, shouldRefreshRpc, shouldRefreshService

Methods inherited from class java.lang.Object

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

Constructor Detail

FirestoreOptions

@InternalApi(value="This class should only be extended within google-cloud-java")
protected FirestoreOptions(FirestoreOptions.Builder builder)

Method Detail

getDefaultInstance

public static FirestoreOptions getDefaultInstance()

Returns a default FirestoreOptions instance.

projectIdRequired

protected boolean projectIdRequired()

Overrides:

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

getDefaultHost

protected String getDefaultHost()

Overrides:

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

getDatabaseId

public String getDatabaseId()

getCredentialsProvider

public com.google.api.gax.core.CredentialsProvider getCredentialsProvider()

getTransportChannelProvider

public com.google.api.gax.rpc.TransportChannelProvider getTransportChannelProvider()

getDefaultTransportOptionsBuilder

@Nonnull
public static com.google.cloud.grpc.GrpcTransportOptions.Builder getDefaultTransportOptionsBuilder()

getDefaultTransportChannelProviderBuilder

@Nonnull
public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder getDefaultTransportChannelProviderBuilder()

getDefaultCredentialsProviderBuilder

@Nonnull
public static com.google.api.gax.core.GoogleCredentialsProvider.Builder getDefaultCredentialsProviderBuilder()

areTimestampsInSnapshotsEnabled

public boolean areTimestampsInSnapshotsEnabled()

Returns whether or not DocumentSnapshots return timestamp fields as Timestamps.

getScopes

protected Set<String> getScopes()

Specified by:

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

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toBuilder

@Nonnull
public FirestoreOptions.Builder toBuilder()

Specified by:

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

newBuilder

@Nonnull
public static FirestoreOptions.Builder newBuilder()