Class SearchProjectsRequest.Builder (1.56.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

Inheritance

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

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

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

getDefaultInstanceForType()

public SearchProjectsRequest getDefaultInstanceForType()
Returns
Type Description
SearchProjectsRequest

getDescriptorForType()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

public final SearchProjectsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SearchProjectsRequest.Builder
Overrides