Method: projects.settings.deleteValue
Stay organized with collections
Save and categorize content based on your preferences.
Deletes a setting value. If the setting value does not exist, the operation is a no-op.
Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting or the setting value does not exist. The setting value will not exist if a prior call to DeleteSetting for the setting value already returned a success code. Returns a google.rpc.Status with google.rpc.Code.FAILED_PRECONDITION if the setting is flagged as read only.
HTTP request
DELETE 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 delete. See SettingValue for naming requirements.
Authorization requires the following IAM permission on the specified resource name:
resourcesettings.settingvalues.delete
|
Query parameters
| Parameters |
ignoreReadOnly |
boolean
A flag that allows the deletion of the value of a readOnly setting. WARNING: use at your own risk. Deleting the value of a read only setting is an irreversible action (i.e., it cannot be created again).
|
Request body
The request body must be empty.
Response body
If successful, the response body will be empty.
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."],[[["Deletes a setting value; if the setting value is already deleted or does not exist, it's considered successful."],["Returns an error if the setting is read-only or the setting/setting value is not found."],["The request body must be empty for this DELETE request."],["Requires `resourcesettings.settingvalues.delete` IAM permission and `https://www.googleapis.com/auth/cloud-platform` OAuth scope."]]],["This document details the process of deleting a setting value via a `DELETE` HTTP request to the specified URL. The `name` path parameter identifies the setting value to delete, requiring `resourcesettings.settingvalues.delete` IAM permission. The `ignoreReadOnly` query parameter allows deletion of read-only settings, but is irreversible. The request body must be empty and a successful response will have an empty body, otherwise the status `google.rpc.Status` returns the code of error, `google.rpc.Code.NOT_FOUND` or `google.rpc.Code.FAILED_PRECONDITION`. The operation requires OAuth scope `https://www.googleapis.com/auth/cloud-platform`.\n"]]
