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



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

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

#code ⇒ String

[Required] A short error code that defines the upstream error, meant for programmatic parsing. See [API Errors](docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm).

Returns:

  • (String) 


11
12
13
 
# File 'lib/oci/container_engine/models/node_error.rb', line 11

def code
  @code
end

#message ⇒ String

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

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/container_engine/models/node_error.rb', line 15

def message
  @message
end

#opc_request_id ⇒ String

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) 


23
24
25
 
# File 'lib/oci/container_engine/models/node_error.rb', line 23

def opc_request_id
  @opc_request_id
end

#status ⇒ String

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

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/container_engine/models/node_error.rb', line 19

def status
  @status
end

Class Method Details

.attribute_map ⇒ Object

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



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

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_types ⇒ Object

Attribute type mapping.



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

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



85
86
87
88
89
90
91
92
 
# File 'lib/oci/container_engine/models/node_error.rb', line 85

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



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

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


97
98
99
 
# File 'lib/oci/container_engine/models/node_error.rb', line 97

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



106
107
108
 
# File 'lib/oci/container_engine/models/node_error.rb', line 106

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/container_engine/models/node_error.rb', line 149

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



143
144
145
 
# File 'lib/oci/container_engine/models/node_error.rb', line 143

def to_s
  to_hash.to_s
end