Package 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 theGoogleCloudStorage.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classListObjectOptions.BuilderBuilder forListObjectOptions
-
Field Summary
Fields Modifier and Type Field Description static ListObjectOptionsDEFAULTList all objects in the directory.static ListObjectOptionsDEFAULT_FLAT_LISTList all objects with the prefix.static ListObjectOptionsDEFAULT_USING_START_OFFSETList objects starting from an offset.
-
Constructor Summary
Constructors Constructor Description ListObjectOptions()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description static ListObjectOptions.Builderbuilder()abstract StringgetDelimiter()Delimiter to use (typically/), otherwisenull.abstract StringgetFields()Comma separated list of object fields to include in the list response.abstract longgetMaxResults()Maximum number of results to return, unlimited if negative or zero.abstract booleanisIncludeFoldersAsPrefixes()Whether to include empty folders in the result.abstract booleanisIncludePrefix()Whether to include prefix object in the result.abstract ListObjectOptions.BuildertoBuilder()
-
-
-
Field Detail
-
DEFAULT
public static final ListObjectOptions DEFAULT
List all objects in the directory.
-
DEFAULT_USING_START_OFFSET
public static final ListObjectOptions DEFAULT_USING_START_OFFSET
List objects starting from an offset.
-
DEFAULT_FLAT_LIST
public static final ListObjectOptions DEFAULT_FLAT_LIST
List all objects with the prefix.
-
-
Method Detail
-
builder
public static ListObjectOptions.Builder builder()
-
toBuilder
public abstract ListObjectOptions.Builder toBuilder()
-
getDelimiter
@Nullable public abstract String getDelimiter()
Delimiter to use (typically/), otherwisenull.
-
isIncludePrefix
public abstract boolean isIncludePrefix()
Whether to include prefix object in the result.
-
isIncludeFoldersAsPrefixes
public abstract boolean isIncludeFoldersAsPrefixes()
Whether to include empty folders 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.
-
-