Class Storage.BucketListOption (2.16.0)

public static class Storage.BucketListOption extends Option<UnifiedOpts.BucketListOpt>

Class for specifying bucket list options.

Inheritance

java.lang.Object > com.google.cloud.storage.UnifiedOpts.OptionShim > Option > Storage.BucketListOption

Inherited Members

com.google.cloud.storage.UnifiedOpts.OptionShim.equals(java.lang.Object)

com.google.cloud.storage.UnifiedOpts.OptionShim.hashCode()

com.google.cloud.storage.UnifiedOpts.OptionShim.toString()

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

fields(Storage.BucketField[] 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.

Parameter

Name	Description
fields	`BucketField[]`

Returns

Type	Description
Storage.BucketListOption

pageSize(long pageSize)

public static Storage.BucketListOption pageSize(long pageSize)

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

Parameter

Name	Description
pageSize	`long`

Returns

Type	Description
Storage.BucketListOption

pageToken(@NonNull String pageToken)

public static Storage.BucketListOption pageToken(@NonNull String pageToken)

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

Parameter

Name	Description
pageToken	`@org.checkerframework.checker.nullness.qual.NonNull java.lang.String`

Returns

Type	Description
Storage.BucketListOption

prefix(@NonNull String prefix)

public static Storage.BucketListOption prefix(@NonNull String prefix)

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

Parameter

Name	Description
prefix	`@org.checkerframework.checker.nullness.qual.NonNull java.lang.String`

Returns

Type	Description
Storage.BucketListOption

userProject(@NonNull String userProject)

public static Storage.BucketListOption userProject(@NonNull String userProject)

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

Parameter

Name	Description
userProject	`@org.checkerframework.checker.nullness.qual.NonNull java.lang.String`

Returns

Type	Description
Storage.BucketListOption