Class: OCI::ContainerEngine::Models::NodeError

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/container_engine/models/node_error.rb

Overview

The properties that define an upstream error while managing a node.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NodeError

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :code (String)

    The value to assign to the #code property

  • :message (String)

    The value to assign to the #message property

  • :status (String)

    The value to assign to the #status property

  • :opc_request_id (String)

    The value to assign to the #opc_request_id property



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'lib/oci/container_engine/models/node_error.rb', line 61

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

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

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

  self.opc_request_id = attributes[:'opc-request-id'] if attributes[:'opc-request-id']

  raise 'You cannot provide both :opc-request-id and :opc_request_id' if attributes.key?(:'opc-request-id') && attributes.key?(:'opc_request_id')

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

Instance Attribute Details

#codeString

[Required] A short error code that defines the upstream error, meant for programmatic parsing. See API Errors.

Returns:

  • (String)


13
14
15
# File 'lib/oci/container_engine/models/node_error.rb', line 13

def code
  @code
end

#messageString

[Required] A human-readable error string of the upstream error.

Returns:

  • (String)


17
18
19
# File 'lib/oci/container_engine/models/node_error.rb', line 17

def message
  @message
end

#opc_request_idString

Unique Oracle-assigned identifier for the upstream request. If you need to contact Oracle about a particular upstream request, please provide the request ID.

Returns:

  • (String)


25
26
27
# File 'lib/oci/container_engine/models/node_error.rb', line 25

def opc_request_id
  @opc_request_id
end

#statusString

The status of the HTTP response encountered in the upstream error.

Returns:

  • (String)


21
22
23
# File 'lib/oci/container_engine/models/node_error.rb', line 21

def status
  @status
end

Class Method Details

.attribute_mapObject

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



28
29
30
31
32
33
34
35
36
37
# File 'lib/oci/container_engine/models/node_error.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'code': :'code',
    'message': :'message',
    'status': :'status',
    'opc_request_id': :'opc-request-id'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'code': :'String',
    'message': :'String',
    'status': :'String',
    'opc_request_id': :'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



87
88
89
90
91
92
93
94
95
# File 'lib/oci/container_engine/models/node_error.rb', line 87

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

  self.class == other.class &&
    code == other.code &&
    message == other.message &&
    status == other.status &&
    opc_request_id == other.opc_request_id
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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# File 'lib/oci/container_engine/models/node_error.rb', line 120

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


100
101
102
# File 'lib/oci/container_engine/models/node_error.rb', line 100

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



109
110
111
# File 'lib/oci/container_engine/models/node_error.rb', line 109

def hash
  [code, message, status, opc_request_id].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



153
154
155
156
157
158
159
160
161
162
# File 'lib/oci/container_engine/models/node_error.rb', line 153

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



147
148
149
# File 'lib/oci/container_engine/models/node_error.rb', line 147

def to_s
  to_hash.to_s
end