Google Cloud Security Command Center V1p1beta1 Client - Class NotificationConfig (1.14.2)

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

Security Command Center notification configs.

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

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ 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".

↳ description string

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

↳ event_type int

The type of events the config is for, e.g. FINDING.

↳ 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\V1p1beta1\NotificationConfig\StreamingConfig

The config for triggering streaming-based notifications.

getName

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".

Returns
TypeDescription
string

setName

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".

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

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

Returns
TypeDescription
string

setDescription

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEventType

The type of events the config is for, e.g. FINDING.

Returns
TypeDescription
int

setEventType

The type of events the config is for, e.g. FINDING.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPubsubTopic

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

Returns
TypeDescription
string

setPubsubTopic

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getServiceAccount

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

Returns
TypeDescription
string

setServiceAccount

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStreamingConfig

The config for triggering streaming-based notifications.

Returns
TypeDescription
Google\Cloud\SecurityCenter\V1p1beta1\NotificationConfig\StreamingConfig|null

hasStreamingConfig

setStreamingConfig

The config for triggering streaming-based notifications.

Parameter
NameDescription
var Google\Cloud\SecurityCenter\V1p1beta1\NotificationConfig\StreamingConfig
Returns
TypeDescription
$this

getNotifyConfig

Returns
TypeDescription
string