Class SearchProjectsRequest.Builder (1.23.0)

Version 1.23.0

• 1.55.0 (latest)
• 1.54.0
• 1.53.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.6
• 1.4.0
• 1.3.2
• 1.2.12

public static final class SearchProjectsRequest.Builder extends GeneratedMessageV3.Builder<SearchProjectsRequest.Builder> implements SearchProjectsRequestOrBuilder

The request sent to the SearchProjects method.

Protobuf type google.cloud.resourcemanager.v3.SearchProjectsRequest

Inheritance

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

Implements

SearchProjectsRequestOrBuilder

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)

GeneratedMessageV3.Builder.internalGetMutableMapField(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 SearchProjectsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchProjectsRequest.Builder

Overrides

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

build()

public SearchProjectsRequest build()

Returns
Type	Description
SearchProjectsRequest

buildPartial()

public SearchProjectsRequest buildPartial()

Returns
Type	Description
SearchProjectsRequest

clear()

public SearchProjectsRequest.Builder clear()

Returns
Type	Description
SearchProjectsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public SearchProjectsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
SearchProjectsRequest.Builder

Overrides

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

clearOneof(Descriptors.OneofDescriptor oneof)

public SearchProjectsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
SearchProjectsRequest.Builder

Overrides

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

clearPageSize()

public SearchProjectsRequest.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
Type	Description
SearchProjectsRequest.Builder	This builder for chaining.

clearPageToken()

public SearchProjectsRequest.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
Type	Description
SearchProjectsRequest.Builder	This builder for chaining.

clearQuery()

public SearchProjectsRequest.Builder clearQuery()

Optional. A query string for searching for projects that the caller has resourcemanager.projects.get permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are:

• displayName, name: Filters by displayName.
• parent: Project's parent (for example: folders/123, organizations/*). Prefer parent field over parent.type and parent.id.
• parent.type: Parent's type: folder or organization.
• parent.id: Parent's id number (for example: 123).
• id, projectId: Filters by projectId.
• state, lifecycleState: Filters by state.
• labels: Filters by label name or value.

• labels.<key> (where <key> is the name of a label): Filters by label name.

  Search expressions are case insensitive.

  Some examples queries:

• name:how*: The project's name starts with "how".

• name:Howl: The project's name is Howl or howl.
• name:HOWL: Equivalent to above.
• NAME:howl: Equivalent to above.
• labels.color:*: The project has the label color.
• labels.color:red: The project's label color has the value red.

• labels.color:red labels.size:big: The project's label color has the value red or its label size has the value big.

  If no query is specified, the call will return projects for which the user has the resourcemanager.projects.get permission.

string query = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
SearchProjectsRequest.Builder	This builder for chaining.

clone()

public SearchProjectsRequest.Builder clone()

Returns
Type	Description
SearchProjectsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SearchProjectsRequest getDefaultInstanceForType()

Returns
Type	Description
SearchProjectsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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
Type	Description
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
Type	Description
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
Type	Description
ByteString	The bytes for pageToken.

getQuery()

public String getQuery()

Optional. A query string for searching for projects that the caller has resourcemanager.projects.get permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are:

• displayName, name: Filters by displayName.
• parent: Project's parent (for example: folders/123, organizations/*). Prefer parent field over parent.type and parent.id.
• parent.type: Parent's type: folder or organization.
• parent.id: Parent's id number (for example: 123).
• id, projectId: Filters by projectId.
• state, lifecycleState: Filters by state.
• labels: Filters by label name or value.

• labels.<key> (where <key> is the name of a label): Filters by label name.

  Search expressions are case insensitive.

  Some examples queries:

• name:how*: The project's name starts with "how".

• name:Howl: The project's name is Howl or howl.
• name:HOWL: Equivalent to above.
• NAME:howl: Equivalent to above.
• labels.color:*: The project has the label color.
• labels.color:red: The project's label color has the value red.

• labels.color:red labels.size:big: The project's label color has the value red or its label size has the value big.

  If no query is specified, the call will return projects for which the user has the resourcemanager.projects.get permission.

string query = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The query.

getQueryBytes()

public ByteString getQueryBytes()

Optional. A query string for searching for projects that the caller has resourcemanager.projects.get permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are:

• displayName, name: Filters by displayName.
• parent: Project's parent (for example: folders/123, organizations/*). Prefer parent field over parent.type and parent.id.
• parent.type: Parent's type: folder or organization.
• parent.id: Parent's id number (for example: 123).
• id, projectId: Filters by projectId.
• state, lifecycleState: Filters by state.
• labels: Filters by label name or value.

• labels.<key> (where <key> is the name of a label): Filters by label name.

  Search expressions are case insensitive.

  Some examples queries:

• name:how*: The project's name starts with "how".

• name:Howl: The project's name is Howl or howl.
• name:HOWL: Equivalent to above.
• NAME:howl: Equivalent to above.
• labels.color:*: The project has the label color.
• labels.color:red: The project's label color has the value red.

• labels.color:red labels.size:big: The project's label color has the value red or its label size has the value big.

  If no query is specified, the call will return projects for which the user has the resourcemanager.projects.get permission.

string query = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for query.

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

public SearchProjectsRequest.Builder mergeFrom(SearchProjectsRequest other)

Parameter
Name	Description
other	SearchProjectsRequest

Returns
Type	Description
SearchProjectsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchProjectsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchProjectsRequest.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchProjectsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchProjectsRequest.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SearchProjectsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchProjectsRequest.Builder

Overrides

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

setField(Descriptors.FieldDescriptor field, Object value)

public SearchProjectsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
SearchProjectsRequest.Builder

Overrides

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

setPageSize(int value)

public SearchProjectsRequest.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
Name	Description
value	int The pageSize to set.

Returns
Type	Description
SearchProjectsRequest.Builder	This builder for chaining.

setPageToken(String value)

public SearchProjectsRequest.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
Name	Description
value	String The pageToken to set.

Returns
Type	Description
SearchProjectsRequest.Builder	This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchProjectsRequest.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
Name	Description
value	ByteString The bytes for pageToken to set.

Returns
Type	Description
SearchProjectsRequest.Builder	This builder for chaining.

setQuery(String value)

public SearchProjectsRequest.Builder setQuery(String value)

Optional. A query string for searching for projects that the caller has resourcemanager.projects.get permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are:

• displayName, name: Filters by displayName.
• parent: Project's parent (for example: folders/123, organizations/*). Prefer parent field over parent.type and parent.id.
• parent.type: Parent's type: folder or organization.
• parent.id: Parent's id number (for example: 123).
• id, projectId: Filters by projectId.
• state, lifecycleState: Filters by state.
• labels: Filters by label name or value.

• labels.<key> (where <key> is the name of a label): Filters by label name.

  Search expressions are case insensitive.

  Some examples queries:

• name:how*: The project's name starts with "how".

• name:Howl: The project's name is Howl or howl.
• name:HOWL: Equivalent to above.
• NAME:howl: Equivalent to above.
• labels.color:*: The project has the label color.
• labels.color:red: The project's label color has the value red.

• labels.color:red labels.size:big: The project's label color has the value red or its label size has the value big.

  If no query is specified, the call will return projects for which the user has the resourcemanager.projects.get permission.

string query = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The query to set.

Returns
Type	Description
SearchProjectsRequest.Builder	This builder for chaining.

setQueryBytes(ByteString value)

public SearchProjectsRequest.Builder setQueryBytes(ByteString value)

Optional. A query string for searching for projects that the caller has resourcemanager.projects.get permission to. If multiple fields are included in the query, then it will return results that match any of the fields. Some eligible fields are:

• displayName, name: Filters by displayName.
• parent: Project's parent (for example: folders/123, organizations/*). Prefer parent field over parent.type and parent.id.
• parent.type: Parent's type: folder or organization.
• parent.id: Parent's id number (for example: 123).
• id, projectId: Filters by projectId.
• state, lifecycleState: Filters by state.
• labels: Filters by label name or value.

• labels.<key> (where <key> is the name of a label): Filters by label name.

  Search expressions are case insensitive.

  Some examples queries:

• name:how*: The project's name starts with "how".

• name:Howl: The project's name is Howl or howl.
• name:HOWL: Equivalent to above.
• NAME:howl: Equivalent to above.
• labels.color:*: The project has the label color.
• labels.color:red: The project's label color has the value red.

• labels.color:red labels.size:big: The project's label color has the value red or its label size has the value big.

  If no query is specified, the call will return projects for which the user has the resourcemanager.projects.get permission.

string query = 1 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for query to set.

Returns
Type	Description
SearchProjectsRequest.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
SearchProjectsRequest.Builder

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchProjectsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SearchProjectsRequest.Builder

Overrides

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