Send feedback
Module async_client (2.2.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.2.0 keyboard_arrow_down
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
AsyncCollectionReference
a Client owns a
AsyncDocumentReference
Classes
AsyncClient(project=None, credentials=None, database='(default)', 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.
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 2024-08-21 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
Need to tell us more?
{
"lastModified": "Last updated 2024-08-21 UTC.",
"confidential": False
}