Class: ShellDataReportingApIs::ErrorStatus

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

Overview

ErrorStatus Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(code = SKIP, description = SKIP) ⇒ ErrorStatus

Returns a new instance of ErrorStatus.



41
42
43
44
 
# File 'lib/shell_data_reporting_ap_is/models/error_status.rb', line 41

def initialize(code = SKIP, description = SKIP)
  @code = code unless code == SKIP
  @description = description unless description == SKIP
end

Instance Attribute Details

#code ⇒ String

Error Code

Returns:

  • (String) 


14
15
16
 
# File 'lib/shell_data_reporting_ap_is/models/error_status.rb', line 14

def code
  @code
end

#description ⇒ String

Error Description

Returns:

  • (String) 


18
19
20
 
# File 'lib/shell_data_reporting_ap_is/models/error_status.rb', line 18

def description
  @description
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/shell_data_reporting_ap_is/models/error_status.rb', line 47

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  code = hash.key?('Code') ? hash['Code'] : SKIP
  description = hash.key?('Description') ? hash['Description'] : SKIP

  # Create object from extracted values.
  ErrorStatus.new(code,
                  description)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/shell_data_reporting_ap_is/models/error_status.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['code'] = 'Code'
  @_hash['description'] = 'Description'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/shell_data_reporting_ap_is/models/error_status.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    code
    description
  ]
end

.validate(value) ⇒ Object

Validates an instance of the object from a given value.

Parameters:

  • The (ErrorStatus | Hash) —

    value against the validation is performed.



61
62
63
64
65
66
67
 
# File 'lib/shell_data_reporting_ap_is/models/error_status.rb', line 61

def self.validate(value)
  return true if value.instance_of? self

  return false unless value.instance_of? Hash

  true
end