Module base_client (2.19.0)

Version latest

• 2.19.0 (latest)
• 2.18.0
• 2.17.2
• 2.16.1
• 2.15.0
• 2.14.0
• 2.13.1
• 2.12.0
• 2.11.1
• 2.10.1
• 2.9.1
• 2.8.0
• 2.7.3
• 2.6.1
• 2.5.3
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.3
• 2.0.2
• 1.9.2
• 1.8.1
• 1.7.0
• 1.6.2
• 1.5.0
• 1.4.0
• 1.3.0

Client for interacting with the Google Cloud Firestore API.

This is the base from which all interactions with the API occur.

In the hierarchy of API concepts

• a Client owns a CollectionReference
• a Client owns a DocumentReference

Classes

BaseClient

BaseClient(project=None, credentials=None, database=None, client_info=<google.api_core.gapic_v1.client_info.ClientInfo object>, client_options=None)

Client for interacting with Google Cloud Firestore API.

Note: Since the Cloud Firestore API requires the gRPC transport, no _http argument is accepted by this class.

Parameters
Name	Description
project	Optional[str] The project which the client acts on behalf of. If not passed, falls back to the default inferred from the environment.
credentials	Optional[google.auth.credentials.Credentials] The OAuth2 Credentials to use for this client. If not passed, falls back to the default inferred from the environment.
database	Optional[str] The database name that the client targets. For now, DEFAULT_DATABASE (the default value) is the only valid database.
client_info	Optional[google.api_core.gapic_v1.client_info.ClientInfo] The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own library or partner tool.
client_options	Union[dict, google.api_core.client_options.ClientOptions] Client options used to set user options on the client. API Endpoint should be set through client_options.