Package com.google.cloud.firestore.v1.stub (3.3.0)

Classes

FirestoreAdminStub

Base stub class for the FirestoreAdmin service API.

This class is for advanced usage and reflects the underlying API directly.

FirestoreAdminStubSettings

Settings class to configure an instance of FirestoreAdminStub.

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 getIndex to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 FirestoreAdminStubSettings.Builder firestoreAdminSettingsBuilder =
     FirestoreAdminStubSettings.newBuilder();
 firestoreAdminSettingsBuilder
     .getIndexSettings()
     .setRetrySettings(
         firestoreAdminSettingsBuilder
             .getIndexSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 FirestoreAdminStubSettings firestoreAdminSettings = firestoreAdminSettingsBuilder.build();

FirestoreAdminStubSettings.Builder

Builder for FirestoreAdminStubSettings.

FirestoreStub

Base stub class for the Firestore service API.

This class is for advanced usage and reflects the underlying API directly.

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();

FirestoreStubSettings.Builder

Builder for FirestoreStubSettings.

GrpcFirestoreAdminCallableFactory

gRPC callable factory implementation for the FirestoreAdmin service API.

This class is for advanced usage.

GrpcFirestoreAdminStub

gRPC stub implementation for the FirestoreAdmin service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcFirestoreCallableFactory

gRPC callable factory implementation for the Firestore service API.

This class is for advanced usage.

GrpcFirestoreStub

gRPC stub implementation for the Firestore service API.

This class is for advanced usage and reflects the underlying API directly.