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 | |
|---|---|
| Name | Description |
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".
Generated from protobuf field string name = 1;
| Returns | |
|---|---|
| Type | Description |
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".
Generated from protobuf field string name = 1;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDescription
The description of the notification config (max of 1024 characters).
Generated from protobuf field string description = 2;
| Returns | |
|---|---|
| Type | Description |
string | |
setDescription
The description of the notification config (max of 1024 characters).
Generated from protobuf field string description = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEventType
The type of events the config is for, e.g. FINDING.
Generated from protobuf field .google.cloud.securitycenter.v1p1beta1.NotificationConfig.EventType event_type = 3;
| Returns | |
|---|---|
| Type | Description |
int | |
setEventType
The type of events the config is for, e.g. FINDING.
Generated from protobuf field .google.cloud.securitycenter.v1p1beta1.NotificationConfig.EventType event_type = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$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 = 4 [(.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
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 = 4 [(.google.api.resource_reference) = {
| 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.
Generated from protobuf field string service_account = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
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 = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStreamingConfig
The config for triggering streaming-based notifications.
Generated from protobuf field .google.cloud.securitycenter.v1p1beta1.NotificationConfig.StreamingConfig streaming_config = 6;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\SecurityCenter\V1p1beta1\NotificationConfig\StreamingConfig|null | |
hasStreamingConfig
setStreamingConfig
The config for triggering streaming-based notifications.
Generated from protobuf field .google.cloud.securitycenter.v1p1beta1.NotificationConfig.StreamingConfig streaming_config = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\SecurityCenter\V1p1beta1\NotificationConfig\StreamingConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getNotifyConfig
| Returns | |
|---|---|
| Type | Description |
string | |