Class FirestoreOptions (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

Static Methods

getDefaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder getDefaultCredentialsProviderBuilder()
Returns
TypeDescription
Builder

getDefaultInstance()

public static FirestoreOptions getDefaultInstance()

Returns a default FirestoreOptions instance.

Returns
TypeDescription
FirestoreOptions

getDefaultTransportChannelProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder getDefaultTransportChannelProviderBuilder()
Returns
TypeDescription
Builder

getDefaultTransportOptionsBuilder()

public static GrpcTransportOptions.Builder getDefaultTransportOptionsBuilder()
Returns
TypeDescription
com.google.cloud.grpc.GrpcTransportOptions.Builder

newBuilder()

public static FirestoreOptions.Builder newBuilder()
Returns
TypeDescription
FirestoreOptions.Builder

Constructors

FirestoreOptions(FirestoreOptions.Builder builder)

protected FirestoreOptions(FirestoreOptions.Builder builder)
Parameter
NameDescription
builderFirestoreOptions.Builder

Methods

equals(Object o)

public boolean equals(Object o)
Parameter
NameDescription
oObject
Returns
TypeDescription
boolean
Overrides

getCredentialsProvider()

public CredentialsProvider getCredentialsProvider()
Returns
TypeDescription
CredentialsProvider

getDatabaseId()

public String getDatabaseId()
Returns
TypeDescription
String

getDefaultHost()

protected String getDefaultHost()
Returns
TypeDescription
String
Overrides
com.google.cloud.ServiceOptions.getDefaultHost()

getEmulatorHost()

public String getEmulatorHost()
Returns
TypeDescription
String

getScopes()

protected Set<String> getScopes()
Returns
TypeDescription
Set<String>
Overrides
com.google.cloud.ServiceOptions.getScopes()

getTransportChannelProvider()

public TransportChannelProvider getTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

projectIdRequired()

protected boolean projectIdRequired()
Returns
TypeDescription
boolean
Overrides
com.google.cloud.ServiceOptions.projectIdRequired()

toBuilder()

public FirestoreOptions.Builder toBuilder()
Returns
TypeDescription
FirestoreOptions.Builder
Overrides
com.google.cloud.ServiceOptions.<B>toBuilder()