Class: OCI::Events::Models::Rule

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/events/models/rule.rb

Overview

The configuration details of an Events rule. For more information, see [Managing Rules for Events](docs.cloud.oracle.com/iaas/Content/Events/Task/managingrulesactions.htm)

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.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 = {}) ⇒ Rule

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :description (String) —

    The value to assign to the #description property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :condition (String) —

    The value to assign to the #condition property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :is_enabled (BOOLEAN) —

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

  • :actions (OCI::Events::Models::ActionList) —

    The value to assign to the #actions property

  • :id (String) —

    The value to assign to the #id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :lifecycle_message (String) —

    The value to assign to the #lifecycle_message property



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
237
238
239
240
241
242
243
244
 
# File 'lib/oci/events/models/rule.rb', line 181

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

  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.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil?
  self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil?
  self.is_enabled = true if is_enabled.nil? && !attributes.key?(:'isEnabled') && !attributes.key?(:'is_enabled') # rubocop:disable Style/StringLiterals

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

  self.id = attributes[:'id'] if attributes[:'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.lifecycle_message = attributes[:'lifecycleMessage'] if attributes[:'lifecycleMessage']

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

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

Instance Attribute Details

#actions ⇒ OCI::Events::Models::ActionList

This attribute is required.

Returns:



103
104
105
 
# File 'lib/oci/events/models/rule.rb', line 103

def actions
  @actions
end

#compartment_id ⇒ String

[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs.

Returns:

  • (String) 


77
78
79
 
# File 'lib/oci/events/models/rule.rb', line 77

def compartment_id
  @compartment_id
end

#condition ⇒ String

[Required] A filter that specifies the event that will trigger actions associated with this rule. A few important things to remember about filters:

  • Fields not mentioned in the condition are ignored. You can create a valid filter that matches

all events with two curly brackets: ‘{}`

For more examples, see

[Matching Events with Filters](docs.cloud.oracle.com/iaas/Content/Events/Concepts/filterevents.htm).

  • For a condition with fileds to match an event, the event must contain all the field names

listed in the condition. Field names must appear in the condition with the same nesting structure used in the event.

For a list of reference events, see

[Services that Produce Events](docs.cloud.oracle.com/iaas/Content/Events/Reference/eventsproducers.htm).

  • Rules apply to events in the compartment in which you create them and any child compartments.

This means that a condition specified by a rule only matches events emitted from resources in the compartment or any of its child compartments.

  • The condition is a string value in a JSON object, but numbers in conditions are converted

from strings to numbers before they are evaluated for matches. This means that 100, 100.0 or 1.0e2 are all considered equal.

  • Boolean values are converted to numbers and then evaluated. This means true and True are

considered equal, as are False and false.

  • Wildcard matching is supported with the asterisk (*) character.

    For examples of wildcard matching, see

[Matching Events with Filters](docs.cloud.oracle.com/iaas/Content/Events/Concepts/filterevents.htm)

Example: ‘\"eventType\": \"com.oraclecloud.databaseservice.autonomous.database.backup.end\"`

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/events/models/rule.rb', line 72

def condition
  @condition
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

Example: ‘{"CostCenter": "42"}`

Returns:

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


99
100
101
 
# File 'lib/oci/events/models/rule.rb', line 99

def defined_tags
  @defined_tags
end

#description ⇒ String

A string that describes the details of the rule. It does not have to be unique, and you can change it. Avoid entering confidential information.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/events/models/rule.rb', line 35

def description
  @description
end

#display_name ⇒ String

[Required] A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information.

Example: ‘"This rule sends a notification upon completion of DbaaS backup."`

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/events/models/rule.rb', line 29

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see [Resource Tags](docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


92
93
94
 
# File 'lib/oci/events/models/rule.rb', line 92

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of this rule.

Returns:

  • (String) 


108
109
110
 
# File 'lib/oci/events/models/rule.rb', line 108

def id
  @id
end

#is_enabled ⇒ BOOLEAN

[Required] Whether or not this rule is currently enabled.

Example: ‘true`

Returns:

  • (BOOLEAN) 


84
85
86
 
# File 'lib/oci/events/models/rule.rb', line 84

def is_enabled
  @is_enabled
end

#lifecycle_message ⇒ String

A message generated by the Events service about the current state of this rule.

Returns:

  • (String) 


121
122
123
 
# File 'lib/oci/events/models/rule.rb', line 121

def lifecycle_message
  @lifecycle_message
end

#lifecycle_state ⇒ String

[Required] The current state of the rule.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/events/models/rule.rb', line 40

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

[Required] The time this rule was created, expressed in [RFC 3339](tools.ietf.org/html/rfc3339) timestamp format.

Example: ‘2018-09-12T22:47:12.613Z`

Returns:

  • (DateTime) 


116
117
118
 
# File 'lib/oci/events/models/rule.rb', line 116

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/events/models/rule.rb', line 124

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'description': :'description',
    'lifecycle_state': :'lifecycleState',
    'condition': :'condition',
    'compartment_id': :'compartmentId',
    'is_enabled': :'isEnabled',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'actions': :'actions',
    'id': :'id',
    'time_created': :'timeCreated',
    'lifecycle_message': :'lifecycleMessage'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/events/models/rule.rb', line 144

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'description': :'String',
    'lifecycle_state': :'String',
    'condition': :'String',
    'compartment_id': :'String',
    'is_enabled': :'BOOLEAN',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'actions': :'OCI::Events::Models::ActionList',
    'id': :'String',
    'time_created': :'DateTime',
    'lifecycle_message': :'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



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/oci/events/models/rule.rb', line 266

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

  self.class == other.class &&
    display_name == other.display_name &&
    description == other.description &&
    lifecycle_state == other.lifecycle_state &&
    condition == other.condition &&
    compartment_id == other.compartment_id &&
    is_enabled == other.is_enabled &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    actions == other.actions &&
    id == other.id &&
    time_created == other.time_created &&
    lifecycle_message == other.lifecycle_message
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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/oci/events/models/rule.rb', line 307

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


287
288
289
 
# File 'lib/oci/events/models/rule.rb', line 287

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



296
297
298
 
# File 'lib/oci/events/models/rule.rb', line 296

def hash
  [display_name, description, lifecycle_state, condition, compartment_id, is_enabled, freeform_tags, defined_tags, actions, id, time_created, lifecycle_message].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



340
341
342
343
344
345
346
347
348
349
 
# File 'lib/oci/events/models/rule.rb', line 340

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



334
335
336
 
# File 'lib/oci/events/models/rule.rb', line 334

def to_s
  to_hash.to_s
end