Class: OCI::Events::Models::Action

Inherits:
Object
  • Object
show all
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

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Action

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :action_type (String) —

    The value to assign to the #action_type property

  • :id (String) —

    The value to assign to the #id property

  • :lifecycle_message (String) —

    The value to assign to the #lifecycle_message property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :description (String) —

    The value to assign to the #description property



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/oci/events/models/action.rb', line 114

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

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

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/events/models/action.rb', line 37

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.

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/events/models/action.rb', line 58

def description
  @description
end

#id ⇒ String

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

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/events/models/action.rb', line 42

def id
  @id
end

#lifecycle_message ⇒ String

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

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/events/models/action.rb', line 47

def lifecycle_message
  @lifecycle_message
end

#lifecycle_state ⇒ String

[Required] The current state of the rule.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/events/models/action.rb', line 52

def lifecycle_state
  @lifecycle_state
end

Class Method Details

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/events/models/action.rb', line 61

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'action_type': :'actionType',
    'id': :'id',
    'lifecycle_message': :'lifecycleMessage',
    'lifecycle_state': :'lifecycleState',
    '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.



91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/events/models/action.rb', line 91

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.



74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/oci/events/models/action.rb', line 74

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'action_type': :'String',
    'id': :'String',
    'lifecycle_message': :'String',
    'lifecycle_state': :'String',
    'description': :'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



176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/events/models/action.rb', line 176

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

  self.class == other.class &&
    action_type == other.action_type &&
    id == other.id &&
    lifecycle_message == other.lifecycle_message &&
    lifecycle_state == other.lifecycle_state &&
    description == other.description
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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/oci/events/models/action.rb', line 210

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


190
191
192
 
# File 'lib/oci/events/models/action.rb', line 190

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



199
200
201
 
# File 'lib/oci/events/models/action.rb', line 199

def hash
  [action_type, id, lifecycle_message, lifecycle_state, description].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



243
244
245
246
247
248
249
250
251
252
 
# File 'lib/oci/events/models/action.rb', line 243

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



237
238
239
 
# File 'lib/oci/events/models/action.rb', line 237

def to_s
  to_hash.to_s
end