Send feedback
Module client (3.3.1) Stay organized with collections
Save and categorize content based on your preferences.
Version latest keyboard_arrow_down
Client for interacting with the Google Cloud Storage API.
Classes
Client
(
project
=
< object
object
> ,
credentials
=
None
,
_http
=
None
,
client_info
=
None
,
client_options
=
None
,
use_auth_w_custom_endpoint
=
True
,
extra_headers
=
{},
*
,
api_key
=
None
)
Client to bundle configuration needed for API requests.
project
str or None
the project which the client acts on behalf of. Will be passed when creating a topic. 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. A non-default universe domain or api endpoint should be set through client_options.
use_auth_w_custom_endpoint
bool
(Optional) Whether authentication is required under custom endpoints. If false, uses AnonymousCredentials and bypasses authentication. Defaults to True. Note this is only used when a custom endpoint is set in conjunction.
extra_headers
dict
(Optional) Custom headers to be sent with the requests attached to the client. For example, you can add custom audit logging headers.
api_key
string
(Optional) An API key. Mutually exclusive with any other credentials. This parameter is an alias for setting client_options.api_key
and will supercede any api key set in the client_options
parameter.
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["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,["# Module client (3.3.0)\n\nVersion latestkeyboard_arrow_down\n\n- [3.3.0 (latest)](/python/docs/reference/storage/latest/google.cloud.storage.client)\n- [3.2.0](/python/docs/reference/storage/3.2.0/google.cloud.storage.client)\n- [3.1.1](/python/docs/reference/storage/3.1.1/google.cloud.storage.client)\n- [3.0.0](/python/docs/reference/storage/3.0.0/google.cloud.storage.client)\n- [2.19.0](/python/docs/reference/storage/2.19.0/google.cloud.storage.client)\n- [2.17.0](/python/docs/reference/storage/2.17.0/google.cloud.storage.client)\n- [2.16.0](/python/docs/reference/storage/2.16.0/google.cloud.storage.client)\n- [2.15.0](/python/docs/reference/storage/2.15.0/google.cloud.storage.client)\n- [2.14.0](/python/docs/reference/storage/2.14.0/google.cloud.storage.client)\n- [2.13.0](/python/docs/reference/storage/2.13.0/google.cloud.storage.client)\n- [2.12.0](/python/docs/reference/storage/2.12.0/google.cloud.storage.client)\n- [2.11.0](/python/docs/reference/storage/2.11.0/google.cloud.storage.client)\n- [2.10.0](/python/docs/reference/storage/2.10.0/google.cloud.storage.client)\n- [2.9.0](/python/docs/reference/storage/2.9.0/google.cloud.storage.client)\n- [2.8.0](/python/docs/reference/storage/2.8.0/google.cloud.storage.client)\n- [2.7.0](/python/docs/reference/storage/2.7.0/google.cloud.storage.client)\n- [2.6.0](/python/docs/reference/storage/2.6.0/google.cloud.storage.client)\n- [2.5.0](/python/docs/reference/storage/2.5.0/google.cloud.storage.client)\n- [2.4.0](/python/docs/reference/storage/2.4.0/google.cloud.storage.client)\n- [2.3.0](/python/docs/reference/storage/2.3.0/google.cloud.storage.client)\n- [2.2.1](/python/docs/reference/storage/2.2.1/google.cloud.storage.client)\n- [2.1.0](/python/docs/reference/storage/2.1.0/google.cloud.storage.client)\n- [2.0.0](/python/docs/reference/storage/2.0.0/google.cloud.storage.client)\n- [1.44.0](/python/docs/reference/storage/1.44.0/google.cloud.storage.client)\n- [1.43.0](/python/docs/reference/storage/1.43.0/google.cloud.storage.client)\n- [1.42.3](/python/docs/reference/storage/1.42.3/google.cloud.storage.client)\n- [1.41.1](/python/docs/reference/storage/1.41.1/google.cloud.storage.client)\n- [1.40.0](/python/docs/reference/storage/1.40.0/google.cloud.storage.client)\n- [1.39.0](/python/docs/reference/storage/1.39.0/google.cloud.storage.client)\n- [1.38.0](/python/docs/reference/storage/1.38.0/google.cloud.storage.client)\n- [1.37.1](/python/docs/reference/storage/1.37.1/google.cloud.storage.client)\n- [1.36.2](/python/docs/reference/storage/1.36.2/google.cloud.storage.client)\n- [1.35.1](/python/docs/reference/storage/1.35.1/google.cloud.storage.client)\n- [1.34.0](/python/docs/reference/storage/1.34.0/google.cloud.storage.client)\n- [1.33.0](/python/docs/reference/storage/1.33.0/google.cloud.storage.client)\n- [1.32.0](/python/docs/reference/storage/1.32.0/google.cloud.storage.client)\n- [1.31.2](/python/docs/reference/storage/1.31.2/google.cloud.storage.client)\n- [1.30.0](/python/docs/reference/storage/1.30.0/google.cloud.storage.client)\n- [1.29.0](/python/docs/reference/storage/1.29.0/google.cloud.storage.client)\n- [1.28.1](/python/docs/reference/storage/1.28.1/google.cloud.storage.client)\n- [1.27.0](/python/docs/reference/storage/1.27.0/google.cloud.storage.client)\n- [1.26.0](/python/docs/reference/storage/1.26.0/google.cloud.storage.client)\n- [1.25.0](/python/docs/reference/storage/1.25.0/google.cloud.storage.client)\n- [1.24.1](/python/docs/reference/storage/1.24.1/google.cloud.storage.client)\n- [1.23.0](/python/docs/reference/storage/1.23.0/google.cloud.storage.client)\n- [1.22.0](/python/docs/reference/storage/1.22.0/google.cloud.storage.client)\n- [1.21.0](/python/docs/reference/storage/1.21.0/google.cloud.storage.client)\n- [1.20.0](/python/docs/reference/storage/1.20.0/google.cloud.storage.client)\n- [1.19.0](/python/docs/reference/storage/1.19.0/google.cloud.storage.client)\n- [1.18.0](/python/docs/reference/storage/1.18.0/google.cloud.storage.client)\n- [1.17.0](/python/docs/reference/storage/1.17.0/google.cloud.storage.client) \nClient for interacting with the Google Cloud Storage API.\n\nClasses\n-------\n\n### [Client](/python/docs/reference/storage/latest/google.cloud.storage.client.Client)\n\n Client(project=\u003cobject object\u003e, credentials=None, _http=None, client_info=None, client_options=None, use_auth_w_custom_endpoint=True, extra_headers={}, *, api_key=None)\n\nClient to bundle configuration needed for API requests."]]