Class: OCI::CloudGuard::Models::UpdateDetectorRuleDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_guard/models/update_detector_rule_details.rb

Overview

Parameters to be updated for a detector rule within a detector recipe.

Constant Summary collapse

RISK_LEVEL_ENUM =
[
  RISK_LEVEL_CRITICAL = 'CRITICAL'.freeze,
  RISK_LEVEL_HIGH = 'HIGH'.freeze,
  RISK_LEVEL_MEDIUM = 'MEDIUM'.freeze,
  RISK_LEVEL_LOW = 'LOW'.freeze,
  RISK_LEVEL_MINOR = 'MINOR'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateDetectorRuleDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



103
104
105
106
107
108
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
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 103

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.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?

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

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

  self.risk_level = attributes[:'riskLevel'] if attributes[:'riskLevel']

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

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

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

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

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

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

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

  self.data_source_id = attributes[:'dataSourceId'] if attributes[:'dataSourceId']

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

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

  self.entities_mappings = attributes[:'entitiesMappings'] if attributes[:'entitiesMappings']

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

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

Instance Attribute Details

#conditionOCI::CloudGuard::Models::Condition



32
33
34
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 32

def condition
  @condition
end

#configurationsArray<OCI::CloudGuard::Models::DetectorConfiguration>

List of detector rule configurations



29
30
31
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 29

def configurations
  @configurations
end

#data_source_idString

The unique identifier of the attached data source

Returns:

  • (String)


48
49
50
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 48

def data_source_id
  @data_source_id
end

#descriptionString

Description for the detector rule

Returns:

  • (String)


40
41
42
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 40

def description
  @description
end

#entities_mappingsArray<OCI::CloudGuard::Models::EntitiesMapping>

Data source entities mapping for a detector rule



52
53
54
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 52

def entities_mappings
  @entities_mappings
end

#is_enabledBOOLEAN

[Required] Enablement status of the detector rule

Returns:

  • (BOOLEAN)


21
22
23
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 21

def is_enabled
  @is_enabled
end

#labelsArray<String>

User-defined labels for a detector rule

Returns:

  • (Array<String>)


36
37
38
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 36

def labels
  @labels
end

#recommendationString

Recommendation for the detector rule

Returns:

  • (String)


44
45
46
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 44

def recommendation
  @recommendation
end

#risk_levelString

The risk level of the detector rule

Returns:

  • (String)


25
26
27
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 25

def risk_level
  @risk_level
end

Class Method Details

.attribute_mapObject

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'is_enabled': :'isEnabled',
    'risk_level': :'riskLevel',
    'configurations': :'configurations',
    'condition': :'condition',
    'labels': :'labels',
    'description': :'description',
    'recommendation': :'recommendation',
    'data_source_id': :'dataSourceId',
    'entities_mappings': :'entitiesMappings'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 72

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'is_enabled': :'BOOLEAN',
    'risk_level': :'String',
    'configurations': :'Array<OCI::CloudGuard::Models::DetectorConfiguration>',
    'condition': :'OCI::CloudGuard::Models::Condition',
    'labels': :'Array<String>',
    'description': :'String',
    'recommendation': :'String',
    'data_source_id': :'String',
    'entities_mappings': :'Array<OCI::CloudGuard::Models::EntitiesMapping>'
    # 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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 159

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

  self.class == other.class &&
    is_enabled == other.is_enabled &&
    risk_level == other.risk_level &&
    configurations == other.configurations &&
    condition == other.condition &&
    labels == other.labels &&
    description == other.description &&
    recommendation == other.recommendation &&
    data_source_id == other.data_source_id &&
    entities_mappings == other.entities_mappings
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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 197

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


177
178
179
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 177

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



186
187
188
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 186

def hash
  [is_enabled, risk_level, configurations, condition, labels, description, recommendation, data_source_id, entities_mappings].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



230
231
232
233
234
235
236
237
238
239
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 230

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



224
225
226
# File 'lib/oci/cloud_guard/models/update_detector_rule_details.rb', line 224

def to_s
  to_hash.to_s
end