settings
Creates, updates, deletes, gets or lists a settings resource.
Overview
| Name | settings |
| Type | Resource |
| Id | google.observability.settings |
Fields
The following fields are returned by SELECT queries:
- get_settings
| Name | Datatype | Description |
|---|---|---|
name | string | Identifier. The resource name of the settings. |
defaultStorageLocation | string | Optional. The location which should be used when any regional resources are provisioned by Google Cloud. |
kmsKeyName | string | Optional. The resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example: "projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key" |
serviceAccountId | string | Output only. The service account for the given resource container, such as project or folder. This will be used by Cloud Observability to perform actions in the container's project like access KMS keys or create Links. Always the same service account per resource container regardless of region. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_settings | select | organizationsId, locationsId | Get Settings | |
update_settings | update | organizationsId, locationsId | updateMask | Update 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.
| Name | Datatype | Description |
|---|---|---|
locationsId | string | |
organizationsId | string | |
updateMask | string (google-fieldmask) |
SELECT examples
- get_settings
Get Settings
SELECT
name,
defaultStorageLocation,
kmsKeyName,
serviceAccountId
FROM google.observability.settings
WHERE organizationsId = '{{ organizationsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
;
UPDATE examples
- update_settings
Update Settings
UPDATE google.observability.settings
SET
data__name = '{{ name }}',
data__kmsKeyName = '{{ kmsKeyName }}',
data__defaultStorageLocation = '{{ defaultStorageLocation }}'
WHERE
organizationsId = '{{ organizationsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;