Class: OCI::DataSafe::Models::AlertSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_safe/models/alert_summary.rb

Overview

Summary of a Data Safe Alert.

Constant Summary collapse

STATUS_ENUM = 
[
  STATUS_OPEN = 'OPEN'.freeze,
  STATUS_CLOSED = 'CLOSED'.freeze,
  STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SEVERITY_ENUM = 
[
  SEVERITY_CRITICAL = 'CRITICAL'.freeze,
  SEVERITY_HIGH = 'HIGH'.freeze,
  SEVERITY_MEDIUM = 'MEDIUM'.freeze,
  SEVERITY_LOW = 'LOW'.freeze,
  SEVERITY_EVALUATE = 'EVALUATE'.freeze,
  SEVERITY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
OPERATION_STATUS_ENUM = 
[
  OPERATION_STATUS_SUCCEEDED = 'SUCCEEDED'.freeze,
  OPERATION_STATUS_FAILED = 'FAILED'.freeze,
  OPERATION_STATUS_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
ALERT_TYPE_ENUM = 
[
  ALERT_TYPE_AUDITING = 'AUDITING'.freeze,
  ALERT_TYPE_SECURITY_ASSESSMENT = 'SECURITY_ASSESSMENT'.freeze,
  ALERT_TYPE_USER_ASSESSMENT = 'USER_ASSESSMENT'.freeze,
  ALERT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AlertSummary

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :status (String) —

    The value to assign to the #status property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :severity (String) —

    The value to assign to the #severity property

  • :operation_time (DateTime) —

    The value to assign to the #operation_time property

  • :operation (String) —

    The value to assign to the #operation property

  • :operation_status (String) —

    The value to assign to the #operation_status property

  • :target_ids (Array<String>) —

    The value to assign to the #target_ids property

  • :target_names (Array<String>) —

    The value to assign to the #target_names property

  • :policy_id (String) —

    The value to assign to the #policy_id property

  • :alert_type (String) —

    The value to assign to the #alert_type property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_updated (DateTime) —

    The value to assign to the #time_updated property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :alert_policy_rule_key (String) —

    The value to assign to the #alert_policy_rule_key property

  • :alert_policy_rule_name (String) —

    The value to assign to the #alert_policy_rule_name property

  • :feature_details (Hash<String, Hash<String, Object>>) —

    The value to assign to the #feature_details property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property



223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 223

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.id = attributes[:'id'] if attributes[:'id']

  self.status = attributes[:'status'] if attributes[:'status']

  self.display_name = attributes[:'displayName'] if attributes[:'displayName']

  raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name')

  self.display_name = attributes[:'display_name'] if attributes[:'display_name']

  self.description = attributes[:'description'] if attributes[:'description']

  self.severity = attributes[:'severity'] if attributes[:'severity']

  self.operation_time = attributes[:'operationTime'] if attributes[:'operationTime']

  raise 'You cannot provide both :operationTime and :operation_time' if attributes.key?(:'operationTime') && attributes.key?(:'operation_time')

  self.operation_time = attributes[:'operation_time'] if attributes[:'operation_time']

  self.operation = attributes[:'operation'] if attributes[:'operation']

  self.operation_status = attributes[:'operationStatus'] if attributes[:'operationStatus']

  raise 'You cannot provide both :operationStatus and :operation_status' if attributes.key?(:'operationStatus') && attributes.key?(:'operation_status')

  self.operation_status = attributes[:'operation_status'] if attributes[:'operation_status']

  self.target_ids = attributes[:'targetIds'] if attributes[:'targetIds']

  raise 'You cannot provide both :targetIds and :target_ids' if attributes.key?(:'targetIds') && attributes.key?(:'target_ids')

  self.target_ids = attributes[:'target_ids'] if attributes[:'target_ids']

  self.target_names = attributes[:'targetNames'] if attributes[:'targetNames']

  raise 'You cannot provide both :targetNames and :target_names' if attributes.key?(:'targetNames') && attributes.key?(:'target_names')

  self.target_names = attributes[:'target_names'] if attributes[:'target_names']

  self.policy_id = attributes[:'policyId'] if attributes[:'policyId']

  raise 'You cannot provide both :policyId and :policy_id' if attributes.key?(:'policyId') && attributes.key?(:'policy_id')

  self.policy_id = attributes[:'policy_id'] if attributes[:'policy_id']

  self.alert_type = attributes[:'alertType'] if attributes[:'alertType']

  raise 'You cannot provide both :alertType and :alert_type' if attributes.key?(:'alertType') && attributes.key?(:'alert_type')

  self.alert_type = attributes[:'alert_type'] if attributes[:'alert_type']

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

  raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id')

  self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id']

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

  raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created')

  self.time_created = attributes[:'time_created'] if attributes[:'time_created']

  self.time_updated = attributes[:'timeUpdated'] if attributes[:'timeUpdated']

  raise 'You cannot provide both :timeUpdated and :time_updated' if attributes.key?(:'timeUpdated') && attributes.key?(:'time_updated')

  self.time_updated = attributes[:'time_updated'] if attributes[:'time_updated']

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

  raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state')

  self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state']

  self.alert_policy_rule_key = attributes[:'alertPolicyRuleKey'] if attributes[:'alertPolicyRuleKey']

  raise 'You cannot provide both :alertPolicyRuleKey and :alert_policy_rule_key' if attributes.key?(:'alertPolicyRuleKey') && attributes.key?(:'alert_policy_rule_key')

  self.alert_policy_rule_key = attributes[:'alert_policy_rule_key'] if attributes[:'alert_policy_rule_key']

  self.alert_policy_rule_name = attributes[:'alertPolicyRuleName'] if attributes[:'alertPolicyRuleName']

  raise 'You cannot provide both :alertPolicyRuleName and :alert_policy_rule_name' if attributes.key?(:'alertPolicyRuleName') && attributes.key?(:'alert_policy_rule_name')

  self.alert_policy_rule_name = attributes[:'alert_policy_rule_name'] if attributes[:'alert_policy_rule_name']

  self.feature_details = attributes[:'featureDetails'] if attributes[:'featureDetails']

  raise 'You cannot provide both :featureDetails and :feature_details' if attributes.key?(:'featureDetails') && attributes.key?(:'feature_details')

  self.feature_details = attributes[:'feature_details'] if attributes[:'feature_details']

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

  raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags')

  self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags']

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

  raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags')

  self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags']
end

Instance Attribute Details

#alert_policy_rule_key ⇒ String

The key of the rule of alert policy that triggered alert.

Returns:

  • (String) 


113
114
115
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 113

def alert_policy_rule_key
  @alert_policy_rule_key
end

#alert_policy_rule_name ⇒ String

The display name of the rule of alert policy that triggered alert.

Returns:

  • (String) 


117
118
119
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 117

def alert_policy_rule_name
  @alert_policy_rule_name
end

#alert_type ⇒ String

Type of the alert. Indicates the Data Safe feature triggering the alert.

Returns:

  • (String) 


93
94
95
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 93

def alert_type
  @alert_type
end

#compartment_id ⇒ String

[Required] The OCID of the compartment that contains the alert.

Returns:

  • (String) 


97
98
99
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 97

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


136
137
138
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 136

def defined_tags
  @defined_tags
end

#description ⇒ String

The details of the alert.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 61

def description
  @description
end

#display_name ⇒ String

[Required] The display name of the alert.

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 57

def display_name
  @display_name
end

#feature_details ⇒ Hash<String, Hash<String, Object>>

Map that contains maps of values. Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


123
124
125
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 123

def feature_details
  @feature_details
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


130
131
132
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 130

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the alert.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 49

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the alert.

Returns:

  • (String) 


109
110
111
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 109

def lifecycle_state
  @lifecycle_state
end

#operation ⇒ String

The operation that triggered alert.

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 73

def operation
  @operation
end

#operation_status ⇒ String

The result of the operation (event) that triggered alert.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 77

def operation_status
  @operation_status
end

#operation_time ⇒ DateTime

Creation date and time of the operation that triggered alert, in the format defined by RFC3339.

Returns:

  • (DateTime) 


69
70
71
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 69

def operation_time
  @operation_time
end

#policy_id ⇒ String

The OCID of the policy that triggered alert.

Returns:

  • (String) 


89
90
91
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 89

def policy_id
  @policy_id
end

#severity ⇒ String

[Required] Severity level of the alert.

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 65

def severity
  @severity
end

#status ⇒ String

[Required] The status of the alert.

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 53

def status
  @status
end

#target_ids ⇒ Array<String>

Array of OCIDs of the target database.

Returns:

  • (Array<String>) 


81
82
83
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 81

def target_ids
  @target_ids
end

#target_names ⇒ Array<String>

Array of names of the target database.

Returns:

  • (Array<String>) 


85
86
87
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 85

def target_names
  @target_names
end

#time_created ⇒ DateTime

[Required] Creation date and time of the alert, in the format defined by RFC3339.

Returns:

  • (DateTime) 


101
102
103
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 101

def time_created
  @time_created
end

#time_updated ⇒ DateTime

[Required] Last date and time the alert was updated, in the format defined by RFC3339.

Returns:

  • (DateTime) 


105
106
107
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 105

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 139

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'status': :'status',
    'display_name': :'displayName',
    'description': :'description',
    'severity': :'severity',
    'operation_time': :'operationTime',
    'operation': :'operation',
    'operation_status': :'operationStatus',
    'target_ids': :'targetIds',
    'target_names': :'targetNames',
    'policy_id': :'policyId',
    'alert_type': :'alertType',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'alert_policy_rule_key': :'alertPolicyRuleKey',
    'alert_policy_rule_name': :'alertPolicyRuleName',
    'feature_details': :'featureDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 168

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'status': :'String',
    'display_name': :'String',
    'description': :'String',
    'severity': :'String',
    'operation_time': :'DateTime',
    'operation': :'String',
    'operation_status': :'String',
    'target_ids': :'Array<String>',
    'target_names': :'Array<String>',
    'policy_id': :'String',
    'alert_type': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'alert_policy_rule_key': :'String',
    'alert_policy_rule_name': :'String',
    'feature_details': :'Hash<String, Hash<String, Object>>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 408

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    status == other.status &&
    display_name == other.display_name &&
    description == other.description &&
    severity == other.severity &&
    operation_time == other.operation_time &&
    operation == other.operation &&
    operation_status == other.operation_status &&
    target_ids == other.target_ids &&
    target_names == other.target_names &&
    policy_id == other.policy_id &&
    alert_type == other.alert_type &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    alert_policy_rule_key == other.alert_policy_rule_key &&
    alert_policy_rule_name == other.alert_policy_rule_name &&
    feature_details == other.feature_details &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 458

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


438
439
440
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 438

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



447
448
449
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 447

def hash
  [id, status, display_name, description, severity, operation_time, operation, operation_status, target_ids, target_names, policy_id, alert_type, compartment_id, time_created, time_updated, lifecycle_state, alert_policy_rule_key, alert_policy_rule_name, feature_details, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



491
492
493
494
495
496
497
498
499
500
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 491

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



485
486
487
 
# File 'lib/oci/data_safe/models/alert_summary.rb', line 485

def to_s
  to_hash.to_s
end