notification_configs

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

Overview

Name	notification_configs
Type	Resource
Id	google.securitycenter.notification_configs

Fields

The following fields are returned by SELECT queries:

folders_notification_configs_get

Successful response

Name	Datatype	Description
name	string	The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".
description	string	The description of the notification config (max of 1024 characters).
pubsubTopic	string	The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".
serviceAccount	string	Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.
streamingConfig	object	The config for triggering streaming-based notifications. (id: StreamingConfig)

projects_notification_configs_get

Successful response

Name	Datatype	Description
name	string	The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".
description	string	The description of the notification config (max of 1024 characters).
pubsubTopic	string	The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".
serviceAccount	string	Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.
streamingConfig	object	The config for triggering streaming-based notifications. (id: StreamingConfig)

organizations_notification_configs_get

Successful response

Name	Datatype	Description
name	string	The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".
description	string	The description of the notification config (max of 1024 characters).
pubsubTopic	string	The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".
serviceAccount	string	Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.
streamingConfig	object	The config for triggering streaming-based notifications. (id: StreamingConfig)

folders_notification_configs_list

Successful response

Name	Datatype	Description
name	string	The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".
description	string	The description of the notification config (max of 1024 characters).
pubsubTopic	string	The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".
serviceAccount	string	Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.
streamingConfig	object	The config for triggering streaming-based notifications. (id: StreamingConfig)

projects_notification_configs_list

Successful response

Name	Datatype	Description
name	string	The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".
description	string	The description of the notification config (max of 1024 characters).
pubsubTopic	string	The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".
serviceAccount	string	Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.
streamingConfig	object	The config for triggering streaming-based notifications. (id: StreamingConfig)

organizations_notification_configs_list

Successful response

Name	Datatype	Description
name	string	The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".
description	string	The description of the notification config (max of 1024 characters).
pubsubTopic	string	The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".
serviceAccount	string	Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.
streamingConfig	object	The config for triggering streaming-based notifications. (id: StreamingConfig)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
folders_notification_configs_get	select	foldersId, notificationConfigsId		Gets a notification config.
projects_notification_configs_get	select	projectsId, notificationConfigsId		Gets a notification config.
organizations_notification_configs_get	select	organizationsId, notificationConfigsId		Gets a notification config.
folders_notification_configs_list	select	foldersId	pageToken, pageSize	Lists notification configs.
projects_notification_configs_list	select	projectsId	pageToken, pageSize	Lists notification configs.
organizations_notification_configs_list	select	organizationsId	pageToken, pageSize	Lists notification configs.
folders_notification_configs_create	insert	foldersId	configId	Creates a notification config.
projects_notification_configs_create	insert	projectsId	configId	Creates a notification config.
organizations_notification_configs_create	insert	organizationsId	configId	Creates a notification config.
folders_notification_configs_patch	update	foldersId, notificationConfigsId	updateMask	Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter
projects_notification_configs_patch	update	projectsId, notificationConfigsId	updateMask	Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter
organizations_notification_configs_patch	update	organizationsId, notificationConfigsId	updateMask	Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter
folders_notification_configs_delete	delete	foldersId, notificationConfigsId		Deletes a notification config.
projects_notification_configs_delete	delete	projectsId, notificationConfigsId		Deletes a notification config.
organizations_notification_configs_delete	delete	organizationsId, notificationConfigsId		Deletes a notification config.

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
foldersId	string
notificationConfigsId	string
organizationsId	string
projectsId	string
configId	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

folders_notification_configs_get

Gets a notification config.

SELECT
name,
description,
pubsubTopic,
serviceAccount,
streamingConfig
FROM google.securitycenter.notification_configs
WHERE foldersId = '{{ foldersId }}' -- required
AND notificationConfigsId = '{{ notificationConfigsId }}' -- required;

projects_notification_configs_get

Gets a notification config.

SELECT
name,
description,
pubsubTopic,
serviceAccount,
streamingConfig
FROM google.securitycenter.notification_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND notificationConfigsId = '{{ notificationConfigsId }}' -- required;

organizations_notification_configs_get

Gets a notification config.

SELECT
name,
description,
pubsubTopic,
serviceAccount,
streamingConfig
FROM google.securitycenter.notification_configs
WHERE organizationsId = '{{ organizationsId }}' -- required
AND notificationConfigsId = '{{ notificationConfigsId }}' -- required;

folders_notification_configs_list

Lists notification configs.

SELECT
name,
description,
pubsubTopic,
serviceAccount,
streamingConfig
FROM google.securitycenter.notification_configs
WHERE foldersId = '{{ foldersId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

projects_notification_configs_list

