Send feedback
Class FirestoreStubSettings (3.4.2)
Stay organized with collections
Save and categorize content based on your preferences.
Version 3.4.2 keyboard_arrow_down
public class FirestoreStubSettings extends StubSettings<FirestoreStubSettings>
Settings class to configure an instance of FirestoreStub .
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 getDocument to 30 seconds:
// This snippet has been automatically generated for illustrative purposes only.
// It may require modifications to work in your environment.
FirestoreStubSettings . Builder firestoreSettingsBuilder = FirestoreStubSettings . newBuilder ();
firestoreSettingsBuilder
. getDocumentSettings ()
. setRetrySettings (
firestoreSettingsBuilder
. getDocumentSettings ()
. getRetrySettings ()
. toBuilder ()
. setTotalTimeout ( Duration . ofSeconds ( 30 ))
. build ());
FirestoreStubSettings firestoreSettings = firestoreSettingsBuilder . build ();
Static Methods
public static ApiClientHeaderProvider . Builder defaultApiClientHeaderProviderBuilder ()
Returns
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider . Builder defaultCredentialsProviderBuilder ()
Returns a builder for the default credentials for this service.
Returns
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider . Builder defaultExecutorProviderBuilder ()
Returns a builder for the default ExecutorProvider for this service.
Returns
public static ApiClientHeaderProvider . Builder defaultGrpcApiClientHeaderProviderBuilder ()
Returns
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider . Builder defaultGrpcTransportProviderBuilder ()
Returns a builder for the default gRPC ChannelProvider for this service.
Returns
public static ApiClientHeaderProvider . Builder defaultHttpJsonApiClientHeaderProviderBuilder ()
Returns
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider . Builder defaultHttpJsonTransportProviderBuilder ()
Returns a builder for the default REST ChannelProvider for this service.
Returns
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider ()
Returns
getDefaultEndpoint()
public static String getDefaultEndpoint ()
Returns the default service endpoint.
Returns
getDefaultMtlsEndpoint()
public static String getDefaultMtlsEndpoint ()
Returns the default mTLS service endpoint.
Returns
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes ()
Returns the default service scopes.
Returns
newBuilder()
public static FirestoreStubSettings . Builder newBuilder ()
Returns a new gRPC builder for this class.
Returns
newBuilder(ClientContext clientContext)
public static FirestoreStubSettings . Builder newBuilder ( ClientContext clientContext )
Returns a new builder for this class.
Parameter
Returns
newHttpJsonBuilder()
public static FirestoreStubSettings . Builder newHttpJsonBuilder ()
Returns a new REST builder for this class.
Returns
Constructors
FirestoreStubSettings(FirestoreStubSettings.Builder settingsBuilder)
protected FirestoreStubSettings ( FirestoreStubSettings . Builder settingsBuilder )
Parameter
Methods
batchGetDocumentsSettings()
public ServerStreamingCallSettings<BatchGetDocumentsRequest , BatchGetDocumentsResponse > batchGetDocumentsSettings ()
Returns the object with the settings used for calls to batchGetDocuments.
Returns
batchWriteSettings()
public UnaryCallSettings<BatchWriteRequest , BatchWriteResponse > batchWriteSettings ()
Returns the object with the settings used for calls to batchWrite.
Returns
beginTransactionSettings()
public UnaryCallSettings<BeginTransactionRequest , BeginTransactionResponse > beginTransactionSettings ()
Returns the object with the settings used for calls to beginTransaction.
Returns
commitSettings()
public UnaryCallSettings<CommitRequest , CommitResponse > commitSettings ()
Returns the object with the settings used for calls to commit.
Returns
createDocumentSettings()
public UnaryCallSettings<CreateDocumentRequest , Document > createDocumentSettings ()
Returns the object with the settings used for calls to createDocument.
Returns
createStub()
public FirestoreStub createStub ()
Returns
Exceptions
deleteDocumentSettings()
public UnaryCallSettings<DeleteDocumentRequest , Empty > deleteDocumentSettings ()
Returns the object with the settings used for calls to deleteDocument.
Returns
getDocumentSettings()
public UnaryCallSettings<GetDocumentRequest , Document > getDocumentSettings ()
Returns the object with the settings used for calls to getDocument.
Returns
listCollectionIdsSettings()
public PagedCallSettings<ListCollectionIdsRequest , ListCollectionIdsResponse , FirestoreClient . ListCollectionIdsPagedResponse > listCollectionIdsSettings ()
Returns the object with the settings used for calls to listCollectionIds.
Returns
listDocumentsSettings()
public PagedCallSettings<ListDocumentsRequest , ListDocumentsResponse , FirestoreClient . ListDocumentsPagedResponse > listDocumentsSettings ()
Returns the object with the settings used for calls to listDocuments.
Returns
listenSettings()
public StreamingCallSettings<ListenRequest , ListenResponse > listenSettings ()
Returns the object with the settings used for calls to listen.
Returns
partitionQuerySettings()
public PagedCallSettings<PartitionQueryRequest , PartitionQueryResponse , FirestoreClient . PartitionQueryPagedResponse > partitionQuerySettings ()
Returns the object with the settings used for calls to partitionQuery.
Returns
rollbackSettings()
public UnaryCallSettings<RollbackRequest , Empty > rollbackSettings ()
Returns the object with the settings used for calls to rollback.
Returns
runQuerySettings()
public ServerStreamingCallSettings<RunQueryRequest , RunQueryResponse > runQuerySettings ()
Returns the object with the settings used for calls to runQuery.
Returns
toBuilder()
public FirestoreStubSettings . Builder toBuilder ()
Returns a builder containing all the values of this settings class.
Returns
Overrides
updateDocumentSettings()
public UnaryCallSettings<UpdateDocumentRequest , Document > updateDocumentSettings ()
Returns the object with the settings used for calls to updateDocument.
Returns
writeSettings()
public StreamingCallSettings<WriteRequest , WriteResponse > writeSettings ()
Returns the object with the settings used for calls to write.
Returns
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-28 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-28 UTC."],[],[]]
