Method: projects.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=projects/*/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."],[[["Retrieves the effective setting value for a Cloud resource, considering resource, ancestor, default, and empty values."],["Uses a GET request to the specified URL with the setting's parent as a path parameter."],["Requires an empty request body and returns a `SettingValue` object in the response body if successful."],["Needs `resourcesettings.settingvalues.get` IAM permission on the specified resource and `cloud-platform` OAuth scope for authorization."]]],["The provided information outlines how to retrieve the effective value of a setting at a specified Cloud resource. It involves sending a `GET` HTTP request to the URL `https://resourcesettings.googleapis.com/v1alpha1/{parent=projects/*/settings/*}:lookupEffectiveValue`. The `parent` path parameter defines the target setting. No request body is needed. The response, if successful, contains a `SettingValue`, or a `NOT_FOUND` status if the setting doesn't exist. Access requires the `resourcesettings.settingvalues.get` IAM permission and `cloud-platform` OAuth scope.\n"]]