Class: OCI::CloudGuard::Models::DetectorRuleSummary

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

Overview

Summary of the Detector Rules.

Constant Summary collapse

DETECTOR_ENUM =
[
  DETECTOR_IAAS_ACTIVITY_DETECTOR = 'IAAS_ACTIVITY_DETECTOR'.freeze,
  DETECTOR_IAAS_CONFIGURATION_DETECTOR = 'IAAS_CONFIGURATION_DETECTOR'.freeze,
  DETECTOR_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
MANAGED_LIST_TYPES_ENUM =
[
  MANAGED_LIST_TYPES_CIDR_BLOCK = 'CIDR_BLOCK'.freeze,
  MANAGED_LIST_TYPES_USERS = 'USERS'.freeze,
  MANAGED_LIST_TYPES_GROUPS = 'GROUPS'.freeze,
  MANAGED_LIST_TYPES_IPV4_ADDRESS = 'IPV4ADDRESS'.freeze,
  MANAGED_LIST_TYPES_IPV6_ADDRESS = 'IPV6ADDRESS'.freeze,
  MANAGED_LIST_TYPES_RESOURCE_OCID = 'RESOURCE_OCID'.freeze,
  MANAGED_LIST_TYPES_REGION = 'REGION'.freeze,
  MANAGED_LIST_TYPES_COUNTRY = 'COUNTRY'.freeze,
  MANAGED_LIST_TYPES_STATE = 'STATE'.freeze,
  MANAGED_LIST_TYPES_CITY = 'CITY'.freeze,
  MANAGED_LIST_TYPES_TAGS = 'TAGS'.freeze,
  MANAGED_LIST_TYPES_GENERIC = 'GENERIC'.freeze,
  MANAGED_LIST_TYPES_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_INACTIVE = 'INACTIVE'.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 = {}) ⇒ DetectorRuleSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 163

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

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

  self.service_type = attributes[:'serviceType'] if attributes[:'serviceType']

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

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

  self.resource_type = attributes[:'resourceType'] if attributes[:'resourceType']

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

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

  self.managed_list_types = attributes[:'managedListTypes'] if attributes[:'managedListTypes']

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

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

  self.candidate_responder_rules = attributes[:'candidateResponderRules'] if attributes[:'candidateResponderRules']

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

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

  self.detector_details = attributes[:'detectorDetails'] if attributes[:'detectorDetails']

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

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

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

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

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

Instance Attribute Details

#candidate_responder_rulesArray<OCI::CloudGuard::Models::CandidateResponderRule>

List of CandidateResponderRule related to this rule



78
79
80
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 78

def candidate_responder_rules
  @candidate_responder_rules
end

#descriptionString

Description for detector rule

Returns:

  • (String)


54
55
56
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 54

def description
  @description
end

#detectorString

[Required] possible type of detectors

Returns:

  • (String)


62
63
64
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 62

def detector
  @detector
end

#detector_detailsOCI::CloudGuard::Models::DetectorDetails



81
82
83
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 81

def detector_details
  @detector_details
end

#display_nameString

DetectorTemplate Identifier, can be renamed

Returns:

  • (String)


50
51
52
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 50

def display_name
  @display_name
end

#idString

[Required] The unique identifier of the detector rule

Returns:

  • (String)


46
47
48
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 46

def id
  @id
end

#lifecycle_detailsString

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String)


97
98
99
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 97

def lifecycle_details
  @lifecycle_details
end

#lifecycle_stateString

The current state of the detector rule

Returns:

  • (String)


93
94
95
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 93

def lifecycle_state
  @lifecycle_state
end

#managed_list_typesArray<String>

List of cloudguard managed list types related to this rule

Returns:

  • (Array<String>)


74
75
76
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 74

def managed_list_types
  @managed_list_types
end

#recommendationString

Recommendation for detector rule

Returns:

  • (String)


58
59
60
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 58

def recommendation
  @recommendation
end

#resource_typeString

resource type of the configuration to which the rule is applied

Returns:

  • (String)


70
71
72
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 70

def resource_type
  @resource_type
end

#service_typeString

service type of the configuration to which the rule is applied

Returns:

  • (String)


66
67
68
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 66

def service_type
  @service_type
end

#time_createdDateTime

The date and time the detector rule was created. Format defined by RFC3339.

Returns:

  • (DateTime)


85
86
87
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 85

def time_created
  @time_created
end

#time_updatedDateTime

The date and time the detector rule was updated. Format defined by RFC3339.

Returns:

  • (DateTime)


89
90
91
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 89

def time_updated
  @time_updated
end

Class Method Details

.attribute_mapObject

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



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 100

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'recommendation': :'recommendation',
    'detector': :'detector',
    'service_type': :'serviceType',
    'resource_type': :'resourceType',
    'managed_list_types': :'managedListTypes',
    'candidate_responder_rules': :'candidateResponderRules',
    'detector_details': :'detectorDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 122

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'recommendation': :'String',
    'detector': :'String',
    'service_type': :'String',
    'resource_type': :'String',
    'managed_list_types': :'Array<String>',
    'candidate_responder_rules': :'Array<OCI::CloudGuard::Models::CandidateResponderRule>',
    'detector_details': :'OCI::CloudGuard::Models::DetectorDetails',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String'
    # 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



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 291

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    recommendation == other.recommendation &&
    detector == other.detector &&
    service_type == other.service_type &&
    resource_type == other.resource_type &&
    managed_list_types == other.managed_list_types &&
    candidate_responder_rules == other.candidate_responder_rules &&
    detector_details == other.detector_details &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details
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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 334

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


314
315
316
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 314

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



323
324
325
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 323

def hash
  [id, display_name, description, recommendation, detector, service_type, resource_type, managed_list_types, candidate_responder_rules, detector_details, time_created, time_updated, lifecycle_state, lifecycle_details].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



367
368
369
370
371
372
373
374
375
376
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 367

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



361
362
363
# File 'lib/oci/cloud_guard/models/detector_rule_summary.rb', line 361

def to_s
  to_hash.to_s
end