Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Module async_client (2.22.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 AsyncCollectionReference
a Client owns a AsyncDocumentReference

Classes

AsyncClient

AsyncClient(
    project=None,
    credentials=None,
    database=None,
    client_info=google.api_core.gapic_v1.client_info.ClientInfo,
    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.