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
=
'(default)'
,
client_info
=
< google
.
api_core
.
gapic_v1
.
client_info
.
ClientInfo
object
> ,
client_options
=
None
)
Client for interacting with Google Cloud Firestore API.
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.
