Class: OCI::CloudGuard::Models::ResponderRule

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

Overview

A ResponderRule resource contains the default settings for a single responder rule that Cloud Guard provides.

A ResponderRule resource: * Is used as the original source for a rule in an Oracle-managed responder of the specified type. * Is not directly visible in the Cloud Guard UI. * Canu2019t be modified by users, programmatically or through the UI. * May be modified from time to time by Cloud Guard.

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 = {}) ⇒ ResponderRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
198
199
200
201
202
 
# File 'lib/oci/cloud_guard/models/responder_rule.rb', line 149

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

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

Instance Attribute Details

#description ⇒ String

[Required] Responder rule description

Returns:

  • (String) 


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

def description
  @description
end

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

Returns:



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

def details
  @details
end

#display_name ⇒ String

[Required] Responder rule display name

Returns:

  • (String) 


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

def display_name
  @display_name
end

#id ⇒ String

[Required] Unique identifier for the responder rule

Returns:

  • (String) 


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

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) 


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

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

The current lifecycle state of the responder rule.

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
end

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

Locks associated with this resource.

Returns:



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

def locks
  @locks
end

#policies ⇒ Array<String>

List of policies

Returns:

  • (Array<String>) 


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

def policies
  @policies
end

#supported_modes ⇒ Array<String>

Supported execution modes for the responder rule

Returns:

  • (Array<String>) 


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

def supported_modes
  @supported_modes
end

#time_created ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#time_updated ⇒ DateTime

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

Returns:

  • (DateTime) 


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

def time_updated
  @time_updated
end

#type ⇒ String

[Required] Type of responder

Returns:

  • (String) 


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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/oci/cloud_guard/models/responder_rule.rb', line 92

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

.swagger_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oci/cloud_guard/models/responder_rule.rb', line 112

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',
    'time_created': :'DateTime',
    'time_updated': :'DateTime',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    '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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/oci/cloud_guard/models/responder_rule.rb', line 257

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 &&
    time_created == other.time_created &&
    time_updated == other.time_updated &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/oci/cloud_guard/models/responder_rule.rb', line 298

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


278
279
280
 
# File 'lib/oci/cloud_guard/models/responder_rule.rb', line 278

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



287
288
289
 
# File 'lib/oci/cloud_guard/models/responder_rule.rb', line 287

def hash
  [id, display_name, description, type, policies, supported_modes, details, time_created, time_updated, lifecycle_state, lifecycle_details, locks].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



331
332
333
334
335
336
337
338
339
340
 
# File 'lib/oci/cloud_guard/models/responder_rule.rb', line 331

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



325
326
327
 
# File 'lib/oci/cloud_guard/models/responder_rule.rb', line 325

def to_s
  to_hash.to_s
end