Class: OCI::DataSafe::Models::CreateAlertPolicyDetails

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

Overview

The details used to create a new 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
].freeze
SEVERITY_ENUM = 
[
  SEVERITY_CRITICAL = 'CRITICAL'.freeze,
  SEVERITY_HIGH = 'HIGH'.freeze,
  SEVERITY_MEDIUM = 'MEDIUM'.freeze,
  SEVERITY_LOW = 'LOW'.freeze,
  SEVERITY_EVALUATE = 'EVALUATE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateAlertPolicyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/data_safe/models/create_alert_policy_details.rb', line 109

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

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

  self.alert_policy_rule_details = attributes[:'alert_policy_rule_details'] if attributes[:'alert_policy_rule_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_details ⇒ Array<OCI::DataSafe::Models::CreateAlertPolicyRuleDetails>

The details of the alert policy rule.

Returns:



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

def alert_policy_rule_details
  @alert_policy_rule_details
end

#alert_policy_type ⇒ String

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

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/data_safe/models/create_alert_policy_details.rb', line 28

def alert_policy_type
  @alert_policy_type
end

#compartment_id ⇒ String

[Required] The OCID of the compartment where you want to create the alert policy.

Returns:

  • (String) 


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

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


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

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the alert policy.

Returns:

  • (String) 


36
37
38
 
# File 'lib/oci/data_safe/models/create_alert_policy_details.rb', line 36

def description
  @description
end

#display_name ⇒ String

The display name of the alert policy. The name does not have to be unique, and it's changeable.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/data_safe/models/create_alert_policy_details.rb', line 32

def display_name
  @display_name
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>) 


55
56
57
 
# File 'lib/oci/data_safe/models/create_alert_policy_details.rb', line 55

def freeform_tags
  @freeform_tags
end

#severity ⇒ String

[Required] Severity level of the alert raised by this policy.

Returns:

  • (String) 


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

def severity
  @severity
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/oci/data_safe/models/create_alert_policy_details.rb', line 64

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'alert_policy_type': :'alertPolicyType',
    'display_name': :'displayName',
    'description': :'description',
    'severity': :'severity',
    'compartment_id': :'compartmentId',
    'alert_policy_rule_details': :'alertPolicyRuleDetails',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/data_safe/models/create_alert_policy_details.rb', line 80

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'alert_policy_type': :'String',
    'display_name': :'String',
    'description': :'String',
    'severity': :'String',
    'compartment_id': :'String',
    'alert_policy_rule_details': :'Array<OCI::DataSafe::Models::CreateAlertPolicyRuleDetails>',
    '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



179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/oci/data_safe/models/create_alert_policy_details.rb', line 179

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

  self.class == other.class &&
    alert_policy_type == other.alert_policy_type &&
    display_name == other.display_name &&
    description == other.description &&
    severity == other.severity &&
    compartment_id == other.compartment_id &&
    alert_policy_rule_details == other.alert_policy_rule_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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/oci/data_safe/models/create_alert_policy_details.rb', line 216

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


196
197
198
 
# File 'lib/oci/data_safe/models/create_alert_policy_details.rb', line 196

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



205
206
207
 
# File 'lib/oci/data_safe/models/create_alert_policy_details.rb', line 205

def hash
  [alert_policy_type, display_name, description, severity, compartment_id, alert_policy_rule_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



249
250
251
252
253
254
255
256
257
258
 
# File 'lib/oci/data_safe/models/create_alert_policy_details.rb', line 249

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



243
244
245
 
# File 'lib/oci/data_safe/models/create_alert_policy_details.rb', line 243

def to_s
  to_hash.to_s
end