Search for folders that match specific filter criteria. search()
provides an eventually consistent view of the folders a user has access
to which meet the specified filter criteria. This will only return
folders on which the caller has the permission
resourcemanager.folders.get
.
Arguments
Parameters | |
---|---|
pageSize |
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. |
pageToken |
Optional. A pagination token returned from a previous call to |
query |
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 |
Raised exceptions
Exceptions | |
---|---|
ConnectionError |
In case of a network problem (such as DNS failure or refused connection). |
HttpError |
If the response status is >= 400 (excluding 429 and 503). |
TimeoutError |
If a long-running operation takes longer to finish than the specified timeout limit. |
TypeError |
If an operation or function receives an argument of the wrong type. |
ValueError |
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout. |
Response
If successful, the response contains an instance of SearchFoldersResponse
.
Subworkflow snippet
Some fields might be optional or required. To identify required fields, refer to the API documentation.
YAML
- search: call: googleapis.cloudresourcemanager.v3.folders.search args: pageSize: ... pageToken: ... query: ... result: searchResult
JSON
[ { "search": { "call": "googleapis.cloudresourcemanager.v3.folders.search", "args": { "pageSize": "...", "pageToken": "...", "query": "..." }, "result": "searchResult" } } ]