Class ListFoldersRequest.Builder (2.40.0)

public static final class ListFoldersRequest.Builder extends GeneratedMessageV3.Builder<ListFoldersRequest.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListFoldersRequest.Builder

Implements

ListFoldersRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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. The bucket must be a hierarchical namespace enabled bucket.

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListFoldersRequest getDefaultInstanceForType()

Returns
Type	Description
`ListFoldersRequest`

getDelimiter()

public String getDelimiter()

string delimiter = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The delimiter.

getDelimiterBytes()

public ByteString getDelimiterBytes()

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getLexicographicEnd()

public String getLexicographicEnd()

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

Returns
Type	Description
`String`	The lexicographicEnd.

getLexicographicEndBytes()

public ByteString getLexicographicEndBytes()

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

Returns
Type	Description
`ByteString`	The bytes for lexicographicEnd.

getLexicographicStart()

public String getLexicographicStart()

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

Returns
Type	Description
`String`	The lexicographicStart.

getLexicographicStartBytes()

public ByteString getLexicographicStartBytes()

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. 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.

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public ListFoldersRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`ListFoldersRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setDelimiter(String value)

public ListFoldersRequest.Builder setDelimiter(String value)

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)

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setLexicographicEnd(String value)

public ListFoldersRequest.Builder setLexicographicEnd(String value)

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)

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)

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)

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. The bucket must be a hierarchical namespace enabled bucket.

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. The bucket must be a hierarchical namespace enabled bucket.

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)