com.google.cloud.storage

Class Storage.BlobListOption

java.lang.Object

com.google.cloud.storage.Option

com.google.cloud.storage.Storage.BlobListOption

All Implemented Interfaces:

Serializable

Enclosing interface:

Storage

public static class Storage.BlobListOption
extends Option

Class for specifying blob list options.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static Storage.BlobListOption	currentDirectory() If specified, results are returned in a directory-like mode.
static Storage.BlobListOption	fields(Storage.BlobField... fields) Returns an option to specify the blob's fields to be returned by the RPC call.
static Storage.BlobListOption	pageSize(long pageSize) Returns an option to specify the maximum number of blobs returned per page.
static Storage.BlobListOption	pageToken(String pageToken) Returns an option to specify the page token from which to start listing blobs.
static Storage.BlobListOption	prefix(String prefix) Returns an option to set a prefix to filter results to blobs whose names begin with this prefix.
static Storage.BlobListOption	userProject(String userProject) Returns an option to define the billing user project.
static Storage.BlobListOption	versions(boolean versions) If set to true, lists all versions of a blob.

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.BlobListOption pageSize(long pageSize)

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

pageToken

public static Storage.BlobListOption pageToken(String pageToken)

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

prefix

public static Storage.BlobListOption prefix(String prefix)

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

currentDirectory

public static Storage.BlobListOption currentDirectory()

If specified, results are returned in a directory-like mode. Blobs whose names, after a possible prefix(String), do not contain the '/' delimiter are returned as is. Blobs whose names, after a possible prefix(String), contain the '/' delimiter, will have their name truncated after the delimiter and will be returned as Blob objects where only BlobInfo.getBlobId(), BlobInfo.getSize() and BlobInfo.isDirectory() are set. For such directory blobs, (BlobId.getGeneration() returns null), BlobInfo.getSize() returns 0 while BlobInfo.isDirectory() returns true. Duplicate directory blobs are omitted.

userProject

public static Storage.BlobListOption userProject(String userProject)

Returns an option to define the billing user project. This option is required by buckets with `requester_pays` flag enabled to assign operation costs.

Parameters:

userProject - projectId of the billing user project.

versions

public static Storage.BlobListOption versions(boolean versions)

If set to true, lists all versions of a blob. The default is false.

See Also:

Object Versioning

fields

public static Storage.BlobListOption fields(Storage.BlobField... fields)

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