com.google.storage.v2

Interface ListObjectsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ListObjectsRequest, ListObjectsRequest.Builder

public interface ListObjectsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getDelimiter() If set, returns results in a directory-like mode.
com.google.protobuf.ByteString	getDelimiterBytes() If set, returns results in a directory-like mode.
boolean	getIncludeTrailingDelimiter() If true, objects that end in exactly one instance of `delimiter` will have their metadata included in `items` in addition to `prefixes`.
String	getLexicographicEnd() Optional.
com.google.protobuf.ByteString	getLexicographicEndBytes() Optional.
String	getLexicographicStart() Optional.
com.google.protobuf.ByteString	getLexicographicStartBytes() Optional.
int	getPageSize() Maximum number of `items` plus `prefixes` to return in a single page of responses.
String	getPageToken() A previously-returned page token representing part of the larger set of results to view.
com.google.protobuf.ByteString	getPageTokenBytes() A previously-returned page token representing part of the larger set of results to view.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
String	getPrefix() Filter results to objects whose names begin with this prefix.
com.google.protobuf.ByteString	getPrefixBytes() Filter results to objects whose names begin with this prefix.
com.google.protobuf.FieldMask	getReadMask() Mask specifying which fields to read from each result.
com.google.protobuf.FieldMaskOrBuilder	getReadMaskOrBuilder() Mask specifying which fields to read from each result.
boolean	getVersions() If `true`, lists all versions of an object as distinct results.
boolean	hasReadMask() Mask specifying which fields to read from each result.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

 Required. Name of the bucket in which to look for objects.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The parent.

getParentBytes

com.google.protobuf.ByteString getParentBytes()

 Required. Name of the bucket in which to look for objects.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for parent.

getPageSize

int getPageSize()

 Maximum number of `items` plus `prefixes` to return
 in a single page of responses. As duplicate `prefixes` are
 omitted, fewer total results may be returned than requested. The service
 will use this parameter or 1,000 items, whichever is smaller.
 

int32 page_size = 2;

Returns:

The pageSize.

getPageToken

String getPageToken()

 A previously-returned page token representing part of the larger set of
 results to view.
 

string page_token = 3;

Returns:

The pageToken.

getPageTokenBytes

com.google.protobuf.ByteString getPageTokenBytes()

 A previously-returned page token representing part of the larger set of
 results to view.
 

string page_token = 3;

Returns:

The bytes for pageToken.

getDelimiter

String getDelimiter()

 If set, returns results in a directory-like mode. `items` will contain
 only objects whose names, aside from the `prefix`, do not
 contain `delimiter`. Objects whose names, aside from the
 `prefix`, contain `delimiter` will have their name,
 truncated after the `delimiter`, returned in
 `prefixes`. Duplicate `prefixes` are omitted.
 

string delimiter = 4;

Returns:

The delimiter.

getDelimiterBytes

com.google.protobuf.ByteString getDelimiterBytes()

 If set, returns results in a directory-like mode. `items` will contain
 only objects whose names, aside from the `prefix`, do not
 contain `delimiter`. Objects whose names, aside from the
 `prefix`, contain `delimiter` will have their name,
 truncated after the `delimiter`, returned in
 `prefixes`. Duplicate `prefixes` are omitted.
 

string delimiter = 4;

Returns:

The bytes for delimiter.

getIncludeTrailingDelimiter

boolean getIncludeTrailingDelimiter()

 If true, objects that end in exactly one instance of `delimiter`
 will have their metadata included in `items` in addition to
 `prefixes`.
 

bool include_trailing_delimiter = 5;

Returns:

The includeTrailingDelimiter.

getPrefix

String getPrefix()

 Filter results to objects whose names begin with this prefix.
 

string prefix = 6;

Returns:

The prefix.

getPrefixBytes

com.google.protobuf.ByteString getPrefixBytes()

 Filter results to objects whose names begin with this prefix.
 

string prefix = 6;

Returns:

The bytes for prefix.

getVersions

boolean getVersions()

 If `true`, lists all versions of an object as distinct results.
 For more information, see
 [Object
 Versioning](https://cloud.google.com/storage/docs/object-versioning).
 

bool versions = 7;

Returns:

The versions.

hasReadMask

boolean hasReadMask()

 Mask specifying which fields to read from each result.
 If no mask is specified, will default to all fields except items.acl and
 items.owner.
 * may be used to mean "all fields".
 

optional .google.protobuf.FieldMask read_mask = 8;

Returns:

Whether the readMask field is set.

getReadMask

com.google.protobuf.FieldMask getReadMask()

 Mask specifying which fields to read from each result.
 If no mask is specified, will default to all fields except items.acl and
 items.owner.
 * may be used to mean "all fields".
 

optional .google.protobuf.FieldMask read_mask = 8;

Returns:

The readMask.

getReadMaskOrBuilder

com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()

 Mask specifying which fields to read from each result.
 If no mask is specified, will default to all fields except items.acl and
 items.owner.
 * may be used to mean "all fields".
 

optional .google.protobuf.FieldMask read_mask = 8;

getLexicographicStart

String getLexicographicStart()

 Optional. Filter results to objects whose names are lexicographically equal
 to or after lexicographic_start. If lexicographic_end is also set, the
 objects listed have names between lexicographic_start (inclusive) and
 lexicographic_end (exclusive).
 

string lexicographic_start = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The lexicographicStart.

getLexicographicStartBytes

com.google.protobuf.ByteString getLexicographicStartBytes()

 Optional. Filter results to objects whose names are lexicographically equal
 to or after lexicographic_start. If lexicographic_end is also set, the
 objects listed have names between lexicographic_start (inclusive) and
 lexicographic_end (exclusive).
 

string lexicographic_start = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for lexicographicStart.

getLexicographicEnd

String getLexicographicEnd()

 Optional. Filter results to objects whose names are lexicographically
 before lexicographic_end. If lexicographic_start is also set, the objects
 listed have names between lexicographic_start (inclusive) and
 lexicographic_end (exclusive).
 

string lexicographic_end = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The lexicographicEnd.

getLexicographicEndBytes

com.google.protobuf.ByteString getLexicographicEndBytes()

 Optional. Filter results to objects whose names are lexicographically
 before lexicographic_end. If lexicographic_start is also set, the objects
 listed have names between lexicographic_start (inclusive) and
 lexicographic_end (exclusive).
 

string lexicographic_end = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The bytes for lexicographicEnd.