Package com.google.cloud.storage

Class Storage.BucketListOption

java.lang.Object

com.google.cloud.storage.Option<com.google.cloud.storage.UnifiedOpts.BucketListOpt>

com.google.cloud.storage.Storage.BucketListOption

All Implemented Interfaces:

Serializable

Enclosing interface:

Storage

public static class Storage.BucketListOption
extends Option<com.google.cloud.storage.UnifiedOpts.BucketListOpt>

Class for specifying bucket list options.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
static Storage.BucketListOption[]	dedupe(Storage.BucketListOption... os)	Deduplicate any options which are the same parameter.
static Storage.BucketListOption[]	dedupe(Storage.BucketListOption[] array, Storage.BucketListOption... os)	Deduplicate any options which are the same parameter.
static Storage.BucketListOption[]	dedupe(Collection<Storage.BucketListOption> collection, Storage.BucketListOption... os)	Deduplicate any options which are the same parameter.
boolean	equals(Object o)	Deprecated.
static Storage.BucketListOption	fields(Storage.BucketField... fields)	Returns an option to specify the bucket's fields to be returned by the RPC call.
int	hashCode()	Deprecated.
static Storage.BucketListOption	pageSize(long pageSize)	Returns an option to specify the maximum number of buckets returned per page.
static Storage.BucketListOption	pageToken(@NonNull String pageToken)	Returns an option to specify the page token from which to start listing buckets.
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.
String	toString()	Deprecated.
static Storage.BucketListOption	userProject(@NonNull String userProject)	Returns an option for bucket's billing user project.

Methods inherited from class java.lang.Object

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

Method Details

pageSize

@TransportCompatibility({HTTP,GRPC})
public static Storage.BucketListOption pageSize(long pageSize)

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

pageToken

@TransportCompatibility({HTTP,GRPC})
public static Storage.BucketListOption pageToken(@NonNull String pageToken)

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

prefix

@TransportCompatibility({HTTP,GRPC})
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.

userProject

@TransportCompatibility({HTTP,GRPC})
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.

fields

@TransportCompatibility({HTTP,GRPC})
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.

dedupe

@BetaApi
public static Storage.BucketListOption[] dedupe(Storage.BucketListOption... os)

Deduplicate any options which are the same parameter. The value which comes last in os will be the value included in the return.

dedupe

@BetaApi
public static Storage.BucketListOption[] dedupe(Collection<Storage.BucketListOption> collection,
 Storage.BucketListOption... os)

Deduplicate any options which are the same parameter.

The value which comes last in collection and os will be the value included in the return. All options from os will override their counterparts in collection.

dedupe

@BetaApi
public static Storage.BucketListOption[] dedupe(Storage.BucketListOption[] array,
 Storage.BucketListOption... os)

Deduplicate any options which are the same parameter.

The value which comes last in collection and os will be the value included in the return. All options from os will override their counterparts in collection.

equals

public boolean equals(Object o)

Deprecated.

Overrides:

equals in class Object

hashCode

public int hashCode()

Deprecated.

Overrides:

hashCode in class Object

toString

public String toString()

Deprecated.

Overrides:

toString in class Object