com.google.cloud.firestore.v1

Class FirestoreSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<FirestoreSettings>

com.google.cloud.firestore.v1.FirestoreSettings

@Generated(value="by gapic-generator")
public class FirestoreSettings
extends ClientSettings<FirestoreSettings>

Settings class to configure an instance of FirestoreClient.

The default instance has everything set to sensible defaults:

• The default service address (firestore.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object. For example, to set the total timeout of updateDocument to 30 seconds:

 
 FirestoreSettings.Builder firestoreSettingsBuilder =
     FirestoreSettings.newBuilder();
 firestoreSettingsBuilder.updateDocumentSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 FirestoreSettings firestoreSettings = firestoreSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FirestoreSettings.Builder Builder for FirestoreSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FirestoreSettings(FirestoreSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
ServerStreamingCallSettings<com.google.firestore.v1.BatchGetDocumentsRequest,com.google.firestore.v1.BatchGetDocumentsResponse>	batchGetDocumentsSettings() Returns the object with the settings used for calls to batchGetDocuments.
UnaryCallSettings<com.google.firestore.v1.BeginTransactionRequest,com.google.firestore.v1.BeginTransactionResponse>	beginTransactionSettings() Returns the object with the settings used for calls to beginTransaction.
UnaryCallSettings<com.google.firestore.v1.CommitRequest,com.google.firestore.v1.CommitResponse>	commitSettings() Returns the object with the settings used for calls to commit.
static FirestoreSettings	create(FirestoreStubSettings stub)
UnaryCallSettings<com.google.firestore.v1.CreateDocumentRequest,com.google.firestore.v1.Document>	createDocumentSettings() Returns the object with the settings used for calls to createDocument.
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<com.google.firestore.v1.DeleteDocumentRequest,Empty>	deleteDocumentSettings() Returns the object with the settings used for calls to deleteDocument.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<com.google.firestore.v1.GetDocumentRequest,com.google.firestore.v1.Document>	getDocumentSettings() Returns the object with the settings used for calls to getDocument.
PagedCallSettings<com.google.firestore.v1.ListCollectionIdsRequest,com.google.firestore.v1.ListCollectionIdsResponse,FirestoreClient.ListCollectionIdsPagedResponse>	listCollectionIdsSettings() Returns the object with the settings used for calls to listCollectionIds.
PagedCallSettings<com.google.firestore.v1.ListDocumentsRequest,com.google.firestore.v1.ListDocumentsResponse,FirestoreClient.ListDocumentsPagedResponse>	listDocumentsSettings() Returns the object with the settings used for calls to listDocuments.
StreamingCallSettings<com.google.firestore.v1.ListenRequest,com.google.firestore.v1.ListenResponse>	listenSettings() Returns the object with the settings used for calls to listen.
static FirestoreSettings.Builder	newBuilder() Returns a new builder for this class.
static FirestoreSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
UnaryCallSettings<com.google.firestore.v1.RollbackRequest,Empty>	rollbackSettings() Returns the object with the settings used for calls to rollback.
ServerStreamingCallSettings<com.google.firestore.v1.RunQueryRequest,com.google.firestore.v1.RunQueryResponse>	runQuerySettings() Returns the object with the settings used for calls to runQuery.
FirestoreSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<com.google.firestore.v1.UpdateDocumentRequest,com.google.firestore.v1.Document>	updateDocumentSettings() Returns the object with the settings used for calls to updateDocument.
StreamingCallSettings<com.google.firestore.v1.WriteRequest,com.google.firestore.v1.WriteResponse>	writeSettings() Returns the object with the settings used for calls to write.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FirestoreSettings

protected FirestoreSettings(FirestoreSettings.Builder settingsBuilder)
                     throws IOException

Throws:

IOException

Method Detail

getDocumentSettings

public UnaryCallSettings<com.google.firestore.v1.GetDocumentRequest,com.google.firestore.v1.Document> getDocumentSettings()

Returns the object with the settings used for calls to getDocument.

listDocumentsSettings

public PagedCallSettings<com.google.firestore.v1.ListDocumentsRequest,com.google.firestore.v1.ListDocumentsResponse,FirestoreClient.ListDocumentsPagedResponse> listDocumentsSettings()

Returns the object with the settings used for calls to listDocuments.

createDocumentSettings

public UnaryCallSettings<com.google.firestore.v1.CreateDocumentRequest,com.google.firestore.v1.Document> createDocumentSettings()

Returns the object with the settings used for calls to createDocument.

updateDocumentSettings

public UnaryCallSettings<com.google.firestore.v1.UpdateDocumentRequest,com.google.firestore.v1.Document> updateDocumentSettings()

Returns the object with the settings used for calls to updateDocument.

deleteDocumentSettings

public UnaryCallSettings<com.google.firestore.v1.DeleteDocumentRequest,Empty> deleteDocumentSettings()

Returns the object with the settings used for calls to deleteDocument.

batchGetDocumentsSettings

public ServerStreamingCallSettings<com.google.firestore.v1.BatchGetDocumentsRequest,com.google.firestore.v1.BatchGetDocumentsResponse> batchGetDocumentsSettings()

Returns the object with the settings used for calls to batchGetDocuments.

beginTransactionSettings

public UnaryCallSettings<com.google.firestore.v1.BeginTransactionRequest,com.google.firestore.v1.BeginTransactionResponse> beginTransactionSettings()

Returns the object with the settings used for calls to beginTransaction.

commitSettings

public UnaryCallSettings<com.google.firestore.v1.CommitRequest,com.google.firestore.v1.CommitResponse> commitSettings()

Returns the object with the settings used for calls to commit.

rollbackSettings

public UnaryCallSettings<com.google.firestore.v1.RollbackRequest,Empty> rollbackSettings()

Returns the object with the settings used for calls to rollback.

runQuerySettings

public ServerStreamingCallSettings<com.google.firestore.v1.RunQueryRequest,com.google.firestore.v1.RunQueryResponse> runQuerySettings()

Returns the object with the settings used for calls to runQuery.

writeSettings

public StreamingCallSettings<com.google.firestore.v1.WriteRequest,com.google.firestore.v1.WriteResponse> writeSettings()

Returns the object with the settings used for calls to write.

listenSettings

public StreamingCallSettings<com.google.firestore.v1.ListenRequest,com.google.firestore.v1.ListenResponse> listenSettings()

Returns the object with the settings used for calls to listen.

listCollectionIdsSettings

public PagedCallSettings<com.google.firestore.v1.ListCollectionIdsRequest,com.google.firestore.v1.ListCollectionIdsResponse,FirestoreClient.ListCollectionIdsPagedResponse> listCollectionIdsSettings()

Returns the object with the settings used for calls to listCollectionIds.

create

public static final FirestoreSettings create(FirestoreStubSettings stub)
                                      throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static FirestoreSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static FirestoreSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public FirestoreSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class ClientSettings<FirestoreSettings>