Method: folders.settings.search
Stay organized with collections
Save and categorize content based on your preferences.
Searches for all setting values that exist on the resource parent. The setting values are not limited to those of a particular setting.
HTTP request
GET https://resourcesettings.googleapis.com/v1alpha1/{parent=folders/*}/settings:search
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
The Cloud resource that parents the setting. Must be in one of the following forms:
projects/{project_number}projects/{project_id}folders/{folder_id}organizations/{organization_id}
Authorization requires the following IAM permission on the specified resource parent:
resourcesettings.settingvalues.list
|
Query parameters
| Parameters |
pageSize |
integer
Unused. The size of the page to be returned.
|
pageToken |
string
Unused. A page token used to retrieve the next page.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of SearchSettingValuesResponse.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-05-25 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-05-25 UTC."],[[["\u003cp\u003eThis documentation outlines how to search for all setting values on a specified Cloud resource using the Resource Settings API.\u003c/p\u003e\n"],["\u003cp\u003eThe search is performed using a \u003ccode\u003eGET\u003c/code\u003e request to a specific endpoint, passing the parent resource in the path.\u003c/p\u003e\n"],["\u003cp\u003eWhile \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e are present as query parameters, they are currently unused.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful requests will return a \u003ccode\u003eSearchSettingValuesResponse\u003c/code\u003e containing the search results.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ecloud-platform\u003c/code\u003e OAuth scope and the \u003ccode\u003eresourcesettings.settingvalues.list\u003c/code\u003e IAM permission on the parent resource.\u003c/p\u003e\n"]]],["This document details how to search for setting values on a resource. The `GET` request targets a specific `parent` resource (project, folder, or organization) using the URL: `https://resourcesettings.googleapis.com/v1alpha1/{parent=folders/*}/settings:search`. The `parent` path parameter is mandatory and needs `resourcesettings.settingvalues.list` IAM permission. `pageSize` and `pageToken` query parameters are currently unused. The request body must be empty. A successful response returns a `SearchSettingValuesResponse`. Authorization requires the `cloud-platform` OAuth scope.\n"],null,["# Method: folders.settings.search\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n\nSearches for all setting values that exist on the resource `parent`. The setting values are not limited to those of a particular setting.\n\n### HTTP request\n\n`GET https://resourcesettings.googleapis.com/v1alpha1/{parent=folders/*}/settings:search`\n\nThe URL uses [gRPC Transcoding](https://github.com/googleapis/googleapis/blob/master/google/api/http.proto) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` The Cloud resource that parents the setting. Must be in one of the following forms: - `projects/{project_number}` - `projects/{project_id}` - `folders/{folder_id}` - `organizations/{organization_id}` Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `resourcesettings.settingvalues.list` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------|\n| `pageSize` | `integer` Unused. The size of the page to be returned. |\n| `pageToken` | `string` Unused. A page token used to retrieve the next page. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [SearchSettingValuesResponse](/resource-settings/docs/reference/rest/v1alpha1/SearchSettingValuesResponse).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/)."]]
