com.google.cloud.storage

Class Storage.BucketListOption

java.lang.Object

com.google.cloud.storage.Option

com.google.cloud.storage.Storage.BucketListOption

All Implemented Interfaces:

Serializable

Enclosing interface:

Storage

public static class Storage.BucketListOption
extends Option

Class for specifying bucket list options.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static Storage.BucketListOption	fields(Storage.BucketField... fields) Returns an option to specify the bucket's fields to be returned by the RPC call.
static Storage.BucketListOption	pageSize(long pageSize) Returns an option to specify the maximum number of buckets returned per page.
static Storage.BucketListOption	pageToken(String pageToken) Returns an option to specify the page token from which to start listing buckets.
static Storage.BucketListOption	prefix(String prefix) Returns an option to set a prefix to filter results to buckets whose names begin with this prefix.
static Storage.BucketListOption	userProject(String userProject) Returns an option for bucket's billing user project.

Methods inherited from class com.google.cloud.storage.Option

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

pageSize

public static Storage.BucketListOption pageSize(long pageSize)

Returns an option to specify the maximum number of buckets returned per page.

pageToken

public static Storage.BucketListOption pageToken(String pageToken)

Returns an option to specify the page token from which to start listing buckets.

prefix

public static Storage.BucketListOption prefix(String prefix)

Returns an option to set a prefix to filter results to buckets whose names begin with this prefix.

userProject

public static Storage.BucketListOption userProject(String userProject)

Returns an option for bucket's billing user project. This option is only used by the buckets with 'requester_pays' flag.

fields

public static Storage.BucketListOption fields(Storage.BucketField... fields)

Returns an option to specify the bucket's fields to be returned by the RPC call. If this option is not provided all bucket's fields are returned. BucketListOption.fields) can be used to specify only the fields of interest. Bucket name is always returned, even if not specified.