Lists notification configs.

SELECT
name,
description,
pubsubTopic,
serviceAccount,
streamingConfig
FROM google.securitycenter.notification_configs
WHERE projectsId = '{{ projectsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

organizations_notification_configs_list

Lists notification configs.

SELECT
name,
description,
pubsubTopic,
serviceAccount,
streamingConfig
FROM google.securitycenter.notification_configs
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageToken = '{{ pageToken }}'
AND pageSize = '{{ pageSize }}';

INSERT examples

folders_notification_configs_create

Creates a notification config.

INSERT INTO google.securitycenter.notification_configs (
data__name,
data__description,
data__pubsubTopic,
data__streamingConfig,
foldersId,
configId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ pubsubTopic }}',
'{{ streamingConfig }}',
'{{ foldersId }}',
'{{ configId }}'
RETURNING
name,
description,
pubsubTopic,
serviceAccount,
streamingConfig
;

projects_notification_configs_create

Creates a notification config.

INSERT INTO google.securitycenter.notification_configs (
data__name,
data__description,
data__pubsubTopic,
data__streamingConfig,
projectsId,
configId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ pubsubTopic }}',
'{{ streamingConfig }}',
'{{ projectsId }}',
'{{ configId }}'
RETURNING
name,
description,
pubsubTopic,
serviceAccount,
streamingConfig
;

organizations_notification_configs_create

Creates a notification config.

INSERT INTO google.securitycenter.notification_configs (
data__name,
data__description,
data__pubsubTopic,
data__streamingConfig,
organizationsId,
configId
)
SELECT 
'{{ name }}',
'{{ description }}',
'{{ pubsubTopic }}',
'{{ streamingConfig }}',
'{{ organizationsId }}',
'{{ configId }}'
RETURNING
name,
description,
pubsubTopic,
serviceAccount,
streamingConfig
;

Manifest

# Description fields are for documentation purposes
- name: notification_configs
  props:
    - name: foldersId
      value: string
      description: Required parameter for the notification_configs resource.
    - name: projectsId
      value: string
      description: Required parameter for the notification_configs resource.
    - name: organizationsId
      value: string
      description: Required parameter for the notification_configs resource.
    - name: name
      value: string
      description: >
        The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name Example: "organizations/{organization_id}/notificationConfigs/notify_public_bucket", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".
        
    - name: description
      value: string
      description: >
        The description of the notification config (max of 1024 characters).
        
    - name: pubsubTopic
      value: string
      description: >
        The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".
        
    - name: streamingConfig
      value: object
      description: >
        The config for triggering streaming-based notifications.
        
    - name: configId
      value: string

UPDATE examples

folders_notification_configs_patch

Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter

UPDATE google.securitycenter.notification_configs
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__pubsubTopic = '{{ pubsubTopic }}',
data__streamingConfig = '{{ streamingConfig }}'
WHERE 
foldersId = '{{ foldersId }}' --required
AND notificationConfigsId = '{{ notificationConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
description,
pubsubTopic,
serviceAccount,
streamingConfig;

projects_notification_configs_patch

Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter

UPDATE google.securitycenter.notification_configs
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__pubsubTopic = '{{ pubsubTopic }}',
data__streamingConfig = '{{ streamingConfig }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND notificationConfigsId = '{{ notificationConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
description,
pubsubTopic,
serviceAccount,
streamingConfig;

organizations_notification_configs_patch

Updates a notification config. The following update fields are allowed: description, pubsub_topic, streaming_config.filter

UPDATE google.securitycenter.notification_configs
SET 
data__name = '{{ name }}',
data__description = '{{ description }}',
data__pubsubTopic = '{{ pubsubTopic }}',
data__streamingConfig = '{{ streamingConfig }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND notificationConfigsId = '{{ notificationConfigsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
description,
pubsubTopic,
serviceAccount,
streamingConfig;

DELETE examples

folders_notification_configs_delete

Deletes a notification config.

DELETE FROM google.securitycenter.notification_configs
WHERE foldersId = '{{ foldersId }}' --required
AND notificationConfigsId = '{{ notificationConfigsId }}' --required;

projects_notification_configs_delete

Deletes a notification config.

DELETE FROM google.securitycenter.notification_configs
WHERE projectsId = '{{ projectsId }}' --required
AND notificationConfigsId = '{{ notificationConfigsId }}' --required;

organizations_notification_configs_delete

Deletes a notification config.

DELETE FROM google.securitycenter.notification_configs
WHERE organizationsId = '{{ organizationsId }}' --required
AND notificationConfigsId = '{{ notificationConfigsId }}' --required;