Class: OCI::CapacityManagement::Models::PatchProhibitInstruction

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

Overview

A precondition operation that requires a selection to be empty, or optionally to be non-empty but include no item with a specified value (useful for asserting that a value does not exist before attempting to create it, avoiding accidental update). It fails if value is provided and the selection includes an item matching it, or if value is not provided and the selection is not empty, but ignores NOT_FOUND exceptions.

Constant Summary

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 = {}) ⇒ PatchProhibitInstruction

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



53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/oci/capacity_management/models/patch_prohibit_instruction.rb', line 53

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

  attributes['operation'] = 'PROHIBIT'

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

Instance Attribute Details

#value ⇒ Object

A value to be compared against each item of the selection. If this value is an object, then it matches any item that would be unaffected by applying this value as a merge operation. Otherwise, it matches any item to which it is equal according to the rules of JSON Schema.

Returns:

  • (Object) 


21
22
23
 
# File 'lib/oci/capacity_management/models/patch_prohibit_instruction.rb', line 21

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



24
25
26
27
28
29
30
31
32
 
# File 'lib/oci/capacity_management/models/patch_prohibit_instruction.rb', line 24

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

.swagger_types ⇒ Object

Attribute type mapping.



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

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



73
74
75
76
77
78
79
80
 
# File 'lib/oci/capacity_management/models/patch_prohibit_instruction.rb', line 73

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

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



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/oci/capacity_management/models/patch_prohibit_instruction.rb', line 105

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


85
86
87
 
# File 'lib/oci/capacity_management/models/patch_prohibit_instruction.rb', line 85

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



94
95
96
 
# File 'lib/oci/capacity_management/models/patch_prohibit_instruction.rb', line 94

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



138
139
140
141
142
143
144
145
146
147
 
# File 'lib/oci/capacity_management/models/patch_prohibit_instruction.rb', line 138

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



132
133
134
 
# File 'lib/oci/capacity_management/models/patch_prohibit_instruction.rb', line 132

def to_s
  to_hash.to_s
end