Class: Google::Apis::AlertcenterV1beta1::ActivityRule

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

Overview

Alerts from Google Workspace Security Center rules service configured by an admin.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ActivityRule

Returns a new instance of ActivityRule.



133
134
135
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 133

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

Instance Attribute Details

#action_names ⇒ Array<String>

List of action names associated with the rule threshold. Corresponds to the JSON property actionNames

Returns:

  • (Array<String>) 


71
72
73
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 71

def action_names
  @action_names
end

#create_time ⇒ String

Rule create timestamp. Corresponds to the JSON property createTime

Returns:

  • (String) 


76
77
78
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 76

def create_time
  @create_time
end

#description ⇒ String

Description of the rule. Corresponds to the JSON property description

Returns:

  • (String) 


81
82
83
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 81

def description
  @description
end

#display_name ⇒ String

Alert display name. Corresponds to the JSON property displayName

Returns:

  • (String) 


86
87
88
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 86

def display_name
  @display_name
end

#name ⇒ String

Rule name. Corresponds to the JSON property name

Returns:

  • (String) 


91
92
93
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 91

def name
  @name
end

#query ⇒ String

Query that is used to get the data from the associated source. Corresponds to the JSON property query

Returns:

  • (String) 


96
97
98
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 96

def query
  @query
end

#superseded_alerts ⇒ Array<String>

List of alert IDs superseded by this alert. It is used to indicate that this alert is essentially extension of superseded alerts and we found the relationship after creating these alerts. Corresponds to the JSON property supersededAlerts

Returns:

  • (Array<String>) 


103
104
105
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 103

def superseded_alerts
  @superseded_alerts
end

#superseding_alert ⇒ String

Alert ID superseding this alert. It is used to indicate that superseding alert is essentially extension of this alert and we found the relationship after creating both alerts. Corresponds to the JSON property supersedingAlert

Returns:

  • (String) 


110
111
112
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 110

def superseding_alert
  @superseding_alert
end

#threshold ⇒ String

Alert threshold is for example “COUNT > 5”. Corresponds to the JSON property threshold

Returns:

  • (String) 


115
116
117
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 115

def threshold
  @threshold
end

#trigger_source ⇒ String

The trigger sources for this rule. * GMAIL_EVENTS * DEVICE_EVENTS * USER_EVENTS Corresponds to the JSON property triggerSource

Returns:

  • (String) 


121
122
123
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 121

def trigger_source
  @trigger_source
end

#update_time ⇒ String

The timestamp of the last update to the rule. Corresponds to the JSON property updateTime

Returns:

  • (String) 


126
127
128
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 126

def update_time
  @update_time
end

#window_size ⇒ String

Rule window size. Possible values are 1 hour or 24 hours. Corresponds to the JSON property windowSize

Returns:

  • (String) 


131
132
133
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 131

def window_size
  @window_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 138

def update!(**args)
  @action_names = args[:action_names] if args.key?(:action_names)
  @create_time = args[:create_time] if args.key?(:create_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @name = args[:name] if args.key?(:name)
  @query = args[:query] if args.key?(:query)
  @superseded_alerts = args[:superseded_alerts] if args.key?(:superseded_alerts)
  @superseding_alert = args[:superseding_alert] if args.key?(:superseding_alert)
  @threshold = args[:threshold] if args.key?(:threshold)
  @trigger_source = args[:trigger_source] if args.key?(:trigger_source)
  @update_time = args[:update_time] if args.key?(:update_time)
  @window_size = args[:window_size] if args.key?(:window_size)
end