Module client (2.0.0)

Base classes for client used to interact with Google Cloud APIs.

Classes

Client

Client(credentials=None, _http=None, client_options=None)

Client to bundle configuration needed for API requests.

Stores credentials and an HTTP object so that subclasses can pass them along to a connection class.

If no value is passed in for _http, a requests.Session object will be created and authorized with the credentials. If not, the credentials and _http need not be related.

Callers and subclasses may seek to use the private key from credentials to sign data.

Parameters

Name	Description
credentials	`google.auth.credentials.Credentials` (Optional) The OAuth2 Credentials to use for this client. If not passed (and if no `_http` object is passed), falls back to the default inferred from the environment.
client_options	`google.api_core.client_options.ClientOptions` (Optional) Custom options for the client.
_http	`requests.Session` (Optional) HTTP object to make requests. Can be any object that defines `request()` with the same interface as `requests.Session.request`. If not passed, an `_http` object is created that is bound to the `credentials` for the current object. This parameter should be considered private, and could change in the future.

Exceptions

Type	Description
google.auth.exceptions.DefaultCredentialsError	Raised if ``credentials`` is not specified and the library fails to acquire default credentials.

ClientWithProject

ClientWithProject(project=None, credentials=None, client_options=None, _http=None)

Client that also stores a project.

Parameters

Name	Description
project	`str` the project which the client acts on behalf of. If not passed falls back to the default inferred from the environment.
credentials	`google.auth.credentials.Credentials` (Optional) The OAuth2 Credentials to use for this client. If not passed (and if no `_http` object is passed), falls back to the default inferred from the environment.
_http	`requests.Session` (Optional) HTTP object to make requests. Can be any object that defines `request()` with the same interface as `requests.Session.request`. If not passed, an `_http` object is created that is bound to the `credentials` for the current object. This parameter should be considered private, and could change in the future.

Exceptions

Type	Description
`ValueError	if the project is neither passed in nor set in the environment.