Class: OCI::CloudGuard::Models::TargetResponderRecipe

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

Overview

A TargetResponderRecipe resource contains a specific instance of one of the supported detector types (for example, activity, configuration, or threat) in which some settings can be modified specifically for a single target.

A TargetResponderRecipe resource: * Is effectively a copy of a ResponderRecipe resource in which users can make very limited changes if itu2019s Oracle-managed, and more changes if itu2019s user-managed. * Is visible on the Cloud Guard Targets, Target Details page. * Is located in a specific OCI compartment. * Can be modified by users, programmatically or through the UI. * Changes that can be made here override any settings in the corresponding ResponderRecipe, of which the TargetResponderRecipe resource is effectively a copy of the ResponderRecipe resource (effectively created when the detector recipe is attached to the target).

Constant Summary collapse

OWNER_ENUM = 
[
  OWNER_CUSTOMER = 'CUSTOMER'.freeze,
  OWNER_ORACLE = 'ORACLE'.freeze,
  OWNER_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TargetResponderRecipe

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
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
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe.rb', line 131

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

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

  self.responder_recipe_id = attributes[:'responder_recipe_id'] if attributes[:'responder_recipe_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.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.responder_rules = attributes[:'responderRules'] if attributes[:'responderRules']

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

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

  self.effective_responder_rules = attributes[:'effectiveResponderRules'] if attributes[:'effectiveResponderRules']

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

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] Compartment OCID

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe.rb', line 42

def compartment_id
  @compartment_id
end

#description ⇒ String

[Required] Target responder description

Returns:

  • (String) 


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

def description
  @description
end

#display_name ⇒ String

[Required] Target responder recipe display name

Returns:

  • (String) 


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

def display_name
  @display_name
end

#effective_responder_rules ⇒ Array<OCI::CloudGuard::Models::TargetResponderRecipeResponderRule>

List of currently enabled responder rules for the responder type for recipe after applying defaults

Returns:



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

def effective_responder_rules
  @effective_responder_rules
end

#id ⇒ String

[Required] Unique identifier of target responder recipe that can't be changed after creation

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe.rb', line 34

def id
  @id
end

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

Locks associated with this resource.

Returns:



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

def locks
  @locks
end

#owner ⇒ String

[Required] Owner of target responder recipe

Returns:

  • (String) 


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

def owner
  @owner
end

#responder_recipe_id ⇒ String

[Required] Unique identifier for the Oracle-managed responder recipe from which this recipe was cloned

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe.rb', line 38

def responder_recipe_id
  @responder_recipe_id
end

#responder_rules ⇒ Array<OCI::CloudGuard::Models::TargetResponderRecipeResponderRule>

List of responder rules associated with the recipe - user input

Returns:



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

def responder_rules
  @responder_rules
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

Class Method Details

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe.rb', line 77

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'responder_recipe_id': :'responderRecipeId',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'description': :'description',
    'owner': :'owner',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'responder_rules': :'responderRules',
    'effective_responder_rules': :'effectiveResponderRules',
    'locks': :'locks'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'responder_recipe_id': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'description': :'String',
    'owner': :'String',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'responder_rules': :'Array<OCI::CloudGuard::Models::TargetResponderRecipeResponderRule>',
    'effective_responder_rules': :'Array<OCI::CloudGuard::Models::TargetResponderRecipeResponderRule>',
    'locks': :'Array<OCI::CloudGuard::Models::ResourceLock>'
    # 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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe.rb', line 208

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

  self.class == other.class &&
    id == other.id &&
    responder_recipe_id == other.responder_recipe_id &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    description == other.description &&
    owner == other.owner &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    responder_rules == other.responder_rules &&
    effective_responder_rules == other.effective_responder_rules &&
    locks == other.locks
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



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe.rb', line 248

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


228
229
230
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe.rb', line 228

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



237
238
239
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe.rb', line 237

def hash
  [id, responder_recipe_id, compartment_id, display_name, description, owner, time_created, time_updated, responder_rules, effective_responder_rules, locks].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



281
282
283
284
285
286
287
288
289
290
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe.rb', line 281

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



275
276
277
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe.rb', line 275

def to_s
  to_hash.to_s
end