Class: OCI::CloudGuard::Models::DetectorRecipeSummary

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

Overview

Summary of Detector recipe

Constant Summary collapse

OWNER_ENUM =
[
  OWNER_CUSTOMER = 'CUSTOMER'.freeze,
  OWNER_ORACLE = 'ORACLE'.freeze,
  OWNER_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
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
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 = {}) ⇒ DetectorRecipeSummary

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

  • :compartment_id (String)

    The value to assign to the #compartment_id property

  • :source_detector_recipe_id (String)

    The value to assign to the #source_detector_recipe_id property

  • :owner (String)

    The value to assign to the #owner property

  • :detector (String)

    The value to assign to the #detector property

  • :detector_rules (Array<OCI::CloudGuard::Models::DetectorRecipeDetectorRule>)

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

  • :system_tags (Hash<String, Hash<String, Object>>)

    The value to assign to the #system_tags property



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

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

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

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

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

  self.detector_rules = attributes[:'detectorRules'] if attributes[:'detectorRules']

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

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

  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']

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#compartment_idString

[Required] compartmentId of detector recipe

Returns:

  • (String)


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

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. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>)


88
89
90
# File 'lib/oci/cloud_guard/models/detector_recipe_summary.rb', line 88

def defined_tags
  @defined_tags
end

#descriptionString

Detector recipe description

Returns:

  • (String)


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

def description
  @description
end

#detectorString

[Required] Type of detector

Returns:

  • (String)


60
61
62
# File 'lib/oci/cloud_guard/models/detector_recipe_summary.rb', line 60

def detector
  @detector
end

#detector_rulesArray<OCI::CloudGuard::Models::DetectorRecipeDetectorRule>

List of detetor rules for the detector type



64
65
66
# File 'lib/oci/cloud_guard/models/detector_recipe_summary.rb', line 64

def detector_rules
  @detector_rules
end

#display_nameString

[Required] DisplayName of detector recipe

Returns:

  • (String)


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

def display_name
  @display_name
end

#freeform_tagsHash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>)


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

def freeform_tags
  @freeform_tags
end

#idString

[Required] Ocid for detector recipe

Returns:

  • (String)


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

def id
  @id
end

#lifecycle_stateString

The current state of the resource.

Returns:

  • (String)


76
77
78
# File 'lib/oci/cloud_guard/models/detector_recipe_summary.rb', line 76

def lifecycle_state
  @lifecycle_state
end

#ownerString

[Required] Owner of detector recipe

Returns:

  • (String)


56
57
58
# File 'lib/oci/cloud_guard/models/detector_recipe_summary.rb', line 56

def owner
  @owner
end

#source_detector_recipe_idString

Recipe Ocid of the Source Recipe to be cloned

Returns:

  • (String)


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

def source_detector_recipe_id
  @source_detector_recipe_id
end

#system_tagsHash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>)


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

def system_tags
  @system_tags
end

#time_createdDateTime

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

Returns:

  • (DateTime)


68
69
70
# File 'lib/oci/cloud_guard/models/detector_recipe_summary.rb', line 68

def time_created
  @time_created
end

#time_updatedDateTime

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

Returns:

  • (DateTime)


72
73
74
# File 'lib/oci/cloud_guard/models/detector_recipe_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.



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_recipe_summary.rb', line 100

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'source_detector_recipe_id': :'sourceDetectorRecipeId',
    'owner': :'owner',
    'detector': :'detector',
    'detector_rules': :'detectorRules',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # 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_recipe_summary.rb', line 122

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'compartment_id': :'String',
    'source_detector_recipe_id': :'String',
    'owner': :'String',
    'detector': :'String',
    'detector_rules': :'Array<OCI::CloudGuard::Models::DetectorRecipeDetectorRule>',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
# File 'lib/oci/cloud_guard/models/detector_recipe_summary.rb', line 284

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    source_detector_recipe_id == other.source_detector_recipe_id &&
    owner == other.owner &&
    detector == other.detector &&
    detector_rules == other.detector_rules &&
    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 &&
    system_tags == other.system_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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
# File 'lib/oci/cloud_guard/models/detector_recipe_summary.rb', line 327

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


307
308
309
# File 'lib/oci/cloud_guard/models/detector_recipe_summary.rb', line 307

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



316
317
318
# File 'lib/oci/cloud_guard/models/detector_recipe_summary.rb', line 316

def hash
  [id, display_name, description, compartment_id, source_detector_recipe_id, owner, detector, detector_rules, time_created, time_updated, lifecycle_state, freeform_tags, defined_tags, system_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



360
361
362
363
364
365
366
367
368
369
# File 'lib/oci/cloud_guard/models/detector_recipe_summary.rb', line 360

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



354
355
356
# File 'lib/oci/cloud_guard/models/detector_recipe_summary.rb', line 354

def to_s
  to_hash.to_s
end