Interface ListObjectsRequestOrBuilder (2.20.1)

Stay organized with collections Save and categorize content based on your preferences.
public interface ListObjectsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDelimiter()

public abstract 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
TypeDescription
String

The delimiter.

getDelimiterBytes()

public abstract 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
TypeDescription
ByteString

The bytes for delimiter.

getIncludeTrailingDelimiter()

public abstract 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
TypeDescription
boolean

The includeTrailingDelimiter.

getLexicographicEnd()

public abstract 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
TypeDescription
String

The lexicographicEnd.

getLexicographicEndBytes()

public abstract 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
TypeDescription
ByteString

The bytes for lexicographicEnd.

getLexicographicStart()

public abstract 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
TypeDescription
String

The lexicographicStart.

getLexicographicStartBytes()

public abstract 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
TypeDescription
ByteString

The bytes for lexicographicStart.

getPageSize()

public abstract 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
TypeDescription
int

The pageSize.

getPageToken()

public abstract String getPageToken()

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

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()