public static final class ListFoldersRequest.Builder extends GeneratedMessageV3.Builder<ListFoldersRequest.Builder> implements ListFoldersRequestOrBuilder
Request message for ListFolders.
Protobuf type google.storage.control.v2.ListFoldersRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListFoldersRequest.BuilderImplements
ListFoldersRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListFoldersRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
build()
public ListFoldersRequest build()
Returns | |
---|---|
Type | Description |
ListFoldersRequest |
buildPartial()
public ListFoldersRequest buildPartial()
Returns | |
---|---|
Type | Description |
ListFoldersRequest |
clear()
public ListFoldersRequest.Builder clear()
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
clearDelimiter()
public ListFoldersRequest.Builder clearDelimiter()
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 |
ListFoldersRequest.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ListFoldersRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
clearLexicographicEnd()
public ListFoldersRequest.Builder clearLexicographicEnd()
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 |
ListFoldersRequest.Builder |
This builder for chaining. |
clearLexicographicStart()
public ListFoldersRequest.Builder clearLexicographicStart()
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 |
ListFoldersRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListFoldersRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
clearPageSize()
public ListFoldersRequest.Builder clearPageSize()
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 |
ListFoldersRequest.Builder |
This builder for chaining. |
clearPageToken()
public ListFoldersRequest.Builder clearPageToken()
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 |
ListFoldersRequest.Builder |
This builder for chaining. |
clearParent()
public ListFoldersRequest.Builder clearParent()
Required. Name of the bucket in which to look for folders.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
This builder for chaining. |
clearPrefix()
public ListFoldersRequest.Builder clearPrefix()
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 |
ListFoldersRequest.Builder |
This builder for chaining. |
clearRequestId()
public ListFoldersRequest.Builder clearRequestId()
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 |
ListFoldersRequest.Builder |
This builder for chaining. |
clone()
public ListFoldersRequest.Builder clone()
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
getDefaultInstanceForType()
public ListFoldersRequest getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
ListFoldersRequest |
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. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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()
public 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 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.
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.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for parent. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListFoldersRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public ListFoldersRequest.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
mergeFrom(ListFoldersRequest other)
public ListFoldersRequest.Builder mergeFrom(ListFoldersRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListFoldersRequest |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListFoldersRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
setDelimiter(String value)
public ListFoldersRequest.Builder setDelimiter(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The delimiter to set. |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
This builder for chaining. |
setDelimiterBytes(ByteString value)
public ListFoldersRequest.Builder setDelimiterBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for delimiter to set. |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ListFoldersRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
setLexicographicEnd(String value)
public ListFoldersRequest.Builder setLexicographicEnd(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The lexicographicEnd to set. |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
This builder for chaining. |
setLexicographicEndBytes(ByteString value)
public ListFoldersRequest.Builder setLexicographicEndBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for lexicographicEnd to set. |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
This builder for chaining. |
setLexicographicStart(String value)
public ListFoldersRequest.Builder setLexicographicStart(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The lexicographicStart to set. |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
This builder for chaining. |
setLexicographicStartBytes(ByteString value)
public ListFoldersRequest.Builder setLexicographicStartBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for lexicographicStart to set. |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
This builder for chaining. |
setPageSize(int value)
public ListFoldersRequest.Builder setPageSize(int value)
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];
Parameter | |
---|---|
Name | Description |
value |
int The pageSize to set. |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
This builder for chaining. |
setPageToken(String value)
public ListFoldersRequest.Builder setPageToken(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The pageToken to set. |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListFoldersRequest.Builder setPageTokenBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for pageToken to set. |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListFoldersRequest.Builder setParent(String value)
Required. Name of the bucket in which to look for folders.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The parent to set. |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListFoldersRequest.Builder setParentBytes(ByteString value)
Required. Name of the bucket in which to look for folders.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for parent to set. |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
This builder for chaining. |
setPrefix(String value)
public ListFoldersRequest.Builder setPrefix(String value)
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];
Parameter | |
---|---|
Name | Description |
value |
String The prefix to set. |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
This builder for chaining. |
setPrefixBytes(ByteString value)
public ListFoldersRequest.Builder setPrefixBytes(ByteString value)
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];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for prefix to set. |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListFoldersRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
setRequestId(String value)
public ListFoldersRequest.Builder setRequestId(String value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The requestId to set. |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
This builder for chaining. |
setRequestIdBytes(ByteString value)
public ListFoldersRequest.Builder setRequestIdBytes(ByteString value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for requestId to set. |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListFoldersRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
ListFoldersRequest.Builder |