Reference documentation and code samples for the Google Cloud Resource Manager V3 Client class SearchFoldersRequest.
The request message for searching folders.
Generated from protobuf message google.cloud.resourcemanager.v3.SearchFoldersRequest
Namespace
Google \ Cloud \ ResourceManager \ V3
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ page_size
int
Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.
↳ page_token
string
Optional. A pagination token returned from a previous call to SearchFolders that indicates from where search should continue.
↳ query
string
Optional. Search criteria used to select the folders to return. If no search criteria is specified then all accessible folders will be returned. Query expressions can be used to restrict results based upon displayName, state and parent, where the operators = (:) NOT, AND and OR can be used along with the suffix wildcard symbol *. The displayName field in a query expression should use escaped quotes for values that include whitespace to prevent unexpected behavior. | Field | Description | |-------------------------|----------------------------------------| | displayName | Filters by displayName. | | parent | Filters by parent (for example: folders/123). | | state, lifecycleState | Filters by state. | Some example queries are: * * Query displayName=Test* returns Folder resources whose display name starts with "Test". * * Query state=ACTIVE returns Folder resources with state set to ACTIVE. * * Query parent=folders/123 returns Folder resources that have folders/123 as a parent resource. * * Query parent=folders/123 AND state=ACTIVE returns active Folder resources that have folders/123 as a parent resource. * * Query displayName=\\"Test String\\" returns Folder resources with display names that include both "Test" and "String".
getPageSize
Optional. The maximum number of folders to return in the response. The
server can return fewer folders than requested. If unspecified, server
picks an appropriate default.
Returns
Type
Description
int
setPageSize
Optional. The maximum number of folders to return in the response. The
server can return fewer folders than requested. If unspecified, server
picks an appropriate default.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPageToken
Optional. A pagination token returned from a previous call to
SearchFolders that indicates from where search should continue.
Returns
Type
Description
string
setPageToken
Optional. A pagination token returned from a previous call to
SearchFolders that indicates from where search should continue.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getQuery
Optional. Search criteria used to select the folders to return.
If no search criteria is specified then all accessible folders will be
returned.
Query expressions can be used to restrict results based upon displayName,
state and parent, where the operators = (:) NOT, AND and OR
can be used along with the suffix wildcard symbol *.
The displayName field in a query expression should use escaped quotes
for values that include whitespace to prevent unexpected behavior.
| Field | Description |
|-------------------------|----------------------------------------|
| displayName | Filters by displayName. |
| parent | Filters by parent (for example: folders/123). |
| state, lifecycleState | Filters by state. |
Some example queries are:
Query displayName=Test* returns Folder resources whose display name
starts with "Test".
Query state=ACTIVE returns Folder resources with
state set to ACTIVE.
Query parent=folders/123 returns Folder resources that have
folders/123 as a parent resource.
Query parent=folders/123 AND state=ACTIVE returns active
Folder resources that have folders/123 as a parent resource.
Query displayName=\\"Test String\\" returns Folder resources with
display names that include both "Test" and "String".
Returns
Type
Description
string
setQuery
Optional. Search criteria used to select the folders to return.
If no search criteria is specified then all accessible folders will be
returned.
Query expressions can be used to restrict results based upon displayName,
state and parent, where the operators = (:) NOT, AND and OR
can be used along with the suffix wildcard symbol *.
The displayName field in a query expression should use escaped quotes
for values that include whitespace to prevent unexpected behavior.
| Field | Description |
|-------------------------|----------------------------------------|
| displayName | Filters by displayName. |
| parent | Filters by parent (for example: folders/123). |
| state, lifecycleState | Filters by state. |
Some example queries are:
Query displayName=Test* returns Folder resources whose display name
starts with "Test".
Query state=ACTIVE returns Folder resources with
state set to ACTIVE.
Query parent=folders/123 returns Folder resources that have
folders/123 as a parent resource.
Query parent=folders/123 AND state=ACTIVE returns active
Folder resources that have folders/123 as a parent resource.
Query displayName=\\"Test String\\" returns Folder resources with
display names that include both "Test" and "String".
Parameter
Name
Description
var
string
Returns
Type
Description
$this
static::build
Parameter
Name
Description
query
string
Optional. Search criteria used to select the folders to return.
If no search criteria is specified then all accessible folders will be
returned.
Query expressions can be used to restrict results based upon displayName,
state and parent, where the operators = (:) NOT, AND and OR
can be used along with the suffix wildcard symbol *.
The displayName field in a query expression should use escaped quotes
for values that include whitespace to prevent unexpected behavior.
| Field | Description |
|-------------------------|----------------------------------------|
| displayName | Filters by displayName. |
| parent | Filters by parent (for example: folders/123). |
| state, lifecycleState | Filters by state. |
Some example queries are:
Query displayName=Test* returns Folder resources whose display name
starts with "Test".
Query state=ACTIVE returns Folder resources with
state set to ACTIVE.
Query parent=folders/123 returns Folder resources that have
folders/123 as a parent resource.
Query parent=folders/123 AND state=ACTIVE returns active
Folder resources that have folders/123 as a parent resource.
Query displayName=\\"Test String\\" returns Folder resources with
display names that include both "Test" and "String".
[[["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 SearchFoldersRequest (1.0.4)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.4 (latest)](/php/docs/reference/cloud-resource-manager/latest/V3.SearchFoldersRequest)\n- [1.0.3](/php/docs/reference/cloud-resource-manager/1.0.3/V3.SearchFoldersRequest)\n- [0.8.5](/php/docs/reference/cloud-resource-manager/0.8.5/V3.SearchFoldersRequest)\n- [0.7.2](/php/docs/reference/cloud-resource-manager/0.7.2/V3.SearchFoldersRequest)\n- [0.6.1](/php/docs/reference/cloud-resource-manager/0.6.1/V3.SearchFoldersRequest)\n- [0.5.0](/php/docs/reference/cloud-resource-manager/0.5.0/V3.SearchFoldersRequest)\n- [0.4.1](/php/docs/reference/cloud-resource-manager/0.4.1/V3.SearchFoldersRequest)\n- [0.3.9](/php/docs/reference/cloud-resource-manager/0.3.9/V3.SearchFoldersRequest) \nReference documentation and code samples for the Google Cloud Resource Manager V3 Client class SearchFoldersRequest.\n\nThe request message for searching folders.\n\nGenerated from protobuf message `google.cloud.resourcemanager.v3.SearchFoldersRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ ResourceManager \\\\ V3\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getPageSize\n\nOptional. The maximum number of folders to return in the response. The\nserver can return fewer folders than requested. If unspecified, server\npicks an appropriate default.\n\n### setPageSize\n\nOptional. The maximum number of folders to return in the response. The\nserver can return fewer folders than requested. If unspecified, server\npicks an appropriate default.\n\n### getPageToken\n\nOptional. A pagination token returned from a previous call to\n`SearchFolders` that indicates from where search should continue.\n\n### setPageToken\n\nOptional. A pagination token returned from a previous call to\n`SearchFolders` that indicates from where search should continue.\n\n### getQuery\n\nOptional. Search criteria used to select the folders to return.\n\nIf no search criteria is specified then all accessible folders will be\nreturned.\nQuery expressions can be used to restrict results based upon displayName,\nstate and parent, where the operators `=` (`:`) `NOT`, `AND` and `OR`\ncan be used along with the suffix wildcard symbol `*`.\nThe `displayName` field in a query expression should use escaped quotes\nfor values that include whitespace to prevent unexpected behavior. \n\n | Field | Description |\n |-------------------------|----------------------------------------|\n | displayName | Filters by displayName. |\n | parent | Filters by parent (for example: folders/123). |\n | state, lifecycleState | Filters by state. |\n\nSome example queries are:\n\n- Query `displayName=Test*` returns Folder resources whose display name starts with \"Test\".\n- Query `state=ACTIVE` returns Folder resources with `state` set to `ACTIVE`.\n- Query `parent=folders/123` returns Folder resources that have `folders/123` as a parent resource.\n- Query `parent=folders/123 AND state=ACTIVE` returns active Folder resources that have `folders/123` as a parent resource.\n- Query `displayName=\\\\\"Test String\\\\\"` returns Folder resources with display names that include both \"Test\" and \"String\".\n\n### setQuery\n\nOptional. Search criteria used to select the folders to return.\n\nIf no search criteria is specified then all accessible folders will be\nreturned.\nQuery expressions can be used to restrict results based upon displayName,\nstate and parent, where the operators `=` (`:`) `NOT`, `AND` and `OR`\ncan be used along with the suffix wildcard symbol `*`.\nThe `displayName` field in a query expression should use escaped quotes\nfor values that include whitespace to prevent unexpected behavior. \n\n | Field | Description |\n |-------------------------|----------------------------------------|\n | displayName | Filters by displayName. |\n | parent | Filters by parent (for example: folders/123). |\n | state, lifecycleState | Filters by state. |\n\nSome example queries are:\n\n- Query `displayName=Test*` returns Folder resources whose display name starts with \"Test\".\n- Query `state=ACTIVE` returns Folder resources with `state` set to `ACTIVE`.\n- Query `parent=folders/123` returns Folder resources that have `folders/123` as a parent resource.\n- Query `parent=folders/123 AND state=ACTIVE` returns active Folder resources that have `folders/123` as a parent resource.\n- Query `displayName=\\\\\"Test String\\\\\"` returns Folder resources with display names that include both \"Test\" and \"String\".\n\n### static::build"]]
