Skip to main content

settings

Creates, updates, deletes, gets or lists a settings resource.

Overview

Namesettings
TypeResource
Idgoogle.advisorynotifications.settings

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringIdentifier. The resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings or projects/{projects}/locations/{location}/settings.
etagstringRequired. Fingerprint for optimistic concurrency returned in Get requests. Must be provided for Update requests. If the value provided does not match the value known to the server, ABORTED will be thrown, and the client should retry the read-modify-write cycle.
notificationSettingsobjectRequired. Map of each notification type and its settings to get/set all settings at once. The server will validate the value for each notification type.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
get_settingsselectprojectsId, locationsIdGet notification settings.
update_settingsupdateprojectsId, locationsIdUpdate notification settings.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
locationsIdstring
projectsIdstring

SELECT examples

Get notification settings.

SELECT
name,
etag,
notificationSettings
FROM google.advisorynotifications.settings
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required;

UPDATE examples

Update notification settings.

UPDATE google.advisorynotifications.settings
SET
data__name = '{{ name }}',
data__notificationSettings = '{{ notificationSettings }}',
data__etag = '{{ etag }}'
WHERE
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
RETURNING
name,
etag,
notificationSettings;