Class: OCI::CloudGuard::Models::TargetResponderRecipeResponderRuleSummary

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

Overview

Summary information for a target responder recipe responder rule.

Constant Summary collapse

TYPE_ENUM = 
[
  TYPE_REMEDIATION = 'REMEDIATION'.freeze,
  TYPE_NOTIFICATION = 'NOTIFICATION'.freeze,
  TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SUPPORTED_MODES_ENUM = 
[
  SUPPORTED_MODES_AUTOACTION = 'AUTOACTION'.freeze,
  SUPPORTED_MODES_USERACTION = 'USERACTION'.freeze,
  SUPPORTED_MODES_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 = {}) ⇒ TargetResponderRecipeResponderRuleSummary

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

  • :type (String) —

    The value to assign to the #type property

  • :policies (Array<String>) —

    The value to assign to the #policies property

  • :supported_modes (Array<String>) —

    The value to assign to the #supported_modes property

  • :details (OCI::CloudGuard::Models::ResponderRuleDetails) —

    The value to assign to the #details property

  • :compartment_id (String) —

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

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property



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
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe_responder_rule_summary.rb', line 140

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

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

  self.supported_modes = attributes[:'supportedModes'] if attributes[:'supportedModes']

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

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

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

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

#compartment_id ⇒ String

[Required] Compartment OCID

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

#description ⇒ String

Responder rule description

Returns:

  • (String) 


45
46
47
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe_responder_rule_summary.rb', line 45

def description
  @description
end

#details ⇒ OCI::CloudGuard::Models::ResponderRuleDetails

Returns:



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

def details
  @details
end

#display_name ⇒ String

Responder rule display name

Returns:

  • (String) 


41
42
43
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe_responder_rule_summary.rb', line 41

def display_name
  @display_name
end

#id ⇒ String

[Required] Unique identifier for the responder rule

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe_responder_rule_summary.rb', line 37

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) 


80
81
82
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe_responder_rule_summary.rb', line 80

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current lifecycle state of the responder rule

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

#policies ⇒ Array<String>

List of policies

Returns:

  • (Array<String>) 


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

def policies
  @policies
end

#supported_modes ⇒ Array<String>

Supported execution modes for the responder rule

Returns:

  • (Array<String>) 


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

def supported_modes
  @supported_modes
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

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) 


72
73
74
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe_responder_rule_summary.rb', line 72

def time_updated
  @time_updated
end

#type ⇒ String

Type of responder

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe_responder_rule_summary.rb', line 83

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'description': :'description',
    'type': :'type',
    'policies': :'policies',
    'supported_modes': :'supportedModes',
    'details': :'details',
    'compartment_id': :'compartmentId',
    'time_created': :'timeCreated',
    'time_updated': :'timeUpdated',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'description': :'String',
    'type': :'String',
    'policies': :'Array<String>',
    'supported_modes': :'Array<String>',
    'details': :'OCI::CloudGuard::Models::ResponderRuleDetails',
    'compartment_id': :'String',
    '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



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe_responder_rule_summary.rb', line 252

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    description == other.description &&
    type == other.type &&
    policies == other.policies &&
    supported_modes == other.supported_modes &&
    details == other.details &&
    compartment_id == other.compartment_id &&
    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



293
294
295
296
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_responder_recipe_responder_rule_summary.rb', line 293

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


273
274
275
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe_responder_rule_summary.rb', line 273

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



282
283
284
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe_responder_rule_summary.rb', line 282

def hash
  [id, display_name, description, type, policies, supported_modes, details, compartment_id, 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



326
327
328
329
330
331
332
333
334
335
 
# File 'lib/oci/cloud_guard/models/target_responder_recipe_responder_rule_summary.rb', line 326

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



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

def to_s
  to_hash.to_s
end