Class: OCI::Events::Models::RuleSummary

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

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RuleSummary

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

  • :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

  • :time_created (DateTime) —

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



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
203
204
205
206
207
208
 
# File 'lib/oci/events/models/rule_summary.rb', line 153

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

Instance Attribute Details

#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) 


69
70
71
 
# File 'lib/oci/events/models/rule_summary.rb', line 69

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) 


64
65
66
 
# File 'lib/oci/events/models/rule_summary.rb', line 64

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


28
29
30
 
# File 'lib/oci/events/models/rule_summary.rb', line 28

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) 


22
23
24
 
# File 'lib/oci/events/models/rule_summary.rb', line 22

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


14
15
16
 
# File 'lib/oci/events/models/rule_summary.rb', line 14

def id
  @id
end

#is_enabled ⇒ BOOLEAN

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

Example: ‘true`

Returns:

  • (BOOLEAN) 


76
77
78
 
# File 'lib/oci/events/models/rule_summary.rb', line 76

def is_enabled
  @is_enabled
end

#lifecycle_state ⇒ String

This attribute is required.

Returns:

  • (String) 


32
33
34
 
# File 'lib/oci/events/models/rule_summary.rb', line 32

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) 


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

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/events/models/rule_summary.rb', line 102

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

.swagger_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/events/models/rule_summary.rb', line 120

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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/oci/events/models/rule_summary.rb', line 217

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

  self.class == other.class &&
    id == other.id &&
    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 &&
    time_created == other.time_created &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/oci/events/models/rule_summary.rb', line 256

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


236
237
238
 
# File 'lib/oci/events/models/rule_summary.rb', line 236

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



245
246
247
 
# File 'lib/oci/events/models/rule_summary.rb', line 245

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



289
290
291
292
293
294
295
296
297
298
 
# File 'lib/oci/events/models/rule_summary.rb', line 289

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



283
284
285
 
# File 'lib/oci/events/models/rule_summary.rb', line 283

def to_s
  to_hash.to_s
end