Google Cloud Security Command Center V2 Client - Class NotificationConfig (2.0.2)

Reference documentation and code samples for the Google Cloud Security Command Center V2 Client class NotificationConfig.

Cloud Security Command Center (Cloud SCC) notification configs.

A notification config is a Cloud SCC resource that contains the configuration to send notifications for create/update events of findings, assets and etc.

Generated from protobuf message google.cloud.securitycenter.v2.NotificationConfig

Namespace

Google \ Cloud \ SecurityCenter \ V2

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Identifier. The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/notificationConfigs/notify_public_bucket` + `folders/{folder_id}/locations/{location_id}/notificationConfigs/notify_public_bucket` + `projects/{project_id}/locations/{location_id}/notificationConfigs/notify_public_bucket`
`↳ description`	`string` The description of the notification config (max of 1024 characters).
`↳ pubsub_topic`	`string` The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".
`↳ service_account`	`string` Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.
`↳ streaming_config`	`Google\Cloud\SecurityCenter\V2\NotificationConfig\StreamingConfig` The config for triggering streaming-based notifications.

getName

Identifier. The relative resource name of this notification config. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name The following list shows some examples: + organizations/{organization_id}/locations/{location_id}/notificationConfigs/notify_public_bucket + folders/{folder_id}/locations/{location_id}/notificationConfigs/notify_public_bucket + projects/{project_id}/locations/{location_id}/notificationConfigs/notify_public_bucket

Returns
Type	Description
`string`

setName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

The description of the notification config (max of 1024 characters).

Returns
Type	Description
`string`

setDescription

The description of the notification config (max of 1024 characters).

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPubsubTopic

The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".

Returns
Type	Description
`string`

setPubsubTopic

The Pub/Sub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]".

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getServiceAccount

Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.

Returns
Type	Description
`string`

setServiceAccount

Output only. The service account that needs "pubsub.topics.publish" permission to publish to the Pub/Sub topic.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStreamingConfig

The config for triggering streaming-based notifications.

Returns
Type	Description
`Google\Cloud\SecurityCenter\V2\NotificationConfig\StreamingConfig\|null`

hasStreamingConfig

setStreamingConfig

The config for triggering streaming-based notifications.

Parameter
Name	Description
`var`	`Google\Cloud\SecurityCenter\V2\NotificationConfig\StreamingConfig`

Returns
Type	Description
`$this`

getNotifyConfig

Returns
Type	Description
`string`