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."],[[["Updates a setting value, performing a full overwrite of all fields."],["Returns errors if the setting or value doesn't exist, is read-only, or the etag doesn't match."],["Requires the `https://www.googleapis.com/auth/cloud-platform` OAuth scope for authorization."],["Uses the PATCH HTTP method and provides details on the request and response body structures."],["Identifies the required path parameter `settingValue.name` with format and example."]]],["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"]]
