Client to bundle configuration needed for API requests.
Storescredentialsand an HTTP object so that subclasses
can pass them along to a connection class.
If no value is passed in for_http, arequests.Sessionobject
will be created and authorized with thecredentials. If not, thecredentialsand_httpneed not be related.
Callers and subclasses may seek to use the private key fromcredentialsto 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_httpobject 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 definesrequest()with the same interface asrequests.Session.request. If not passed, an_httpobject is created that is bound to thecredentialsfor the current object. This parameter should be considered private, and could change in the future.
Methods
__getstate__
__getstate__()
Explicitly state that clients are not pickleable.
close
close()
Clean up transport, if set.
Suggested use:
import contextlib
with contextlib.closing(client): # closes on exit
do_something_with(client)
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Class Client (2.4.3)\n\nVersion latestkeyboard_arrow_down\n\n- [2.4.3 (latest)](/python/docs/reference/google-cloud-core/latest/google.cloud.client.Client)\n- [2.4.2](/python/docs/reference/google-cloud-core/2.4.2/google.cloud.client.Client)\n- [2.3.3](/python/docs/reference/google-cloud-core/2.3.3/google.cloud.client.Client)\n- [2.2.3](/python/docs/reference/google-cloud-core/2.2.3/google.cloud.client.Client)\n- [2.1.0](/python/docs/reference/google-cloud-core/2.1.0/google.cloud.client.Client)\n- [2.0.0](/python/docs/reference/google-cloud-core/2.0.0/google.cloud.client.Client)\n- [1.7.2](/python/docs/reference/google-cloud-core/1.7.2/google.cloud.client.Client)\n- [1.6.0](/python/docs/reference/google-cloud-core/1.6.0/google.cloud.client.Client)\n- [1.5.0](/python/docs/reference/google-cloud-core/1.5.0/google.cloud.client.Client)\n- [1.4.4](/python/docs/reference/google-cloud-core/1.4.4/google.cloud.client.Client) \n\n Client(credentials=None, _http=None, client_options=None)\n\nClient to bundle configuration needed for API requests.\n\nStores `credentials` and an HTTP object so that subclasses\ncan pass them along to a connection class.\n\nIf no value is passed in for `_http`, a `requests.Session` object\nwill be created and authorized with the `credentials`. If not, the\n`credentials` and `_http` need not be related.\n\nCallers and subclasses may seek to use the private key from\n`credentials` to sign data.\n\nMethods\n-------\n\n### __getstate__\n\n __getstate__()\n\nExplicitly state that clients are not pickleable.\n\n### close\n\n close()\n\nClean up transport, if set.\n\nSuggested use: \n\n import contextlib\n\n with contextlib.closing(client): # closes on exit\n do_something_with(client)"]]
