Class: OCI::CloudGuard::Models::TargetDetectorRecipeSummary

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

Overview

Summary information for a target 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_IAAS_THREAT_DETECTOR = 'IAAS_THREAT_DETECTOR'.freeze,
  DETECTOR_IAAS_LOG_INSIGHT_DETECTOR = 'IAAS_LOG_INSIGHT_DETECTOR'.freeze,
  DETECTOR_IAAS_INSTANCE_SECURITY_DETECTOR = 'IAAS_INSTANCE_SECURITY_DETECTOR'.freeze,
  DETECTOR_IAAS_CONTAINER_SECURITY_DETECTOR = 'IAAS_CONTAINER_SECURITY_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
DETECTOR_RECIPE_TYPE_ENUM = 
[
  DETECTOR_RECIPE_TYPE_LIMITED = 'LIMITED'.freeze,
  DETECTOR_RECIPE_TYPE_BASIC = 'BASIC'.freeze,
  DETECTOR_RECIPE_TYPE_STANDARD = 'STANDARD'.freeze,
  DETECTOR_RECIPE_TYPE_ENTERPRISE = 'ENTERPRISE'.freeze,
  DETECTOR_RECIPE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TargetDetectorRecipeSummary

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

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :owner (String) —

    The value to assign to the #owner property

  • :detector_recipe_id (String) —

    The value to assign to the #detector_recipe_id property

  • :detector (String) —

    The value to assign to the #detector property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state 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_details (String) —

    The value to assign to the #lifecycle_details property

  • :locks (Array<OCI::CloudGuard::Models::ResourceLock>) —

    The value to assign to the #locks property

  • :detector_recipe_type (String) —

    The value to assign to the #detector_recipe_type property

  • :source_data_retention (Integer) —

    The value to assign to the #source_data_retention property



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/target_detector_recipe_summary.rb', line 167

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

  self.detector_recipe_id = attributes[:'detectorRecipeId'] if attributes[:'detectorRecipeId']

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

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

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

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

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

  self.detector_recipe_type = attributes[:'detectorRecipeType'] if attributes[:'detectorRecipeType']

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

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

  self.source_data_retention = attributes[:'sourceDataRetention'] if attributes[:'sourceDataRetention']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] Compartment OCID

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_summary.rb', line 53

def compartment_id
  @compartment_id
end

#description ⇒ String

[Required] Detector recipe's description

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_summary.rb', line 61

def description
  @description
end

#detector ⇒ String

Type of detector

Returns:

  • (String) 


73
74
75
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_summary.rb', line 73

def detector
  @detector
end

#detector_recipe_id ⇒ String

[Required] Unique identifier for detector recipe of which this is an extension

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_summary.rb', line 69

def detector_recipe_id
  @detector_recipe_id
end

#detector_recipe_type ⇒ String

Recipe type ( STANDARD, ENTERPRISE )

Returns:

  • (String) 


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

def detector_recipe_type
  @detector_recipe_type
end

#display_name ⇒ String

[Required] Detector recipe's display name

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_summary.rb', line 57

def display_name
  @display_name
end

#id ⇒ String

[Required] Unique identifier that can't be changed after creation

Returns:

  • (String) 


49
50
51
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_summary.rb', line 49

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) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current lifecycle state of the resource

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_summary.rb', line 77

def lifecycle_state
  @lifecycle_state
end

#locks ⇒ Array<OCI::CloudGuard::Models::ResourceLock>

Locks associated with this resource.

Returns:



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

def locks
  @locks
end

#owner ⇒ String

[Required] Detector recipe's owner

Returns:

  • (String) 


65
66
67
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_summary.rb', line 65

def owner
  @owner
end

#source_data_retention ⇒ Integer

The number of days for which source data is retained

Returns:

  • (Integer) 


101
102
103
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_summary.rb', line 101

def source_data_retention
  @source_data_retention
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_summary.rb', line 104

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'owner': :'owner',
    'detector_recipe_id': :'detectorRecipeId',
    'detector': :'detector',
    'lifecycle_state': :'lifecycleState',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_details': :'lifecycleDetails',
    'locks': :'locks',
    'detector_recipe_type': :'detectorRecipeType',
    'source_data_retention': :'sourceDataRetention'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_summary.rb', line 126

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'owner': :'String',
    'detector_recipe_id': :'String',
    'detector': :'String',
    'lifecycle_state': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_details': :'String',
    'locks': :'Array<OCI::CloudGuard::Models::ResourceLock>',
    'detector_recipe_type': :'String',
    'source_data_retention': :'Integer'
    # 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



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_summary.rb', line 297

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

  self.class == other.class &&
    id == other.id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    owner == other.owner &&
    detector_recipe_id == other.detector_recipe_id &&
    detector == other.detector &&
    lifecycle_state == other.lifecycle_state &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_details == other.lifecycle_details &&
    locks == other.locks &&
    detector_recipe_type == other.detector_recipe_type &&
    source_data_retention == other.source_data_retention
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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_summary.rb', line 340

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


320
321
322
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_summary.rb', line 320

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



329
330
331
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_summary.rb', line 329

def hash
  [id, compartment_id, display_name, description, owner, detector_recipe_id, detector, lifecycle_state, time_created, time_updated, lifecycle_details, locks, detector_recipe_type, source_data_retention].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



373
374
375
376
377
378
379
380
381
382
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_summary.rb', line 373

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



367
368
369
 
# File 'lib/oci/cloud_guard/models/target_detector_recipe_summary.rb', line 367

def to_s
  to_hash.to_s
end