Class: OCI::Events::Models::ActionDetails

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

Overview

Object used to create an action.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ActionDetails

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

  • :is_enabled (BOOLEAN) —

    The value to assign to the #is_enabled property

  • :description (String) —

    The value to assign to the #description property



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/events/models/action_details.rb', line 87

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

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/events/models/action_details.rb', line 24

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) 


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

def description
  @description
end

#is_enabled ⇒ BOOLEAN

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

Example: ‘true`

Returns:

  • (BOOLEAN) 


31
32
33
 
# File 'lib/oci/events/models/action_details.rb', line 31

def is_enabled
  @is_enabled
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/events/models/action_details.rb', line 40

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



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/oci/events/models/action_details.rb', line 66

def self.get_subtype(object_hash)
  type = object_hash[:'actionType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::Events::Models::CreateStreamingServiceActionDetails' if type == 'OSS'
  return 'OCI::Events::Models::CreateFaaSActionDetails' if type == 'FAAS'
  return 'OCI::Events::Models::CreateNotificationServiceActionDetails' if type == 'ONS'

  # TODO: Log a warning when the subtype is not found.
  'OCI::Events::Models::ActionDetails'
end

.swagger_types ⇒ Object

Attribute type mapping.



51
52
53
54
55
56
57
58
59
 
# File 'lib/oci/events/models/action_details.rb', line 51

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



125
126
127
128
129
130
131
132
 
# File 'lib/oci/events/models/action_details.rb', line 125

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

  self.class == other.class &&
    action_type == other.action_type &&
    is_enabled == other.is_enabled &&
    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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/events/models/action_details.rb', line 157

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


137
138
139
 
# File 'lib/oci/events/models/action_details.rb', line 137

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



146
147
148
 
# File 'lib/oci/events/models/action_details.rb', line 146

def hash
  [action_type, is_enabled, description].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



190
191
192
193
194
195
196
197
198
199
 
# File 'lib/oci/events/models/action_details.rb', line 190

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



184
185
186
 
# File 'lib/oci/events/models/action_details.rb', line 184

def to_s
  to_hash.to_s
end