settings
Creates, updates, deletes, gets or lists a settings resource.
Overview
| Name | settings |
| Type | Resource |
| Id | google.resourcesettings.settings |
Fields
| Name | Datatype | Description |
|---|---|---|
name | string | The resource name of the setting. Must be in one of the following forms: projects/{project_number}/settings/{setting_name} folders/{folder_id}/settings/{setting_name} * organizations/{organization_id}/settings/{setting_name} For example, "/projects/123/settings/gcp-enableMyFeature" |
effectiveValue | object | The data in a setting value. |
etag | string | A fingerprint used for optimistic concurrency. See UpdateSetting for more details. |
localValue | object | The data in a setting value. |
metadata | object | Metadata about a setting which is not editable by the end user. |
Methods
| Name | Accessible by | Required Params | Description |
|---|---|---|---|
folders_settings_get | SELECT | foldersId, settingsId | Returns a specified setting. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist. |
folders_settings_list | SELECT | foldersId | Lists all the settings that are available on the Cloud resource parent. |
organizations_settings_get | SELECT | organizationsId, settingsId | Returns a specified setting. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist. |
organizations_settings_list | SELECT | organizationsId | Lists all the settings that are available on the Cloud resource parent. |
projects_settings_get | SELECT | projectsId, settingsId | Returns a specified setting. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting does not exist. |
projects_settings_list | SELECT | projectsId | Lists all the settings that are available on the Cloud resource parent. |
folders_settings_patch | UPDATE | foldersId, settingsId | Updates a specified setting. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting 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. On success, the response will contain only name, local_value and etag. The metadata and effective_value cannot be updated through this API. Note: the supplied setting will perform a full overwrite of the local_value field. |
organizations_settings_patch | UPDATE | organizationsId, settingsId | Updates a specified setting. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting 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. On success, the response will contain only name, local_value and etag. The metadata and effective_value cannot be updated through this API. Note: the supplied setting will perform a full overwrite of the local_value field. |
projects_settings_patch | UPDATE | projectsId, settingsId | Updates a specified setting. Returns a google.rpc.Status with google.rpc.Code.NOT_FOUND if the setting 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. On success, the response will contain only name, local_value and etag. The metadata and effective_value cannot be updated through this API. Note: the supplied setting will perform a full overwrite of the local_value field. |
SELECT examples
Lists all the settings that are available on the Cloud resource parent.
SELECT
name,
effectiveValue,
etag,
localValue,
metadata
FROM google.resourcesettings.settings
WHERE foldersId = '{{ foldersId }}';
UPDATE example
Updates a settings resource.
/*+ update */
UPDATE google.resourcesettings.settings
SET
localValue = '{{ localValue }}',
etag = '{{ etag }}',
name = '{{ name }}'
WHERE
foldersId = '{{ foldersId }}'
AND settingsId = '{{ settingsId }}';