Module client (3.2.0)

Client for interacting with the Google Cloud Storage API.

Classes

Client

Client(project=<objectobject>,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.

Parameters
NameDescription
projectstr 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.

credentialsgoogle.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.

_httprequests.Session

(Optional) HTTP object to make requests. Can be any object that definesrequest() with the same interface asrequests.Session.request. If not passed, an_http object is created that is bound to thecredentials for the current object. This parameter should be considered private, and could change in the future.

client_infogoogle.api_core.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. IfNone, then default info will be used. Generally, you only need to set this if you're developing your own library or partner tool.

client_optionsgoogle.api_core.client_options.ClientOptions ordict

(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_endpointbool

(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_headersdict

(Optional) Custom headers to be sent with the requests attached to the client. For example, you can add custom audit logging headers.

api_keystring

(Optional) An API key. Mutually exclusive with any other credentials. This parameter is an alias for settingclient_options.api_key and will supercede any api key set in theclient_options parameter.

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-29 UTC.