Class Client (0.37.0)

0.37.0 (latest) 0.36.1 0.35.0 0.34.0 0.33.3 0.32.6 0.31.0 0.30.0 0.29.2

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

Client to bundle configuration needed for API requests.

Parameters
Name	Description
project	str (Optional) 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.
client_info	google.api_core.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	google.api_core.client_options.ClientOptions or dict (Optional) Client options used to set user options on the client. API Endpoint should be set through client_options.

Methods

config

config(config_name)

Factory constructor for config object.

Note: This will not make an HTTP request; it simply instantiates a config object owned by this client.

Parameter
Name	Description
config_name	str The name of the config to be instantiated.

Returns
Type	Description
Config	The config object created.