Class: OCI::CloudGuard::Models::TargetDetectorRecipeDetectorRuleSummary

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

Overview

Summary of the Detector Recipe Rule.

Constant Summary collapse

DETECTOR_ENUM = 
[
  DETECTOR_IAAS_ACTIVITY_DETECTOR = 'IAAS_ACTIVITY_DETECTOR'.freeze,
  DETECTOR_IAAS_CONFIGURATION_DETECTOR = 'IAAS_CONFIGURATION_DETECTOR'.freeze,
  DETECTOR_IAAS_THREAT_DETECTOR = 'IAAS_THREAT_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 = {}) ⇒ TargetDetectorRecipeDetectorRuleSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
216
217
218
219
220
221
222
223
224
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 157

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

#description ⇒ String

DetectorTemplate Identifier, can be renamed

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 55

def description
  @description
end

#detector ⇒ String

**[Required]** possible type of detectors

Returns:

  • (String) 


63
64
65
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 63

def detector
  @detector
end

#detector_details ⇒ OCI::CloudGuard::Models::TargetDetectorDetails

Returns:



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

def detector_details
  @detector_details
end

#display_name ⇒ String

DetectorTemplate Identifier, can be renamed

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 51

def display_name
  @display_name
end

#id ⇒ String

**[Required]** The unique identifier of the detector rule

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 47

def id
  @id
end

#lifecycle_details ⇒ String

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) 


94
95
96
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 94

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current state of the target detector recipe rule

Returns:

  • (String) 


90
91
92
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 90

def lifecycle_state
  @lifecycle_state
end

#managed_list_types ⇒ Array<String>

List of cloudguard managed list types related to this rule

Returns:

  • (Array<String>) 


75
76
77
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 75

def managed_list_types
  @managed_list_types
end

#recommendation ⇒ String

Recommendation for TargetDetectorRecipeDetectorRule

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 59

def recommendation
  @recommendation
end

#resource_type ⇒ String

resource type of the configuration to which the rule is applied

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 71

def resource_type
  @resource_type
end

#service_type ⇒ String

service type of the configuration to which the rule is applied

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 67

def service_type
  @service_type
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


82
83
84
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 82

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


86
87
88
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 86

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 97

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',
    'detector_details': :'detectorDetails',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 118

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>',
    'detector_details': :'OCI::CloudGuard::Models::TargetDetectorDetails',
    '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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 279

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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 321

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


301
302
303
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 301

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



310
311
312
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 310

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



354
355
356
357
358
359
360
361
362
363
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 354

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



348
349
350
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_detector_rule_summary.rb', line 348

def to_s
  to_hash.to_s
end