public final class ListFoldersRequest extends GeneratedMessageV3 implements ListFoldersRequestOrBuilder
Request message for ListFolders. This operation is only applicable to a
hierarchical namespace enabled bucket.
Hierarchical namespace buckets are in allowlist preview.
Protobuf type google.storage.control.v2.ListFoldersRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DELIMITER_FIELD_NUMBER
public static final int DELIMITER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LEXICOGRAPHIC_END_FIELD_NUMBER
public static final int LEXICOGRAPHIC_END_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LEXICOGRAPHIC_START_FIELD_NUMBER
public static final int LEXICOGRAPHIC_START_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PREFIX_FIELD_NUMBER
public static final int PREFIX_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REQUEST_ID_FIELD_NUMBER
public static final int REQUEST_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ListFoldersRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListFoldersRequest.Builder newBuilder()
newBuilder(ListFoldersRequest prototype)
public static ListFoldersRequest.Builder newBuilder(ListFoldersRequest prototype)
public static ListFoldersRequest parseDelimitedFrom(InputStream input)
public static ListFoldersRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListFoldersRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListFoldersRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListFoldersRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListFoldersRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListFoldersRequest parseFrom(CodedInputStream input)
public static ListFoldersRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListFoldersRequest parseFrom(InputStream input)
public static ListFoldersRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListFoldersRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListFoldersRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListFoldersRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListFoldersRequest getDefaultInstanceForType()
getDelimiter()
public 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 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 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 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 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 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()
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 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 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 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 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.
|
getParserForType()
public Parser<ListFoldersRequest> getParserForType()
Overrides
getPrefix()
public 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 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 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 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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListFoldersRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListFoldersRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ListFoldersRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
