Class FirestoreOptions (3.28.0)

Version latest

• 3.28.0 (latest)
• 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 final class FirestoreOptions extends ServiceOptions<Firestore,FirestoreOptions>

A Factory class to create new Firestore instances.

Inheritance

Object > com.google.cloud.ServiceOptions > FirestoreOptions

Inherited Members

com.google.cloud.ServiceOptions.<B>toBuilder()

com.google.cloud.ServiceOptions.<T>getFromServiceLoader(java.lang.Class<? extends T>,T)

com.google.cloud.ServiceOptions.<T>newInstance(java.lang.String)

com.google.cloud.ServiceOptions.baseEquals(com.google.cloud.ServiceOptions<?,?>)

com.google.cloud.ServiceOptions.baseHashCode()

com.google.cloud.ServiceOptions.defaultRetrySettings()

com.google.cloud.ServiceOptions.getApiTracerFactory()

com.google.cloud.ServiceOptions.getAppEngineAppId()

com.google.cloud.ServiceOptions.getAppEngineProjectId()

com.google.cloud.ServiceOptions.getAppEngineProjectIdFromAppId()

com.google.cloud.ServiceOptions.getApplicationName()

com.google.cloud.ServiceOptions.getClientLibToken()

com.google.cloud.ServiceOptions.getClock()

com.google.cloud.ServiceOptions.getCredentials()

com.google.cloud.ServiceOptions.getDefaultHost()

com.google.cloud.ServiceOptions.getDefaultProject()

com.google.cloud.ServiceOptions.getDefaultProjectId()

com.google.cloud.ServiceOptions.getDefaultRetrySettings()

com.google.cloud.ServiceOptions.getGoogApiClientLibName()

com.google.cloud.ServiceOptions.getGoogleCloudProjectId()

com.google.cloud.ServiceOptions.getHost()

com.google.cloud.ServiceOptions.getLibraryName()

com.google.cloud.ServiceOptions.getLibraryVersion()

com.google.cloud.ServiceOptions.getMergedHeaderProvider(com.google.api.gax.rpc.HeaderProvider)

com.google.cloud.ServiceOptions.getNoRetrySettings()

com.google.cloud.ServiceOptions.getProjectId()

com.google.cloud.ServiceOptions.getQuotaProjectId()

com.google.cloud.ServiceOptions.getResolvedApiaryHost(java.lang.String)

com.google.cloud.ServiceOptions.getResolvedHost(java.lang.String)

com.google.cloud.ServiceOptions.getRetrySettings()

com.google.cloud.ServiceOptions.getRpc()

com.google.cloud.ServiceOptions.getScopedCredentials()

com.google.cloud.ServiceOptions.getScopes()

com.google.cloud.ServiceOptions.getService()

com.google.cloud.ServiceOptions.getServiceAccountProjectId()

com.google.cloud.ServiceOptions.getTransportOptions()

com.google.cloud.ServiceOptions.getUniverseDomain()

com.google.cloud.ServiceOptions.getUserAgent()

com.google.cloud.ServiceOptions.hasValidUniverseDomain()

com.google.cloud.ServiceOptions.projectIdRequired()

com.google.cloud.ServiceOptions.shouldRefreshRpc(com.google.cloud.ServiceRpc)

com.google.cloud.ServiceOptions.shouldRefreshService(ServiceT)

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDefaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder getDefaultCredentialsProviderBuilder()

Returns
Type	Description
Builder

getDefaultInstance()

public static FirestoreOptions getDefaultInstance()

Returns a default FirestoreOptions instance.

Returns
Type	Description
FirestoreOptions

getDefaultTransportChannelProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder getDefaultTransportChannelProviderBuilder()

Returns
Type	Description
Builder

getDefaultTransportOptionsBuilder()

public static GrpcTransportOptions.Builder getDefaultTransportOptionsBuilder()

Returns
Type	Description
com.google.cloud.grpc.GrpcTransportOptions.Builder

newBuilder()

public static FirestoreOptions.Builder newBuilder()

Returns
Type	Description
FirestoreOptions.Builder

Constructors

FirestoreOptions(FirestoreOptions.Builder builder)

protected FirestoreOptions(FirestoreOptions.Builder builder)

Internal Only: This feature is not stable for application use.

This class should only be extended within google-cloud-java

Parameter
Name	Description
builder	FirestoreOptions.Builder

Methods

equals(Object o)

public boolean equals(Object o)

Parameter
Name	Description
o	Object

Returns
Type	Description
boolean

Overrides

Object.equals(Object)

getCredentialsProvider()

public CredentialsProvider getCredentialsProvider()

Returns
Type	Description
CredentialsProvider

getDatabaseId()

public String getDatabaseId()

Returns
Type	Description
String

getDefaultHost()

protected String getDefaultHost()

Returns
Type	Description
String

Overrides

com.google.cloud.ServiceOptions.getDefaultHost()

getEmulatorHost()

public String getEmulatorHost()

Returns
Type	Description
String

getOpenTelemetryOptions()

public FirestoreOpenTelemetryOptions getOpenTelemetryOptions()

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.

Returns
Type	Description
FirestoreOpenTelemetryOptions

getScopes()

protected Set<String> getScopes()

Returns
Type	Description
Set<String>

Overrides

com.google.cloud.ServiceOptions.getScopes()

getTransportChannelProvider()

public TransportChannelProvider getTransportChannelProvider()

Returns
Type	Description
TransportChannelProvider

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

Object.hashCode()

projectIdRequired()

protected boolean projectIdRequired()

Returns
Type	Description
boolean

Overrides

com.google.cloud.ServiceOptions.projectIdRequired()

toBuilder()

public FirestoreOptions.Builder toBuilder()

Returns
Type	Description
FirestoreOptions.Builder

Overrides

com.google.cloud.ServiceOptions.<B>toBuilder()