Class ListFoldersRequest.Builder (1.21.0)

public static final class ListFoldersRequest.Builder extends GeneratedMessageV3.Builder<ListFoldersRequest.Builder> implements ListFoldersRequestOrBuilder

The ListFolders request message.

Protobuf type google.cloud.resourcemanager.v3.ListFoldersRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListFoldersRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListFoldersRequest.Builder
Overrides

build()

public ListFoldersRequest build()
Returns
TypeDescription
ListFoldersRequest

buildPartial()

public ListFoldersRequest buildPartial()
Returns
TypeDescription
ListFoldersRequest

clear()

public ListFoldersRequest.Builder clear()
Returns
TypeDescription
ListFoldersRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListFoldersRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListFoldersRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListFoldersRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListFoldersRequest.Builder
Overrides

clearPageSize()

public ListFoldersRequest.Builder clearPageSize()

Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ListFoldersRequest.Builder

This builder for chaining.

clearPageToken()

public ListFoldersRequest.Builder clearPageToken()

Optional. A pagination token returned from a previous call to ListFolders that indicates where this listing should continue from.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ListFoldersRequest.Builder

This builder for chaining.

clearParent()

public ListFoldersRequest.Builder clearParent()

Required. The name of the parent resource whose folders are being listed. Only children of this parent resource are listed; descendants are not listed.

If the parent is a folder, use the value folders/{folder_id}. If the parent is an organization, use the value organizations/{org_id}.

Access to this method is controlled by checking the resourcemanager.folders.list permission on the parent.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ListFoldersRequest.Builder

This builder for chaining.

clearShowDeleted()

public ListFoldersRequest.Builder clearShowDeleted()

Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.

bool show_deleted = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ListFoldersRequest.Builder

This builder for chaining.

clone()

public ListFoldersRequest.Builder clone()
Returns
TypeDescription
ListFoldersRequest.Builder
Overrides

getDefaultInstanceForType()

public ListFoldersRequest getDefaultInstanceForType()
Returns
TypeDescription
ListFoldersRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getPageSize()

public int getPageSize()

Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A pagination token returned from a previous call to ListFolders that indicates where this listing should continue from.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A pagination token returned from a previous call to ListFolders that indicates where this listing should continue from.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The name of the parent resource whose folders are being listed. Only children of this parent resource are listed; descendants are not listed.

If the parent is a folder, use the value folders/{folder_id}. If the parent is an organization, use the value organizations/{org_id}.

Access to this method is controlled by checking the resourcemanager.folders.list permission on the parent.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The name of the parent resource whose folders are being listed. Only children of this parent resource are listed; descendants are not listed.

If the parent is a folder, use the value folders/{folder_id}. If the parent is an organization, use the value organizations/{org_id}.

Access to this method is controlled by checking the resourcemanager.folders.list permission on the parent.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
TypeDescription
ByteString

The bytes for parent.

getShowDeleted()

public boolean getShowDeleted()

Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.

bool show_deleted = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

The showDeleted.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListFoldersRequest other)

public ListFoldersRequest.Builder mergeFrom(ListFoldersRequest other)
Parameter
NameDescription
otherListFoldersRequest
Returns
TypeDescription
ListFoldersRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListFoldersRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListFoldersRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListFoldersRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListFoldersRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListFoldersRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListFoldersRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListFoldersRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListFoldersRequest.Builder
Overrides

setPageSize(int value)

public ListFoldersRequest.Builder setPageSize(int value)

Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListFoldersRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListFoldersRequest.Builder setPageToken(String value)

Optional. A pagination token returned from a previous call to ListFolders that indicates where this listing should continue from.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListFoldersRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListFoldersRequest.Builder setPageTokenBytes(ByteString value)

Optional. A pagination token returned from a previous call to ListFolders that indicates where this listing should continue from.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListFoldersRequest.Builder

This builder for chaining.

setParent(String value)

public ListFoldersRequest.Builder setParent(String value)

Required. The name of the parent resource whose folders are being listed. Only children of this parent resource are listed; descendants are not listed.

If the parent is a folder, use the value folders/{folder_id}. If the parent is an organization, use the value organizations/{org_id}.

Access to this method is controlled by checking the resourcemanager.folders.list permission on the parent.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListFoldersRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListFoldersRequest.Builder setParentBytes(ByteString value)

Required. The name of the parent resource whose folders are being listed. Only children of this parent resource are listed; descendants are not listed.

If the parent is a folder, use the value folders/{folder_id}. If the parent is an organization, use the value organizations/{org_id}.

Access to this method is controlled by checking the resourcemanager.folders.list permission on the parent.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListFoldersRequest.Builder
Overrides

setShowDeleted(boolean value)

public ListFoldersRequest.Builder setShowDeleted(boolean value)

Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.

bool show_deleted = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueboolean

The showDeleted to set.

Returns
TypeDescription
ListFoldersRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ListFoldersRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListFoldersRequest.Builder
Overrides