Class: OCI::DataSafe::Models::PatchInstruction

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_safe/models/patch_instruction.rb

Overview

A single instruction to be included as part of Patch request content. 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

OPERATION_ENUM = 
[
  OPERATION_INSERT = 'INSERT'.freeze,
  OPERATION_REMOVE = 'REMOVE'.freeze,
  OPERATION_MERGE = 'MERGE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PatchInstruction

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :operation (String) —

    The value to assign to the #operation property

  • :selection (String) —

    The value to assign to the #selection property



71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/data_safe/models/patch_instruction.rb', line 71

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

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

Instance Attribute Details

#operation ⇒ String

[Required] The patch operation.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/data_safe/models/patch_instruction.rb', line 20

def operation
  @operation
end

#selection ⇒ String

[Required] The set of values to which the operation applies as a JMESPath expression for evaluation against the context resource. An operation fails if the selection yields an exception, except as otherwise specified. Note that comparisons involving non-primitive values (objects or arrays) are not supported and will always evaluate to false.

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/data_safe/models/patch_instruction.rb', line 24

def selection
  @selection
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
 
# File 'lib/oci/data_safe/models/patch_instruction.rb', line 27

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



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

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

  return 'OCI::DataSafe::Models::PatchRemoveInstruction' if type == 'REMOVE'
  return 'OCI::DataSafe::Models::PatchInsertInstruction' if type == 'INSERT'
  return 'OCI::DataSafe::Models::PatchMergeInstruction' if type == 'MERGE'

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

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
 
# File 'lib/oci/data_safe/models/patch_instruction.rb', line 37

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



97
98
99
100
101
102
103
 
# File 'lib/oci/data_safe/models/patch_instruction.rb', line 97

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

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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/data_safe/models/patch_instruction.rb', line 128

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


108
109
110
 
# File 'lib/oci/data_safe/models/patch_instruction.rb', line 108

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



117
118
119
 
# File 'lib/oci/data_safe/models/patch_instruction.rb', line 117

def hash
  [operation, selection].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/data_safe/models/patch_instruction.rb', line 161

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



155
156
157
 
# File 'lib/oci/data_safe/models/patch_instruction.rb', line 155

def to_s
  to_hash.to_s
end