Class: Google::Cloud::ResourceManager::V3::SearchProjectsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/resourcemanager/v3/projects.rb

Overview

The request sent to the SearchProjects method.

Instance Attribute Summary collapse

Instance Attribute Details

#page_size ⇒ ::Integer

Returns 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.

Returns:

  • (::Integer) —

    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.



238
239
240
241
 
# File 'proto_docs/google/cloud/resourcemanager/v3/projects.rb', line 238

class SearchProjectsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token ⇒ ::String

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

Returns:

  • (::String) —

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



238
239
240
241
 
# File 'proto_docs/google/cloud/resourcemanager/v3/projects.rb', line 238

class SearchProjectsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#query ⇒ ::String

Returns 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:

Field Description
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. (where key is the name of a label) Filters by label
name.

Search expressions are case insensitive.

Some examples queries:

Query Description
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 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.

Returns:

  • (::String) —

    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:

    Field Description
    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. (where key is the name of a label) Filters by label
    name.

    Search expressions are case insensitive.

    Some examples queries:

    Query Description
    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 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.



238
239
240
241
 
# File 'proto_docs/google/cloud/resourcemanager/v3/projects.rb', line 238

class SearchProjectsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end