Class ListFoldersRequest.Builder (1.44.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
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

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

clearField(Descriptors.FieldDescriptor field)

public ListFoldersRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListFoldersRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListFoldersRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ListFoldersRequest.Builder

This builder for chaining.

clone()

public ListFoldersRequest.Builder clone()
Returns
Type Description
ListFoldersRequest.Builder
Overrides

getDefaultInstanceForType()

public ListFoldersRequest getDefaultInstanceForType()
Returns
Type Description
ListFoldersRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

The showDeleted.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListFoldersRequest other)

public ListFoldersRequest.Builder mergeFrom(ListFoldersRequest other)
Parameter
Name Description
other ListFoldersRequest
Returns
Type Description
ListFoldersRequest.Builder

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListFoldersRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListFoldersRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListFoldersRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListFoldersRequest.Builder
Overrides

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

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
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 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
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 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
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. 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
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. 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
Name Description
value ByteString

The bytes for parent 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

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
Name Description
value boolean

The showDeleted 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