Method: projects.settings.updateValue
Stay organized with collections
Save and categorize content based on your preferences.
Updates a setting value.
Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting or the setting value does not exist. Returns a google.rpc.Status with google.rpc.Code.FAILED_PRECONDITION if the setting is flagged as read only. Returns a google.rpc.Status with google.rpc.Code.ABORTED if the etag supplied in the request does not match the persisted etag of the setting value.
Note: the supplied setting value will perform a full overwrite of all fields.
HTTP request
PATCH https://resourcesettings.googleapis.com/v1alpha1/{settingValue.name=projects/*/settings/*/value}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
settingValue.name |
string
The resource name of the setting value. Must be in one of the following forms:
projects/{project_number}/settings/{setting_name}/valuefolders/{folder_id}/settings/{setting_name}/valueorganizations/{organization_id}/settings/{setting_name}/value For example, "/projects/123/settings/gcp-enableMyFeature/value"
|
Request body
The request body contains an instance of SettingValue.
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\u003eUpdates a setting value, performing a full overwrite of all fields.\u003c/p\u003e\n"],["\u003cp\u003eReturns errors if the setting or value doesn't exist, is read-only, or the etag doesn't match.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eUses the PATCH HTTP method and provides details on the request and response body structures.\u003c/p\u003e\n"],["\u003cp\u003eIdentifies the required path parameter \u003ccode\u003esettingValue.name\u003c/code\u003e with format and example.\u003c/p\u003e\n"]]],["This describes how to update a setting value via a `PATCH` HTTP request to a specific URL using gRPC Transcoding. The request requires a setting value name in the URL path, formatted as a project, folder, or organization identifier followed by the setting name and \"value\". The request body should contain a `SettingValue` instance, overwriting existing fields. A successful response returns a `SettingValue`, otherwise, status codes like `NOT_FOUND`, `FAILED_PRECONDITION`, or `ABORTED` may be returned. OAuth scope `https://www.googleapis.com/auth/cloud-platform` is necessary.\n"],null,["# Method: projects.settings.updateValue\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\nUpdates a setting value.\n\nReturns a `google.rpc.Status` with `google.rpc.Code.NOT_FOUND` if the setting or the setting value does not exist. Returns a `google.rpc.Status` with `google.rpc.Code.FAILED_PRECONDITION` if the setting is flagged as read only. Returns a `google.rpc.Status` with `google.rpc.Code.ABORTED` if the etag supplied in the request does not match the persisted etag of the setting value.\n\nNote: the supplied setting value will perform a full overwrite of all fields.\n\n### HTTP request\n\n`PATCH https://resourcesettings.googleapis.com/v1alpha1/{settingValue.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| `settingValue.name` | `string` The resource name of the setting value. Must be in one of the following forms: - `projects/{project_number}/settings/{setting_name}/value` - `folders/{folder_id}/settings/{setting_name}/value` - `organizations/{organization_id}/settings/{setting_name}/value` For example, \"/projects/123/settings/gcp-enableMyFeature/value\" |\n\n### Request body\n\nThe request body contains an instance of [SettingValue](/resource-settings/docs/reference/rest/v1alpha1/folders.settings.value#SettingValue).\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/)."]]
