Class: ShellDataReportingApIs::ErrorObject

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/shell_data_reporting_ap_is/models/error_object.rb

Overview

ErrorObject Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(request_id = SKIP, status = SKIP, errors = SKIP) ⇒ ErrorObject

Returns a new instance of ErrorObject.



50
51
52
53
54
 
# File 'lib/shell_data_reporting_ap_is/models/error_object.rb', line 50

def initialize(request_id = SKIP, status = SKIP, errors = SKIP)
  @request_id = request_id unless request_id == SKIP
  @status = status unless status == SKIP
  @errors = errors unless errors == SKIP
end

Instance Attribute Details

#errors ⇒ Array[ErrorDetails]

Indicates overall status of the request. Allowed values: SUCCES, FAILED, PARTIAL_SUCCESS

Returns:



25
26
27
 
# File 'lib/shell_data_reporting_ap_is/models/error_object.rb', line 25

def errors
  @errors
end

#request_id ⇒ String

Unique request identifier passed from end user. This identifier helps in tracing a transaction

Returns:

  • (String) 


15
16
17
 
# File 'lib/shell_data_reporting_ap_is/models/error_object.rb', line 15

def request_id
  @request_id
end

#status ⇒ String

Indicates overall status of the request. Allowed values: SUCCES, FAILED, PARTIAL_SUCCESS

Returns:

  • (String) 


20
21
22
 
# File 'lib/shell_data_reporting_ap_is/models/error_object.rb', line 20

def status
  @status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/shell_data_reporting_ap_is/models/error_object.rb', line 57

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  request_id = hash.key?('RequestId') ? hash['RequestId'] : SKIP
  status = hash.key?('Status') ? hash['Status'] : SKIP
  # Parameter is an array, so we need to iterate through it
  errors = nil
  unless hash['Errors'].nil?
    errors = []
    hash['Errors'].each do |structure|
      errors << (ErrorDetails.from_hash(structure) if structure)
    end
  end

  errors = SKIP unless hash.key?('Errors')

  # Create object from extracted values.
  ErrorObject.new(request_id,
                  status,
                  errors)
end

.names ⇒ Object

A mapping from model property names to API property names.



28
29
30
31
32
33
34
 
# File 'lib/shell_data_reporting_ap_is/models/error_object.rb', line 28

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['request_id'] = 'RequestId'
  @_hash['status'] = 'Status'
  @_hash['errors'] = 'Errors'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



46
47
48
 
# File 'lib/shell_data_reporting_ap_is/models/error_object.rb', line 46

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



37
38
39
40
41
42
43
 
# File 'lib/shell_data_reporting_ap_is/models/error_object.rb', line 37

def self.optionals
  %w[
    request_id
    status
    errors
  ]
end