Class: OCI::FusionApps::Models::Action

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fusion_apps/models/action.rb

Overview

Action details 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

PatchAction, UpgradeAction, VertexAction

Constant Summary collapse

ACTION_TYPE_ENUM = 
[
  ACTION_TYPE_QUARTERLY_UPGRADE = 'QUARTERLY_UPGRADE'.freeze,
  ACTION_TYPE_PATCH = 'PATCH'.freeze,
  ACTION_TYPE_VERTEX = 'VERTEX'.freeze,
  ACTION_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
STATE_ENUM = 
[
  STATE_ACCEPTED = 'ACCEPTED'.freeze,
  STATE_IN_PROGRESS = 'IN_PROGRESS'.freeze,
  STATE_SUCCEEDED = 'SUCCEEDED'.freeze,
  STATE_FAILED = 'FAILED'.freeze,
  STATE_CANCELED = 'CANCELED'.freeze,
  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):

  • :reference_key (String) —

    The value to assign to the #reference_key property

  • :action_type (String) —

    The value to assign to the #action_type property

  • :state (String) —

    The value to assign to the #state property

  • :description (String) —

    The value to assign to the #description property



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/fusion_apps/models/action.rb', line 96

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.reference_key = attributes[:'referenceKey'] if attributes[:'referenceKey']

  raise 'You cannot provide both :referenceKey and :reference_key' if attributes.key?(:'referenceKey') && attributes.key?(:'reference_key')

  self.reference_key = attributes[:'reference_key'] if attributes[:'reference_key']

  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.state = attributes[:'state'] if attributes[:'state']

  self.description = attributes[:'description'] if attributes[:'description']
end

Instance Attribute Details

#action_type ⇒ String

[Required] Type of action

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/fusion_apps/models/action.rb', line 35

def action_type
  @action_type
end

#description ⇒ String

[Required] 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) 


43
44
45
 
# File 'lib/oci/fusion_apps/models/action.rb', line 43

def description
  @description
end

#reference_key ⇒ String

Unique identifier of the object that represents the action

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/fusion_apps/models/action.rb', line 31

def reference_key
  @reference_key
end

#state ⇒ String

A string that describes whether the change is applied hot or cold

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/fusion_apps/models/action.rb', line 39

def state
  @state
end

Class Method Details

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/fusion_apps/models/action.rb', line 46

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



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

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

  return 'OCI::FusionApps::Models::PatchAction' if type == 'PATCH'
  return 'OCI::FusionApps::Models::UpgradeAction' if type == 'QUARTERLY_UPGRADE'
  return 'OCI::FusionApps::Models::VertexAction' if type == 'VERTEX'

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

.swagger_types ⇒ Object

Attribute type mapping.



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/oci/fusion_apps/models/action.rb', line 58

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



152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/fusion_apps/models/action.rb', line 152

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

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



185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/fusion_apps/models/action.rb', line 185

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


165
166
167
 
# File 'lib/oci/fusion_apps/models/action.rb', line 165

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



174
175
176
 
# File 'lib/oci/fusion_apps/models/action.rb', line 174

def hash
  [reference_key, action_type, 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



218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/fusion_apps/models/action.rb', line 218

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



212
213
214
 
# File 'lib/oci/fusion_apps/models/action.rb', line 212

def to_s
  to_hash.to_s
end