Module client (2.17.0)

Client for interacting with the Google Cloud Storage API.

Classes

Client

  Client 
 ( 
 project 
 = 
< object 
 object 
> , 
 credentials 
 = 
 None 
 , 
 _http 
 = 
 None 
 , 
 client_info 
 = 
 None 
 , 
 client_options 
 = 
 None 
 , 
 use_auth_w_custom_endpoint 
 = 
 True 
 , 
 extra_headers 
 = 
 {}) 
 

Client to bundle configuration needed for API requests.

Parameters
Name
Description
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.

Create a Mobile Website
View Site in Mobile | Classic
Share by: