Class: OCI::DataSafe::Models::AlertPolicySummary

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

Overview

Summary of a Data Safe alert policy.

Constant Summary collapse

ALERT_POLICY_TYPE_ENUM =
[
  ALERT_POLICY_TYPE_AUDITING = 'AUDITING'.freeze,
  ALERT_POLICY_TYPE_SECURITY_ASSESSMENT = 'SECURITY_ASSESSMENT'.freeze,
  ALERT_POLICY_TYPE_USER_ASSESSMENT = 'USER_ASSESSMENT'.freeze,
  ALERT_POLICY_TYPE_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
LIFECYCLE_STATE_ENUM =
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.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 = {}) ⇒ AlertPolicySummary

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

  • :display_name (String)

    The value to assign to the #display_name property

  • :description (String)

    The value to assign to the #description property

  • :alert_policy_type (String)

    The value to assign to the #alert_policy_type property

  • :is_user_defined (BOOLEAN)

    The value to assign to the #is_user_defined property

  • :severity (String)

    The value to assign to the #severity 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

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



150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 150

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.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.alert_policy_type = attributes[:'alertPolicyType'] if attributes[:'alertPolicyType']

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

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

  self.is_user_defined = attributes[:'isUserDefined'] unless attributes[:'isUserDefined'].nil?

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

  self.is_user_defined = attributes[:'is_user_defined'] unless attributes[:'is_user_defined'].nil?

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

  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.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_typeString

[Required] Indicates the Data Safe feature that the alert policy belongs to.

Returns:

  • (String)


52
53
54
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 52

def alert_policy_type
  @alert_policy_type
end

#compartment_idString

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

Returns:

  • (String)


64
65
66
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 64

def compartment_id
  @compartment_id
end

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


90
91
92
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 90

def defined_tags
  @defined_tags
end

#descriptionString

The details of the alert policy.

Returns:

  • (String)


48
49
50
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 48

def description
  @description
end

#display_nameString

[Required] The display name of the alert policy.

Returns:

  • (String)


44
45
46
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 44

def display_name
  @display_name
end

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


83
84
85
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 83

def freeform_tags
  @freeform_tags
end

#idString

[Required] The OCID of the alert policy.

Returns:

  • (String)


40
41
42
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 40

def id
  @id
end

#is_user_definedBOOLEAN

Indicates if the alert policy is user-defined (true) or pre-defined (false).

Returns:

  • (BOOLEAN)


56
57
58
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 56

def is_user_defined
  @is_user_defined
end

#lifecycle_stateString

[Required] The current state of the alert policy.

Returns:

  • (String)


76
77
78
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 76

def lifecycle_state
  @lifecycle_state
end

#severityString

Severity level of the alert raised by this policy.

Returns:

  • (String)


60
61
62
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 60

def severity
  @severity
end

#time_createdDateTime

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

Returns:

  • (DateTime)


68
69
70
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 68

def time_created
  @time_created
end

#time_updatedDateTime

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

Returns:

  • (DateTime)


72
73
74
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 72

def time_updated
  @time_updated
end

Class Method Details

.attribute_mapObject

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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 93

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'alert_policy_type': :'alertPolicyType',
    'is_user_defined': :'isUserDefined',
    'severity': :'severity',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 113

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'alert_policy_type': :'String',
    'is_user_defined': :'BOOLEAN',
    'severity': :'String',
    'compartment_id': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    '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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 263

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    alert_policy_type == other.alert_policy_type &&
    is_user_defined == other.is_user_defined &&
    severity == other.severity &&
    compartment_id == other.compartment_id &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    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



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 304

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


284
285
286
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 284

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



293
294
295
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 293

def hash
  [id, display_name, description, alert_policy_type, is_user_defined, severity, compartment_id, time_created, time_updated, lifecycle_state, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



337
338
339
340
341
342
343
344
345
346
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 337

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



331
332
333
# File 'lib/oci/data_safe/models/alert_policy_summary.rb', line 331

def to_s
  to_hash.to_s
end