Reference documentation and code samples for the Google Cloud Resource Manager V3 Client class SearchProjectsRequest.
The request sent to the SearchProjects method.
Generated from protobuf message google.cloud.resourcemanager.v3.SearchProjectsRequest
Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ query
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, 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.
↳ page_token
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.
↳ page_size
int
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.
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/*
). Preferparent
field overparent.type
andparent.id
. -
parent.type
: Parent's type:folder
ororganization
. -
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 isHowl
orhowl
. -
name:HOWL
: Equivalent to above. -
NAME:howl
: Equivalent to above. -
labels.color:*
: The project has the labelcolor
. -
labels.color:red
: The project's labelcolor
has the valuered
. -
labels.color:red labels.size:big
: The project's labelcolor
has the valuered
or its labelsize
has the valuebig
. If no query is specified, the call will return projects for which the user has theresourcemanager.projects.get
permission.
string
setQuery
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/*
). Preferparent
field overparent.type
andparent.id
. -
parent.type
: Parent's type:folder
ororganization
. -
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 isHowl
orhowl
. -
name:HOWL
: Equivalent to above. -
NAME:howl
: Equivalent to above. -
labels.color:*
: The project has the labelcolor
. -
labels.color:red
: The project's labelcolor
has the valuered
. -
labels.color:red labels.size:big
: The project's labelcolor
has the valuered
or its labelsize
has the valuebig
. If no query is specified, the call will return projects for which the user has theresourcemanager.projects.get
permission.
var
string
$this
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
setPageToken
Optional. A pagination token returned from a previous call to [ListProjects] [google.cloud.resourcemanager.v3.Projects.ListProjects] that indicates from where listing should continue.
var
string
$this
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.
int
setPageSize
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.
var
int
$this