Class: Google::Apis::SecuritycenterV1p1beta1::NotificationConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/securitycenter_v1p1beta1/classes.rb,
generated/google/apis/securitycenter_v1p1beta1/representations.rb,
generated/google/apis/securitycenter_v1p1beta1/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ NotificationConfig

Returns a new instance of NotificationConfig.



1431
1432
1433
 
# File 'generated/google/apis/securitycenter_v1p1beta1/classes.rb', line 1431

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#description ⇒ String

The description of the notification config (max of 1024 characters). Corresponds to the JSON property description

Returns:

  • (String) 


1398
1399
1400
 
# File 'generated/google/apis/securitycenter_v1p1beta1/classes.rb', line 1398

def description
  @description
end

#event_type ⇒ String

The type of events the config is for, e.g. FINDING. Corresponds to the JSON property eventType

Returns:

  • (String) 


1403
1404
1405
 
# File 'generated/google/apis/securitycenter_v1p1beta1/classes.rb', line 1403

def event_type
  @event_type
end

#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". Corresponds to the JSON property name

Returns:

  • (String) 


1411
1412
1413
 
# File 'generated/google/apis/securitycenter_v1p1beta1/classes.rb', line 1411

def name
  @name
end

#pubsub_topic ⇒ String

The PubSub topic to send notifications to. Its format is "projects/[project_id]/topics/[topic]". Corresponds to the JSON property pubsubTopic

Returns:

  • (String) 


1417
1418
1419
 
# File 'generated/google/apis/securitycenter_v1p1beta1/classes.rb', line 1417

def pubsub_topic
  @pubsub_topic
end

#service_account ⇒ String

Output only. The service account that needs "pubsub.topics.publish" permission to publish to the PubSub topic. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


1423
1424
1425
 
# File 'generated/google/apis/securitycenter_v1p1beta1/classes.rb', line 1423

def 
  @service_account
end

#streaming_config ⇒ Google::Apis::SecuritycenterV1p1beta1::StreamingConfig

The config for streaming-based notifications, which send each event as soon as it is detected. Corresponds to the JSON property streamingConfig

Returns:



1429
1430
1431
 
# File 'generated/google/apis/securitycenter_v1p1beta1/classes.rb', line 1429

def streaming_config
  @streaming_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1436
1437
1438
1439
1440
1441
1442
1443
 
# File 'generated/google/apis/securitycenter_v1p1beta1/classes.rb', line 1436

def update!(**args)
  @description = args[:description] if args.key?(:description)
  @event_type = args[:event_type] if args.key?(:event_type)
  @name = args[:name] if args.key?(:name)
  @pubsub_topic = args[:pubsub_topic] if args.key?(:pubsub_topic)
  @service_account = args[:service_account] if args.key?(:service_account)
  @streaming_config = args[:streaming_config] if args.key?(:streaming_config)
end