Method: folders.settings.lookupEffectiveValue
Stay organized with collections
Save and categorize content based on your preferences.
Computes the effective setting value of a setting at the Cloud resource parent. The effective setting value is the calculated setting value at a Cloud resource and evaluates to one of the following options in the given order (the next option is used if the previous one does not exist):
- the setting value on the given resource
- the setting value on the given resource's nearest ancestor
- the setting's default value
- an empty setting value, defined as a
SettingValue with all fields unset
Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist.
HTTP request
GET https://resourcesettings.googleapis.com/v1alpha1/{parent=folders/*/settings/*}:lookupEffectiveValue
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
The setting for which an effective value will be evaluated. See Setting for naming requirements.
Authorization requires the following IAM permission on the specified resource parent:
resourcesettings.settingvalues.get
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of SettingValue.
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\u003eRetrieves the effective setting value for a Cloud resource, considering resource, ancestor, default, and empty values.\u003c/p\u003e\n"],["\u003cp\u003eUses a GET request to \u003ccode\u003ehttps://resourcesettings.googleapis.com/v1alpha1/{parent=folders/*/settings/*}:lookupEffectiveValue\u003c/code\u003e with the setting's path as a parameter.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003eresourcesettings.settingvalues.get\u003c/code\u003e permission and the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eReturns a \u003ccode\u003eSettingValue\u003c/code\u003e object if successful, indicating the effective setting, or a \u003ccode\u003egoogle.rpc.Status\u003c/code\u003e with \u003ccode\u003egoogle.rpc.Code.NOT_FOUND\u003c/code\u003e if the setting doesn't exist.\u003c/p\u003e\n"]]],["This content describes retrieving the effective value of a setting at a specific Cloud resource. The process involves a `GET` HTTP request to a defined URL using gRPC Transcoding syntax. The request requires a `parent` path parameter specifying the target resource and authorization with the `resourcesettings.settingvalues.get` IAM permission. The request body must be empty. The response, if successful, is a `SettingValue` instance; otherwise, a `NOT_FOUND` status may be returned if the setting does not exist. Authorization requires the `cloud-platform` OAuth scope.\n"],null,["# Method: folders.settings.lookupEffectiveValue\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n\nComputes the effective setting value of a setting at the Cloud resource `parent`. The effective setting value is the calculated setting value at a Cloud resource and evaluates to one of the following options in the given order (the next option is used if the previous one does not exist):\n\n1. the setting value on the given resource\n2. the setting value on the given resource's nearest ancestor\n3. the setting's default value\n4. an empty setting value, defined as a `SettingValue` with all fields unset\n\nReturns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting does not exist.\n\n### HTTP request\n\n`GET https://resourcesettings.googleapis.com/v1alpha1/{parent=folders/*/settings/*}:lookupEffectiveValue`\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 setting for which an effective value will be evaluated. See [Setting](/resource-settings/docs/reference/rest/v1alpha1/folders.settings#Setting) for naming requirements. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `parent`: - `resourcesettings.settingvalues.get` |\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 [SettingValue](/resource-settings/docs/reference/rest/v1alpha1/folders.settings.value#SettingValue).\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/)."]]
