Class: OCI::CapacityManagement::Models::PatchInsertInstruction

Inherits:
PatchInstruction
  • Object
show all
Defined in:
lib/oci/capacity_management/models/patch_insert_instruction.rb

Overview

An operation that inserts a value into an array, shifting array items as necessary and handling NOT_FOUND exceptions by creating the implied containing structure.

Constant Summary collapse

POSITION_ENUM = 
[
  POSITION_BEFORE = 'BEFORE'.freeze,
  POSITION_AFTER = 'AFTER'.freeze
].freeze

Constants inherited from PatchInstruction

OCI::CapacityManagement::Models::PatchInstruction::OPERATION_ENUM

Instance Attribute Summary collapse

Attributes inherited from PatchInstruction

#operation, #selection

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PatchInstruction

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ PatchInsertInstruction

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :selection (String) —

    The value to assign to the #selection proprety

  • :value (Object) —

    The value to assign to the #value property

  • :selected_item (String) —

    The value to assign to the #selected_item property

  • :position (String) —

    The value to assign to the #position property



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/oci/capacity_management/models/patch_insert_instruction.rb', line 69

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['operation'] = 'INSERT'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

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

  self.selected_item = attributes[:'selectedItem'] if attributes[:'selectedItem']

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

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

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

Instance Attribute Details

#position ⇒ String

Where to insert the value, relative to the first item matched by selectedItem. If selectedItem is unspecified, then "BEFORE" specifies insertion at the first position in an array and "AFTER" specifies insertion at the last position. If selectedItem is specified but results in an empty selection, then both values specify insertion at the last position.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/capacity_management/models/patch_insert_instruction.rb', line 31

def position
  @position
end

#selected_item ⇒ String

A selection to be evaluated against the array for identifying a particular reference item within it, with the same format and semantics as selection.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/capacity_management/models/patch_insert_instruction.rb', line 24

def selected_item
  @selected_item
end

#value ⇒ Object

[Required] A value to be inserted into the target.

Returns:

  • (Object) 


20
21
22
 
# File 'lib/oci/capacity_management/models/patch_insert_instruction.rb', line 20

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/oci/capacity_management/models/patch_insert_instruction.rb', line 34

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'operation': :'operation',
    'selection': :'selection',
    'value': :'value',
    'selected_item': :'selectedItem',
    'position': :'position'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/capacity_management/models/patch_insert_instruction.rb', line 47

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'operation': :'String',
    'selection': :'String',
    'value': :'Object',
    'selected_item': :'String',
    'position': :'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



105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/capacity_management/models/patch_insert_instruction.rb', line 105

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

  self.class == other.class &&
    operation == other.operation &&
    selection == other.selection &&
    value == other.value &&
    selected_item == other.selected_item &&
    position == other.position
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



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/capacity_management/models/patch_insert_instruction.rb', line 139

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


119
120
121
 
# File 'lib/oci/capacity_management/models/patch_insert_instruction.rb', line 119

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



128
129
130
 
# File 'lib/oci/capacity_management/models/patch_insert_instruction.rb', line 128

def hash
  [operation, selection, value, selected_item, position].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/capacity_management/models/patch_insert_instruction.rb', line 172

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



166
167
168
 
# File 'lib/oci/capacity_management/models/patch_insert_instruction.rb', line 166

def to_s
  to_hash.to_s
end