Class: OCI::DatabaseMigration::Models::ResultError

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/database_migration/models/result_error.rb

Overview

Error Information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ResultError

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

  • :issue (String) —

    The value to assign to the #issue property

  • :action (String) —

    The value to assign to the #action property

  • :action_link (String) —

    The value to assign to the #action_link property

  • :action_text (String) —

    The value to assign to the #action_text property



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/oci/database_migration/models/result_error.rb', line 82

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

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

  self.action_link = attributes[:'actionLink'] if attributes[:'actionLink']

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

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

  self.action_text = attributes[:'actionText'] if attributes[:'actionText']

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

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

Instance Attribute Details

#action ⇒ String

The text describing the action required to fix the issue

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/database_migration/models/result_error.rb', line 30

def action
  @action
end

#action_link ⇒ String

The link to the documentation

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/database_migration/models/result_error.rb', line 35

def action_link
  @action_link
end

#action_text ⇒ String

The text for the link to the documentation

Returns:

  • (String) 


40
41
42
 
# File 'lib/oci/database_migration/models/result_error.rb', line 40

def action_text
  @action_text
end

#code ⇒ String

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

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/database_migration/models/result_error.rb', line 15

def code
  @code
end

#issue ⇒ String

The text describing the root cause of the reported issue

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/database_migration/models/result_error.rb', line 25

def issue
  @issue
end

#message ⇒ String

[Required] A human-readable error string.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/database_migration/models/result_error.rb', line 20

def message
  @message
end

Class Method Details

.attribute_map ⇒ Object

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



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/database_migration/models/result_error.rb', line 43

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'code': :'code',
    'message': :'message',
    'issue': :'issue',
    'action': :'action',
    'action_link': :'actionLink',
    'action_text': :'actionText'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/database_migration/models/result_error.rb', line 57

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



116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/oci/database_migration/models/result_error.rb', line 116

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

  self.class == other.class &&
    code == other.code &&
    message == other.message &&
    issue == other.issue &&
    action == other.action &&
    action_link == other.action_link &&
    action_text == other.action_text
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



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/database_migration/models/result_error.rb', line 151

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


131
132
133
 
# File 'lib/oci/database_migration/models/result_error.rb', line 131

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



140
141
142
 
# File 'lib/oci/database_migration/models/result_error.rb', line 140

def hash
  [code, message, issue, action, action_link, action_text].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



184
185
186
187
188
189
190
191
192
193
 
# File 'lib/oci/database_migration/models/result_error.rb', line 184

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



178
179
180
 
# File 'lib/oci/database_migration/models/result_error.rb', line 178

def to_s
  to_hash.to_s
end