Class ListProjectsRequest.Builder (1.23.0)

public static final class ListProjectsRequest.Builder extends GeneratedMessageV3.Builder<ListProjectsRequest.Builder> implements ListProjectsRequestOrBuilder

The request sent to the ListProjects method.

Protobuf type google.cloud.resourcemanager.v3.ListProjectsRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ListProjectsRequest build()
Returns
TypeDescription
ListProjectsRequest

buildPartial()

public ListProjectsRequest buildPartial()
Returns
TypeDescription
ListProjectsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPageSize()

public ListProjectsRequest.Builder clearPageSize()

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

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

Returns
TypeDescription
ListProjectsRequest.Builder

This builder for chaining.

clearPageToken()

public ListProjectsRequest.Builder clearPageToken()

Optional. A pagination token returned from a previous call to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that indicates from where listing should continue.

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

Returns
TypeDescription
ListProjectsRequest.Builder

This builder for chaining.

clearParent()

public ListProjectsRequest.Builder clearParent()

Required. The name of the parent resource whose projects 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}.

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

Returns
TypeDescription
ListProjectsRequest.Builder

This builder for chaining.

clearShowDeleted()

public ListProjectsRequest.Builder clearShowDeleted()

Optional. Indicate that projects in the DELETE_REQUESTED state should also be returned. Normally only ACTIVE projects are returned.

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

Returns
TypeDescription
ListProjectsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ListProjectsRequest getDefaultInstanceForType()
Returns
TypeDescription
ListProjectsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getPageSize()

public int getPageSize()

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

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

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

Optional. A pagination token returned from a previous call to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that indicates from where listing should continue.

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

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

Optional. A pagination token returned from a previous call to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that indicates from where listing should continue.

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

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The name of the parent resource whose projects 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}.

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

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

Returns
TypeDescription
ByteString

The bytes for parent.

getShowDeleted()

public boolean getShowDeleted()

Optional. Indicate that projects in the DELETE_REQUESTED state should also be returned. Normally only ACTIVE projects are returned.

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(ListProjectsRequest other)

public ListProjectsRequest.Builder mergeFrom(ListProjectsRequest other)
Parameter
NameDescription
otherListProjectsRequest
Returns
TypeDescription
ListProjectsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setPageSize(int value)

public ListProjectsRequest.Builder setPageSize(int value)

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

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

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListProjectsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListProjectsRequest.Builder setPageToken(String value)

Optional. A pagination token returned from a previous call to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that indicates from where listing should continue.

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

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListProjectsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListProjectsRequest.Builder setPageTokenBytes(ByteString value)

Optional. A pagination token returned from a previous call to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that indicates from where listing should continue.

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

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListProjectsRequest.Builder

This builder for chaining.

setParent(String value)

public ListProjectsRequest.Builder setParent(String value)

Required. The name of the parent resource whose projects 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}.

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListProjectsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListProjectsRequest.Builder setParentBytes(ByteString value)

Required. The name of the parent resource whose projects 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}.

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
ListProjectsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListProjectsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListProjectsRequest.Builder
Overrides

setShowDeleted(boolean value)

public ListProjectsRequest.Builder setShowDeleted(boolean value)

Optional. Indicate that projects in the DELETE_REQUESTED state should also be returned. Normally only ACTIVE projects are returned.

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

Parameter
NameDescription
valueboolean

The showDeleted to set.

Returns
TypeDescription
ListProjectsRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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