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.



233
234
235
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 233

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>) 


171
172
173
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 171

def action_names
  @action_names
end

#create_time ⇒ String

Rule create timestamp. Corresponds to the JSON property createTime

Returns:

  • (String) 


176
177
178
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 176

def create_time
  @create_time
end

#description ⇒ String

Description of the rule. Corresponds to the JSON property description

Returns:

  • (String) 


181
182
183
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 181

def description
  @description
end

#display_name ⇒ String

Alert display name. Corresponds to the JSON property displayName

Returns:

  • (String) 


186
187
188
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 186

def display_name
  @display_name
end

#name ⇒ String

Rule name. Corresponds to the JSON property name

Returns:

  • (String) 


191
192
193
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 191

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) 


196
197
198
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 196

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>) 


203
204
205
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 203

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) 


210
211
212
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 210

def superseding_alert
  @superseding_alert
end

#threshold ⇒ String

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

Returns:

  • (String) 


215
216
217
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 215

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) 


221
222
223
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 221

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) 


226
227
228
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 226

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) 


231
232
233
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 231

def window_size
  @window_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/google/apis/alertcenter_v1beta1/classes.rb', line 238

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