Method: googleapis.storage.v1.buckets.list

Retrieves a list of buckets for a given project.

Arguments

Parameters
maxResults

integer ( uint32 format)

Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.

pageToken

string

A previously-returned page token representing part of the larger set of results to view.

prefix

string

Filter results to buckets whose names begin with this prefix.

project

string

A valid API project identifier.

projection

enum

Set of properties to return. Defaults to noAcl.

Enum type. Can be one of the following:
full
Include all properties.
noAcl
Omit owner, acl and defaultObjectAcl properties.
userProject

string

The project to be billed for this request.

Raised exceptions

Exceptions
ConnectionError
In case of a network problem (such as DNS failure or refused connection).
HttpError
If the response status is >= 400 (excluding 429 and 503).
TimeoutError
If a long-running operation takes longer to finish than the specified timeout limit.
TypeError
If an operation or function receives an argument of the wrong type.
ValueError
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of Buckets .

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation .

YAML

 - 
  
 list 
 : 
  
 call 
 : 
  
 googleapis.storage.v1.buckets.list 
  
 args 
 : 
  
 maxResults 
 : 
  
 ... 
  
 pageToken 
 : 
  
 ... 
  
 prefix 
 : 
  
 ... 
  
 project 
 : 
  
 ... 
  
 projection 
 : 
  
 ... 
  
 userProject 
 : 
  
 ... 
  
 result 
 : 
  
 listResult 

JSON

 [ 
  
 { 
  
 "list" 
 : 
  
 { 
  
 "call" 
 : 
  
 "googleapis.storage.v1.buckets.list" 
 , 
  
 "args" 
 : 
  
 { 
  
 "maxResults" 
 : 
  
 "..." 
 , 
  
 "pageToken" 
 : 
  
 "..." 
 , 
  
 "prefix" 
 : 
  
 "..." 
 , 
  
 "project" 
 : 
  
 "..." 
 , 
  
 "projection" 
 : 
  
 "..." 
 , 
  
 "userProject" 
 : 
  
 "..." 
  
 }, 
  
 "result" 
 : 
  
 "listResult" 
  
 } 
  
 } 
 ] 
Design a Mobile Site
View Site in Mobile | Classic
Share by: