Class: Google::Cloud::SecurityCenter::V1p1beta1::NotificationConfig

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/securitycenter/v1p1beta1/notification_config.rb

Overview

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.

Defined Under Namespace

Modules: EventType Classes: StreamingConfig

Instance Attribute Summary collapse

Instance Attribute Details

#description ⇒ ::String

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

Returns:

  • (::String) —

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/securitycenter/v1p1beta1/notification_config.rb', line 52

class NotificationConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The config for streaming-based notifications, which send each event as soon
  # as it is detected.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Expression that defines the filter to apply across create/update events
  #     of assets or findings as specified by the event type. The expression is a
  #     list of zero or more restrictions combined via logical operators `AND`
  #     and `OR`. Parentheses are supported, and `OR` has higher precedence than
  #     `AND`.
  #
  #     Restrictions have the form `<field> <operator> <value>` and may have a
  #     `-` character in front of them to indicate negation. The fields map to
  #     those defined in the corresponding resource.
  #
  #     The supported operators are:
  #
  #     * `=` for all value types.
  #     * `>`, `<`, `>=`, `<=` for integer values.
  #     * `:`, meaning substring matching, for strings.
  #
  #     The supported value types are:
  #
  #     * string literals in quotes.
  #     * integer literals without quotes.
  #     * boolean literals `true` and `false` without quotes.
  class StreamingConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of events.
  module EventType
    # Unspecified event type.
    EVENT_TYPE_UNSPECIFIED = 0

    # Events for findings.
    FINDING = 1
  end
end

#event_type ⇒ ::Google::Cloud::SecurityCenter::V1p1beta1::NotificationConfig::EventType

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

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/securitycenter/v1p1beta1/notification_config.rb', line 52

class NotificationConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The config for streaming-based notifications, which send each event as soon
  # as it is detected.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Expression that defines the filter to apply across create/update events
  #     of assets or findings as specified by the event type. The expression is a
  #     list of zero or more restrictions combined via logical operators `AND`
  #     and `OR`. Parentheses are supported, and `OR` has higher precedence than
  #     `AND`.
  #
  #     Restrictions have the form `<field> <operator> <value>` and may have a
  #     `-` character in front of them to indicate negation. The fields map to
  #     those defined in the corresponding resource.
  #
  #     The supported operators are:
  #
  #     * `=` for all value types.
  #     * `>`, `<`, `>=`, `<=` for integer values.
  #     * `:`, meaning substring matching, for strings.
  #
  #     The supported value types are:
  #
  #     * string literals in quotes.
  #     * integer literals without quotes.
  #     * boolean literals `true` and `false` without quotes.
  class StreamingConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of events.
  module EventType
    # Unspecified event type.
    EVENT_TYPE_UNSPECIFIED = 0

    # Events for findings.
    FINDING = 1
  end
end

#name ⇒ ::String

Returns 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:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/securitycenter/v1p1beta1/notification_config.rb', line 52

class NotificationConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The config for streaming-based notifications, which send each event as soon
  # as it is detected.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Expression that defines the filter to apply across create/update events
  #     of assets or findings as specified by the event type. The expression is a
  #     list of zero or more restrictions combined via logical operators `AND`
  #     and `OR`. Parentheses are supported, and `OR` has higher precedence than
  #     `AND`.
  #
  #     Restrictions have the form `<field> <operator> <value>` and may have a
  #     `-` character in front of them to indicate negation. The fields map to
  #     those defined in the corresponding resource.
  #
  #     The supported operators are:
  #
  #     * `=` for all value types.
  #     * `>`, `<`, `>=`, `<=` for integer values.
  #     * `:`, meaning substring matching, for strings.
  #
  #     The supported value types are:
  #
  #     * string literals in quotes.
  #     * integer literals without quotes.
  #     * boolean literals `true` and `false` without quotes.
  class StreamingConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of events.
  module EventType
    # Unspecified event type.
    EVENT_TYPE_UNSPECIFIED = 0

    # Events for findings.
    FINDING = 1
  end
end

#pubsub_topic ⇒ ::String

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

Returns:

  • (::String) —

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/securitycenter/v1p1beta1/notification_config.rb', line 52

class NotificationConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The config for streaming-based notifications, which send each event as soon
  # as it is detected.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Expression that defines the filter to apply across create/update events
  #     of assets or findings as specified by the event type. The expression is a
  #     list of zero or more restrictions combined via logical operators `AND`
  #     and `OR`. Parentheses are supported, and `OR` has higher precedence than
  #     `AND`.
  #
  #     Restrictions have the form `<field> <operator> <value>` and may have a
  #     `-` character in front of them to indicate negation. The fields map to
  #     those defined in the corresponding resource.
  #
  #     The supported operators are:
  #
  #     * `=` for all value types.
  #     * `>`, `<`, `>=`, `<=` for integer values.
  #     * `:`, meaning substring matching, for strings.
  #
  #     The supported value types are:
  #
  #     * string literals in quotes.
  #     * integer literals without quotes.
  #     * boolean literals `true` and `false` without quotes.
  class StreamingConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of events.
  module EventType
    # Unspecified event type.
    EVENT_TYPE_UNSPECIFIED = 0

    # Events for findings.
    FINDING = 1
  end
end

#service_account ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/securitycenter/v1p1beta1/notification_config.rb', line 52

class NotificationConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The config for streaming-based notifications, which send each event as soon
  # as it is detected.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Expression that defines the filter to apply across create/update events
  #     of assets or findings as specified by the event type. The expression is a
  #     list of zero or more restrictions combined via logical operators `AND`
  #     and `OR`. Parentheses are supported, and `OR` has higher precedence than
  #     `AND`.
  #
  #     Restrictions have the form `<field> <operator> <value>` and may have a
  #     `-` character in front of them to indicate negation. The fields map to
  #     those defined in the corresponding resource.
  #
  #     The supported operators are:
  #
  #     * `=` for all value types.
  #     * `>`, `<`, `>=`, `<=` for integer values.
  #     * `:`, meaning substring matching, for strings.
  #
  #     The supported value types are:
  #
  #     * string literals in quotes.
  #     * integer literals without quotes.
  #     * boolean literals `true` and `false` without quotes.
  class StreamingConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of events.
  module EventType
    # Unspecified event type.
    EVENT_TYPE_UNSPECIFIED = 0

    # Events for findings.
    FINDING = 1
  end
end

#streaming_config ⇒ ::Google::Cloud::SecurityCenter::V1p1beta1::NotificationConfig::StreamingConfig

Returns The config for triggering streaming-based notifications.

Returns:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'proto_docs/google/cloud/securitycenter/v1p1beta1/notification_config.rb', line 52

class NotificationConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The config for streaming-based notifications, which send each event as soon
  # as it is detected.
  # @!attribute [rw] filter
  #   @return [::String]
  #     Expression that defines the filter to apply across create/update events
  #     of assets or findings as specified by the event type. The expression is a
  #     list of zero or more restrictions combined via logical operators `AND`
  #     and `OR`. Parentheses are supported, and `OR` has higher precedence than
  #     `AND`.
  #
  #     Restrictions have the form `<field> <operator> <value>` and may have a
  #     `-` character in front of them to indicate negation. The fields map to
  #     those defined in the corresponding resource.
  #
  #     The supported operators are:
  #
  #     * `=` for all value types.
  #     * `>`, `<`, `>=`, `<=` for integer values.
  #     * `:`, meaning substring matching, for strings.
  #
  #     The supported value types are:
  #
  #     * string literals in quotes.
  #     * integer literals without quotes.
  #     * boolean literals `true` and `false` without quotes.
  class StreamingConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The type of events.
  module EventType
    # Unspecified event type.
    EVENT_TYPE_UNSPECIFIED = 0

    # Events for findings.
    FINDING = 1
  end
end