Google Cloud Security Command Center V1 Client - Class NotificationConfig (1.13.1)

Reference documentation and code samples for the Google Cloud Security Command Center V1 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.v1.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", "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).

↳ 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\V1\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", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".

Generated from protobuf field string name = 1;

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", "folders/{folder_id}/notificationConfigs/notify_public_bucket", or "projects/{project_id}/notificationConfigs/notify_public_bucket".

Generated from protobuf field string name = 1;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

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

Generated from protobuf field string description = 2;

Returns
TypeDescription
string

setDescription

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

Generated from protobuf field string description = 2;

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPubsubTopic

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

Generated from protobuf field string pubsub_topic = 3 [(.google.api.resource_reference) = {

Returns
TypeDescription
string

setPubsubTopic

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

Generated from protobuf field string pubsub_topic = 3 [(.google.api.resource_reference) = {

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.

Generated from protobuf field string service_account = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
string

setServiceAccount

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

Generated from protobuf field string service_account = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStreamingConfig

The config for triggering streaming-based notifications.

Generated from protobuf field .google.cloud.securitycenter.v1.NotificationConfig.StreamingConfig streaming_config = 5;

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

hasStreamingConfig

setStreamingConfig

The config for triggering streaming-based notifications.

Generated from protobuf field .google.cloud.securitycenter.v1.NotificationConfig.StreamingConfig streaming_config = 5;

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

getNotifyConfig

Returns
TypeDescription
string