Class: ShellEv::ActiveResponse200Json

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/shell_ev/models/active_response200_json.rb

Overview

ActiveResponse200Json 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 = nil, status = nil, data = SKIP) ⇒ ActiveResponse200Json

Returns a new instance of ActiveResponse200Json.



46
47
48
49
50
 
# File 'lib/shell_ev/models/active_response200_json.rb', line 46

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

Instance Attribute Details

#data ⇒ Array[DataActive]

Indicates overall status of the request

Returns:



23
24
25
 
# File 'lib/shell_ev/models/active_response200_json.rb', line 23

def data
  @data
end

#request_id ⇒ UUID | String

Mandatory UUID (according to RFC 4122 standards) for requests and responses. This will be played back in the response from the request.

Returns:

  • (UUID | String) 


15
16
17
 
# File 'lib/shell_ev/models/active_response200_json.rb', line 15

def request_id
  @request_id
end

#status ⇒ ActiveResponse200JsonStatusEnum

Indicates overall status of the request

Returns:



19
20
21
 
# File 'lib/shell_ev/models/active_response200_json.rb', line 19

def status
  @status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/shell_ev/models/active_response200_json.rb', line 53

def self.from_hash(hash)
  return nil unless hash

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

  data = SKIP unless hash.key?('data')

  # Create object from extracted values.
  ActiveResponse200Json.new(request_id,
                            status,
                            data)
end

.names ⇒ Object

A mapping from model property names to API property names.



26
27
28
29
30
31
32
 
# File 'lib/shell_ev/models/active_response200_json.rb', line 26

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['request_id'] = 'requestId'
  @_hash['status'] = 'status'
  @_hash['data'] = 'data'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



42
43
44
 
# File 'lib/shell_ev/models/active_response200_json.rb', line 42

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



35
36
37
38
39
 
# File 'lib/shell_ev/models/active_response200_json.rb', line 35

def self.optionals
  %w[
    data
  ]
end