class OCI::Events::Models::CreateRuleDetails
Object
used to create a rule.
Attributes
This attribute is required. @return [OCI::Events::Models::ActionDetailsList]
[Required] The [OCID](docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment to which this rule belongs.
@return [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 fields 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.
-
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\"`
@return [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.
@return [String]
[Required] A string that describes the rule. It does not have to be unique, and you can change it. Avoid entering confidential information.
@return [String]
[Required] Whether or not this rule is currently enabled.
Example: `true`
@return [BOOLEAN]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/events/models/create_rule_details.rb, line 81 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'display_name': :'displayName', 'description': :'description', 'is_enabled': :'isEnabled', 'condition': :'condition', 'compartment_id': :'compartmentId', 'actions': :'actions', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [String] :description The value to assign to the {#description} property @option attributes [BOOLEAN] :is_enabled The value to assign to the {#is_enabled} property @option attributes [String] :condition The value to assign to the {#condition} property @option attributes [String] :compartment_id The value to assign to the {#compartment_id} property @option attributes [OCI::Events::Models::ActionDetailsList] :actions The value to assign to the {#actions} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property
# File lib/oci/events/models/create_rule_details.rb, line 126 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.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.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.actions = attributes[:'actions'] if attributes[:'actions'] 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
Attribute type mapping.
# File lib/oci/events/models/create_rule_details.rb, line 97 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'display_name': :'String', 'description': :'String', 'is_enabled': :'BOOLEAN', 'condition': :'String', 'compartment_id': :'String', 'actions': :'OCI::Events::Models::ActionDetailsList', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/events/models/create_rule_details.rb, line 178 def ==(other) return true if equal?(other) self.class == other.class && display_name == other.display_name && description == other.description && is_enabled == other.is_enabled && condition == other.condition && compartment_id == other.compartment_id && actions == other.actions && freeform_tags == other.freeform_tags && defined_tags == other.defined_tags end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/events/models/create_rule_details.rb, line 215 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/events/models/create_rule_details.rb, line 195 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/events/models/create_rule_details.rb, line 204 def hash [display_name, description, is_enabled, condition, compartment_id, actions, freeform_tags, defined_tags].hash end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/events/models/create_rule_details.rb, line 248 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/events/models/create_rule_details.rb, line 242 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/events/models/create_rule_details.rb, line 265 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end