Storage.Buckets.List (Cloud Storage JSON API v1-rev20181013-1.27.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.storage.StorageRequest<Buckets>
        
        com.google.api.services.storage.Storage.Buckets.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Storage.Buckets
```
public class Storage.Buckets.List
extends StorageRequest<Buckets>
```

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(String project)
Retrieves a list of buckets for a given project.

Constructors
Modifier	Constructor and Description
`protected`	`List(String project)` Retrieves a list of buckets for a given project.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`Long`	`getMaxResults()` Maximum number of buckets to return in a single response.
`String`	`getPageToken()` A previously-returned page token representing part of the larger set of results to view.
`String`	`getPrefix()` Filter results to buckets whose names begin with this prefix.
`String`	`getProject()` A valid API project identifier.
`String`	`getProjection()` Set of properties to return.
`String`	`getUserProject()` The project to be billed for this request.
`Storage.Buckets.List`	`set(String parameterName, Object value)`
`Storage.Buckets.List`	`setAlt(String alt)` Data format for the response.
`Storage.Buckets.List`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Storage.Buckets.List`	`setKey(String key)` API key.
`Storage.Buckets.List`	`setMaxResults(Long maxResults)` Maximum number of buckets to return in a single response.
`Storage.Buckets.List`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Storage.Buckets.List`	`setPageToken(String pageToken)` A previously-returned page token representing part of the larger set of results to view.
`Storage.Buckets.List`	`setPrefix(String prefix)` Filter results to buckets whose names begin with this prefix.
`Storage.Buckets.List`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Storage.Buckets.List`	`setProject(String project)` A valid API project identifier.
`Storage.Buckets.List`	`setProjection(String projection)` Set of properties to return.
`Storage.Buckets.List`	`setQuotaUser(String quotaUser)` An opaque string that represents a user for quota purposes.
`Storage.Buckets.List`	`setUserIp(String userIp)` Deprecated.
`Storage.Buckets.List`	`setUserProject(String userProject)` The project to be billed for this request.

Methods inherited from class com.google.api.services.storage.StorageRequest
getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - List
```
protected List(String project)
```
    Retrieves a list of buckets for a given project. Create a request for the method "buckets.list". This request holds the parameters needed by the the storage server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Storage.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    project - A valid API project identifier.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Buckets>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Buckets>
    
    Throws:
    
    IOException
  - setAlt
```
public Storage.Buckets.List setAlt(String alt)
```
    Description copied from class: StorageRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class StorageRequest<Buckets>
  - setFields
```
public Storage.Buckets.List setFields(String fields)
```
    Description copied from class: StorageRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class StorageRequest<Buckets>
  - setKey
```
public Storage.Buckets.List setKey(String key)
```
    Description copied from class: StorageRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class StorageRequest<Buckets>
  - setOauthToken
```
public Storage.Buckets.List setOauthToken(String oauthToken)
```
    Description copied from class: StorageRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class StorageRequest<Buckets>
  - setPrettyPrint
```
public Storage.Buckets.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: StorageRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class StorageRequest<Buckets>
  - setQuotaUser
```
public Storage.Buckets.List setQuotaUser(String quotaUser)
```
    Description copied from class: StorageRequest
    
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class StorageRequest<Buckets>
  - setUserIp
```
public Storage.Buckets.List setUserIp(String userIp)
```
    Description copied from class: StorageRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class StorageRequest<Buckets>
  - getProject
```
public String getProject()
```
    A valid API project identifier.
  - setProject
```
public Storage.Buckets.List setProject(String project)
```
    A valid API project identifier.
  - getMaxResults
```
public Long getMaxResults()
```
    Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller. [default: 1000] [minimum: 0]
  - setMaxResults
```
public Storage.Buckets.List setMaxResults(Long maxResults)
```
    Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.
  - getPageToken
```
public String getPageToken()
```
    A previously-returned page token representing part of the larger set of results to view.
  - setPageToken
```
public Storage.Buckets.List setPageToken(String pageToken)
```
    A previously-returned page token representing part of the larger set of results to view.
  - getPrefix
```
public String getPrefix()
```
    Filter results to buckets whose names begin with this prefix.
  - setPrefix
```
public Storage.Buckets.List setPrefix(String prefix)
```
    Filter results to buckets whose names begin with this prefix.
  - getProjection
```
public String getProjection()
```
    Set of properties to return. Defaults to noAcl.
  - setProjection
```
public Storage.Buckets.List setProjection(String projection)
```
    Set of properties to return. Defaults to noAcl.
  - getUserProject
```
public String getUserProject()
```
    The project to be billed for this request.
  - setUserProject
```
public Storage.Buckets.List setUserProject(String userProject)
```
    The project to be billed for this request.
  - set
```
public Storage.Buckets.List set(String parameterName,
                                Object value)
```
    Overrides:
    
    set in class StorageRequest<Buckets>

Class Storage.Buckets.List

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.storage.StorageRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getProject

setProject

getMaxResults

setMaxResults

getPageToken

setPageToken

getPrefix

setPrefix

getProjection

setProjection

getUserProject

setUserProject

set