public interface ListFoldersRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getDelimiter()
public abstract String getDelimiter()Optional. If set, returns results in a directory-like mode. The results will only include folders that either exactly match the above prefix, or are one level below the prefix. The only supported value is '/'.
string delimiter = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The delimiter. |
getDelimiterBytes()
public abstract ByteString getDelimiterBytes()Optional. If set, returns results in a directory-like mode. The results will only include folders that either exactly match the above prefix, or are one level below the prefix. The only supported value is '/'.
string delimiter = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for delimiter. |
getLexicographicEnd()
public abstract String getLexicographicEnd()Optional. Filter results to folders whose names are lexicographically before lexicographic_end. If lexicographic_start is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).
string lexicographic_end = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The lexicographicEnd. |
getLexicographicEndBytes()
public abstract ByteString getLexicographicEndBytes()Optional. Filter results to folders whose names are lexicographically before lexicographic_end. If lexicographic_start is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).
string lexicographic_end = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for lexicographicEnd. |
getLexicographicStart()
public abstract String getLexicographicStart()Optional. Filter results to folders whose names are lexicographically equal to or after lexicographic_start. If lexicographic_end is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).
string lexicographic_start = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The lexicographicStart. |
getLexicographicStartBytes()
public abstract ByteString getLexicographicStartBytes()Optional. Filter results to folders whose names are lexicographically equal to or after lexicographic_start. If lexicographic_end is also set, the folders listed have names between lexicographic_start (inclusive) and lexicographic_end (exclusive).
string lexicographic_start = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for lexicographicStart. |
getPageSize()
public abstract int getPageSize()Optional. Maximum number of folders to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.
int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The pageSize. |
getPageToken()
public abstract String getPageToken()Optional. A previously-returned page token representing part of the larger set of results to view.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The pageToken. |
getPageTokenBytes()
public abstract ByteString getPageTokenBytes()Optional. A previously-returned page token representing part of the larger set of results to view.
string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pageToken. |
getParent()
public abstract String getParent()Required. Name of the bucket in which to look for folders. The bucket must be a hierarchical namespace enabled bucket.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public abstract ByteString getParentBytes()Required. Name of the bucket in which to look for folders. The bucket must be a hierarchical namespace enabled bucket.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
getPrefix()
public abstract String getPrefix()Optional. Filter results to folders whose names begin with this prefix. If set, the value must either be an empty string or end with a '/'.
string prefix = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The prefix. |
getPrefixBytes()
public abstract ByteString getPrefixBytes()Optional. Filter results to folders whose names begin with this prefix. If set, the value must either be an empty string or end with a '/'.
string prefix = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for prefix. |
getRequestId()
public abstract String getRequestId()Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
string request_id = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The requestId. |
getRequestIdBytes()
public abstract ByteString getRequestIdBytes()Optional. A unique identifier for this request. UUID is the recommended format, but other formats are still accepted.
string request_id = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for requestId. |