Class: OCI::Events::Models::Action
- Inherits:
-
Object
- Object
- OCI::Events::Models::Action
- Defined in:
- lib/oci/events/models/action.rb
Overview
An object that represents an action to trigger for events that match a rule.
This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
Direct Known Subclasses
FaaSAction, NotificationServiceAction, StreamingServiceAction
Constant Summary collapse
- ACTION_TYPE_ENUM =
[ ACTION_TYPE_ONS = 'ONS'.freeze, ACTION_TYPE_OSS = 'OSS'.freeze, ACTION_TYPE_FAAS = 'FAAS'.freeze, ACTION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- 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
-
#action_type ⇒ String
[Required] The action to perform if the condition in the rule matches an event.
-
#description ⇒ String
A string that describes the details of the action.
-
#id ⇒ String
[Required] The OCID of the action.
-
#is_enabled ⇒ BOOLEAN
Whether or not this action is currently enabled.
-
#lifecycle_message ⇒ String
[Required] A message generated by the Events service about the current state of this action.
-
#lifecycle_state ⇒ String
[Required] The current state of the rule.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Action
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ Action
Initializes the object
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'lib/oci/events/models/action.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.action_type = attributes[:'actionType'] if attributes[:'actionType'] raise 'You cannot provide both :actionType and :action_type' if attributes.key?(:'actionType') && attributes.key?(:'action_type') self.action_type = attributes[:'action_type'] if attributes[:'action_type'] self.id = attributes[:'id'] if attributes[:'id'] self. = attributes[:'lifecycleMessage'] if attributes[:'lifecycleMessage'] raise 'You cannot provide both :lifecycleMessage and :lifecycle_message' if attributes.key?(:'lifecycleMessage') && attributes.key?(:'lifecycle_message') self. = attributes[:'lifecycle_message'] if attributes[:'lifecycle_message'] 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.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.description = attributes[:'description'] if attributes[:'description'] end |
Instance Attribute Details
#action_type ⇒ String
[Required] The action to perform if the condition in the rule matches an event.
-
ONS: Send to an Oracle Notification Service topic.
-
OSS: Send to a stream from Oracle Streaming Service.
-
FAAS: Send to an Oracle Functions Service endpoint.
39 40 41 |
# File 'lib/oci/events/models/action.rb', line 39 def action_type @action_type end |
#description ⇒ String
A string that describes the details of the action. It does not have to be unique, and you can change it. Avoid entering confidential information.
67 68 69 |
# File 'lib/oci/events/models/action.rb', line 67 def description @description end |
#id ⇒ String
[Required] The OCID of the action.
44 45 46 |
# File 'lib/oci/events/models/action.rb', line 44 def id @id end |
#is_enabled ⇒ BOOLEAN
Whether or not this action is currently enabled.
Example: true
61 62 63 |
# File 'lib/oci/events/models/action.rb', line 61 def is_enabled @is_enabled end |
#lifecycle_message ⇒ String
[Required] A message generated by the Events service about the current state of this action.
49 50 51 |
# File 'lib/oci/events/models/action.rb', line 49 def @lifecycle_message end |
#lifecycle_state ⇒ String
[Required] The current state of the rule.
54 55 56 |
# File 'lib/oci/events/models/action.rb', line 54 def lifecycle_state @lifecycle_state end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
70 71 72 73 74 75 76 77 78 79 80 81 |
# File 'lib/oci/events/models/action.rb', line 70 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'action_type': :'actionType', 'id': :'id', 'lifecycle_message': :'lifecycleMessage', 'lifecycle_state': :'lifecycleState', 'is_enabled': :'isEnabled', 'description': :'description' # rubocop:enable Style/SymbolLiteral } end |
.get_subtype(object_hash) ⇒ Object
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
102 103 104 105 106 107 108 109 110 111 |
# File 'lib/oci/events/models/action.rb', line 102 def self.get_subtype(object_hash) type = object_hash[:'actionType'] # rubocop:disable Style/SymbolLiteral return 'OCI::Events::Models::StreamingServiceAction' if type == 'OSS' return 'OCI::Events::Models::NotificationServiceAction' if type == 'ONS' return 'OCI::Events::Models::FaaSAction' if type == 'FAAS' # TODO: Log a warning when the subtype is not found. 'OCI::Events::Models::Action' end |
.swagger_types ⇒ Object
Attribute type mapping.
84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/oci/events/models/action.rb', line 84 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'action_type': :'String', 'id': :'String', 'lifecycle_message': :'String', 'lifecycle_state': :'String', 'is_enabled': :'BOOLEAN', 'description': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
196 197 198 199 200 201 202 203 204 205 206 |
# File 'lib/oci/events/models/action.rb', line 196 def ==(other) return true if equal?(other) self.class == other.class && action_type == other.action_type && id == other.id && == other. && lifecycle_state == other.lifecycle_state && is_enabled == other.is_enabled && description == other.description end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 |
# File 'lib/oci/events/models/action.rb', line 231 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
211 212 213 |
# File 'lib/oci/events/models/action.rb', line 211 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
220 221 222 |
# File 'lib/oci/events/models/action.rb', line 220 def hash [action_type, id, , lifecycle_state, is_enabled, description].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
264 265 266 267 268 269 270 271 272 273 |
# File 'lib/oci/events/models/action.rb', line 264 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
258 259 260 |
# File 'lib/oci/events/models/action.rb', line 258 def to_s to_hash.to_s end |