Class SearchProjectsRequest.Builder (1.4.0)

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public SearchProjectsRequest build()
Returns
TypeDescription
SearchProjectsRequest

buildPartial()

public SearchProjectsRequest buildPartial()
Returns
TypeDescription
SearchProjectsRequest

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

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
TypeDescription
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
TypeDescription
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, the it will return results that match any of the fields. Some eligible fields are: `

FieldDescription
displayName, nameFilters by displayName.
parentProject's parent. (for example: folders/123,
organizations/*) Prefer parent field over parent.type and parent.id.
parent.typeParent'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:

QueryDescription
name:how*The project's name starts with "how".
name:HowlThe 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&nbsp;labels.size:big The project's label color has the value red and 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
TypeDescription
SearchProjectsRequest.Builder

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public SearchProjectsRequest getDefaultInstanceForType()
Returns
TypeDescription
SearchProjectsRequest

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.

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, the it will return results that match any of the fields. Some eligible fields are: `

FieldDescription
displayName, nameFilters by displayName.
parentProject's parent. (for example: folders/123,
organizations/*) Prefer parent field over parent.type and parent.id.
parent.typeParent'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:

QueryDescription
name:how*The project's name starts with "how".
name:HowlThe 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&nbsp;labels.size:big The project's label color has the value red and 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
TypeDescription
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, the it will return results that match any of the fields. Some eligible fields are: `

FieldDescription
displayName, nameFilters by displayName.
parentProject's parent. (for example: folders/123,
organizations/*) Prefer parent field over parent.type and parent.id.
parent.typeParent'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:

QueryDescription
name:how*The project's name starts with "how".
name:HowlThe 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&nbsp;labels.size:big The project's label color has the value red and 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
TypeDescription
ByteString

The bytes for query.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SearchProjectsRequest other)

public SearchProjectsRequest.Builder mergeFrom(SearchProjectsRequest other)
Parameter
NameDescription
otherSearchProjectsRequest
Returns
TypeDescription
SearchProjectsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

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
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
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
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
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, the it will return results that match any of the fields. Some eligible fields are: `

FieldDescription
displayName, nameFilters by displayName.
parentProject's parent. (for example: folders/123,
organizations/*) Prefer parent field over parent.type and parent.id.
parent.typeParent'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:

QueryDescription
name:how*The project's name starts with "how".
name:HowlThe 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&nbsp;labels.size:big The project's label color has the value red and 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
NameDescription
valueString

The query to set.

Returns
TypeDescription
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, the it will return results that match any of the fields. Some eligible fields are: `

FieldDescription
displayName, nameFilters by displayName.
parentProject's parent. (for example: folders/123,
organizations/*) Prefer parent field over parent.type and parent.id.
parent.typeParent'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:

QueryDescription
name:how*The project's name starts with "how".
name:HowlThe 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&nbsp;labels.size:big The project's label color has the value red and 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
NameDescription
valueByteString

The bytes for query to set.

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

setUnknownFields(UnknownFieldSet unknownFields)

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