Generated from protobuf message google.cloud.resourcemanager.v3.SearchProjectsRequest
Namespace
Google \ Cloud \ ResourceManager \ V3
Methods
__construct
Constructor.
Parameters
Name
Description
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 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/*). 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.
Returns
Type
Description
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/*). 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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPageToken
Optional. A pagination token returned from a previous call to
ListProjects that
indicates from where listing should continue.
Returns
Type
Description
string
setPageToken
Optional. A pagination token returned from a previous call to
ListProjects that
indicates from where listing should continue.
Parameter
Name
Description
var
string
Returns
Type
Description
$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.
Returns
Type
Description
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
static::build
Parameter
Name
Description
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Resource Manager V3 Client - Class SearchProjectsRequest (1.0.4)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.4 (latest)](/php/docs/reference/cloud-resource-manager/latest/V3.SearchProjectsRequest)\n- [1.0.3](/php/docs/reference/cloud-resource-manager/1.0.3/V3.SearchProjectsRequest)\n- [0.8.5](/php/docs/reference/cloud-resource-manager/0.8.5/V3.SearchProjectsRequest)\n- [0.7.2](/php/docs/reference/cloud-resource-manager/0.7.2/V3.SearchProjectsRequest)\n- [0.6.1](/php/docs/reference/cloud-resource-manager/0.6.1/V3.SearchProjectsRequest)\n- [0.5.0](/php/docs/reference/cloud-resource-manager/0.5.0/V3.SearchProjectsRequest)\n- [0.4.1](/php/docs/reference/cloud-resource-manager/0.4.1/V3.SearchProjectsRequest)\n- [0.3.9](/php/docs/reference/cloud-resource-manager/0.3.9/V3.SearchProjectsRequest) \nReference documentation and code samples for the Google Cloud Resource Manager V3 Client class SearchProjectsRequest.\n\nThe request sent to the\n[SearchProjects](/php/docs/reference/cloud-resource-manager/latest/V3.Client.ProjectsClient#_Google_Cloud_ResourceManager_V3_Client_ProjectsClient__searchProjects__)\nmethod.\n\nGenerated from protobuf message `google.cloud.resourcemanager.v3.SearchProjectsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ ResourceManager \\\\ V3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getQuery\n\nOptional. A query string for searching for projects that the caller has\n`resourcemanager.projects.get` permission to. If multiple fields are\nincluded in the query, then it will return results that match any of the\nfields. Some eligible fields are:\n\n- **`displayName`, `name`**: Filters by displayName.\n\n- **`parent`** : Project's parent (for example: `folders/123`,\n `organizations/*`). Prefer `parent` field over `parent.type` and\n `parent.id`.\n\n- **`parent.type`** : Parent's type: `folder` or `organization`.\n- **`parent.id`** : Parent's id number (for example: `123`).\n- **`id`, `projectId`**: Filters by projectId.\n- **`state`, `lifecycleState`**: Filters by state.\n- **`labels`**: Filters by label name or value.\n- **`labels.\u003ckey\u003e` (where `\u003ckey\u003e` is the name of a label)**: Filters by label name. Search expressions are case insensitive. Some examples queries:\n- **`name:how*`**: The project's name starts with \"how\".\n- **`name:Howl`** : The project's name is `Howl` or `howl`.\n- **`name:HOWL`**: Equivalent to above.\n- **`NAME:howl`**: Equivalent to above.\n- **`labels.color:*`** : The project has the label `color`.\n- **`labels.color:red`** : The project's label `color` has the value `red`.\n- **`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.\n\n### setQuery\n\nOptional. A query string for searching for projects that the caller has\n`resourcemanager.projects.get` permission to. If multiple fields are\nincluded in the query, then it will return results that match any of the\nfields. Some eligible fields are:\n\n- **`displayName`, `name`**: Filters by displayName.\n\n- **`parent`** : Project's parent (for example: `folders/123`,\n `organizations/*`). Prefer `parent` field over `parent.type` and\n `parent.id`.\n\n- **`parent.type`** : Parent's type: `folder` or `organization`.\n- **`parent.id`** : Parent's id number (for example: `123`).\n- **`id`, `projectId`**: Filters by projectId.\n- **`state`, `lifecycleState`**: Filters by state.\n- **`labels`**: Filters by label name or value.\n- **`labels.\u003ckey\u003e` (where `\u003ckey\u003e` is the name of a label)**: Filters by label name. Search expressions are case insensitive. Some examples queries:\n- **`name:how*`**: The project's name starts with \"how\".\n- **`name:Howl`** : The project's name is `Howl` or `howl`.\n- **`name:HOWL`**: Equivalent to above.\n- **`NAME:howl`**: Equivalent to above.\n- **`labels.color:*`** : The project has the label `color`.\n- **`labels.color:red`** : The project's label `color` has the value `red`.\n- **`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.\n\n### getPageToken\n\nOptional. A pagination token returned from a previous call to\n[ListProjects](/php/docs/reference/cloud-resource-manager/latest/V3.Client.ProjectsClient#_Google_Cloud_ResourceManager_V3_Client_ProjectsClient__listProjects__) that\nindicates from where listing should continue.\n\n### setPageToken\n\nOptional. A pagination token returned from a previous call to\n[ListProjects](/php/docs/reference/cloud-resource-manager/latest/V3.Client.ProjectsClient#_Google_Cloud_ResourceManager_V3_Client_ProjectsClient__listProjects__) that\nindicates from where listing should continue.\n\n### getPageSize\n\nOptional. The maximum number of projects to return in the response.\n\nThe server can return fewer projects than requested.\nIf unspecified, server picks an appropriate default.\n\n### setPageSize\n\nOptional. The maximum number of projects to return in the response.\n\nThe server can return fewer projects than requested.\nIf unspecified, server picks an appropriate default.\n\n### static::build"]]
