com.google.cloud.hadoop.gcsio

Class ListObjectOptions

java.lang.Object

com.google.cloud.hadoop.gcsio.ListObjectOptions

public abstract class ListObjectOptions
extends Object

Options that can be specified when listing objects in the GoogleCloudStorage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListObjectOptions.Builder Builder for ListObjectOptions

Field Summary

Fields

Modifier and Type	Field and Description
static ListObjectOptions	DEFAULT List all objects in the directory.
static ListObjectOptions	DEFAULT_FLAT_LIST List all objects with the prefix.

Constructor Summary

Constructors

Constructor and Description
ListObjectOptions()

Method Summary

Modifier and Type	Method and Description
static ListObjectOptions.Builder	builder()
abstract String	getDelimiter() Delimiter to use (typically /), otherwise null.
abstract String	getFields() Comma separated list of object fields to include in the list response.
abstract long	getMaxResults() Maximum number of results to return, unlimited if negative or zero.
abstract boolean	isIncludePrefix() Whether to include prefix object in the result.
abstract ListObjectOptions.Builder	toBuilder()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT

public static final ListObjectOptions DEFAULT

List all objects in the directory.

DEFAULT_FLAT_LIST

public static final ListObjectOptions DEFAULT_FLAT_LIST

List all objects with the prefix.

Constructor Detail

ListObjectOptions

public ListObjectOptions()

Method Detail

builder

public static ListObjectOptions.Builder builder()

toBuilder

public abstract ListObjectOptions.Builder toBuilder()

getDelimiter

@Nullable
public abstract String getDelimiter()

Delimiter to use (typically /), otherwise null.

isIncludePrefix

public abstract boolean isIncludePrefix()

Whether to include prefix object in the result.

getMaxResults

public abstract long getMaxResults()

Maximum number of results to return, unlimited if negative or zero.

getFields

@Nullable
public abstract String getFields()

Comma separated list of object fields to include in the list response.

See object resource for reference.