Method: projects.settings.getValue
Stay organized with collections
Save and categorize content based on your preferences.
Gets a setting value.
Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting value does not exist.
HTTP request
GET https://resourcesettings.googleapis.com/v1alpha1/{name=projects/*/settings/*/value}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
The name of the setting value to get. See SettingValue for naming requirements.
Authorization requires the following IAM permission on the specified resource name:
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 a specific setting value using a GET request to the provided URL.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ename\u003c/code\u003e path parameter to identify the setting value, using the format \u003ccode\u003eprojects/*/settings/*/value\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eReturns the setting value if found, otherwise, it returns a \u003ccode\u003egoogle.rpc.Status\u003c/code\u003e with \u003ccode\u003egoogle.rpc.Code.NOT_FOUND\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with the \u003ccode\u003ecloud-platform\u003c/code\u003e OAuth scope or the \u003ccode\u003eresourcesettings.settingvalues.get\u003c/code\u003e IAM permission.\u003c/p\u003e\n"]]],["This content describes retrieving a setting value via an HTTP GET request. The request URL follows gRPC Transcoding syntax, requiring a `name` path parameter, which specifies the setting value. The request body must be empty. Successful requests return a `SettingValue` instance in the response body. If the value is not found, a `NOT_FOUND` status is returned. Authorization requires a specific IAM permission (`resourcesettings.settingvalues.get`) and the `cloud-platform` OAuth scope.\n"],null,["# Method: projects.settings.getValue\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\nGets a setting value.\n\nReturns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting value does not exist.\n\n### HTTP request\n\n`GET https://resourcesettings.googleapis.com/v1alpha1/{name=projects/*/settings/*/value}`\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| `name` | `string` The name of the setting value to get. See [SettingValue](/resource-settings/docs/reference/rest/v1alpha1/folders.settings.value#SettingValue) for naming requirements. Authorization requires the following [IAM](https://cloud.google.com/iam/docs/) permission on the specified resource `name`: - `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/)."]]
