Class: Rafflesia::System

Inherits:
Object
  • Object
show all
Defined in:
lib/rafflesia/system.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ System

Returns a new instance of System.



9
10
11
 
# File 'lib/rafflesia/system.rb', line 9

def initialize(client)
  @client = client
end

Instance Method Details

#build(request_options: {}) ⇒ Rafflesia::EnvelopeBuildInfo

GET /v1/system/build

Parameters:

  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/rafflesia/system.rb', line 16

def build(request_options: {})
  response = @client.request(
    method: :get,
    path: '/v1/system/build',
    auth: true,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeBuildInfo.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#health(request_options: {}) ⇒ Rafflesia::EnvelopeHealthData

GET /v1/system/health

Parameters:

  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/rafflesia/system.rb', line 31

def health(request_options: {})
  response = @client.request(
    method: :get,
    path: '/v1/system/health',
    auth: true,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeHealthData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#healthDeep(request_options: {}) ⇒ Rafflesia::EnvelopeHealthData

GET /v1/system/health/deep

Parameters:

  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/rafflesia/system.rb', line 46

def healthDeep(request_options: {})
  response = @client.request(
    method: :get,
    path: '/v1/system/health/deep',
    auth: true,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeHealthData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#healthLive(request_options: {}) ⇒ Rafflesia::EnvelopeHealthData

GET /v1/system/health/live

Parameters:

  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/rafflesia/system.rb', line 61

def healthLive(request_options: {})
  response = @client.request(
    method: :get,
    path: '/v1/system/health/live',
    auth: true,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeHealthData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#healthReady(request_options: {}) ⇒ Rafflesia::EnvelopeHealthData

GET /v1/system/health/ready

Parameters:

  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/rafflesia/system.rb', line 76

def healthReady(request_options: {})
  response = @client.request(
    method: :get,
    path: '/v1/system/health/ready',
    auth: true,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeHealthData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#infraRequestsList(target: nil, operation: nil, status: nil, request_id: nil, started_before: nil, started_after: nil, before: nil, after: nil, order: nil, limit: nil, request_options: {}) ⇒ Rafflesia::EnvelopeInfraRequestListData

GET /v1/system/infra_requests

Parameters:

  • target (Rafflesia::Types::SystemTarget, nil) (defaults to: nil)
  • operation (String, nil) (defaults to: nil)
  • status (Rafflesia::Types::SystemStatus, nil) (defaults to: nil)
  • request_id (String, nil) (defaults to: nil)
  • started_before (String, nil) (defaults to: nil)
  • started_after (String, nil) (defaults to: nil)
  • before (String, nil) (defaults to: nil)
  • after (String, nil) (defaults to: nil)
  • order (Rafflesia::Types::SystemOrder, nil) (defaults to: nil)
  • limit (Integer, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/rafflesia/system.rb', line 101

def infraRequestsList(
  target: nil,
  operation: nil,
  status: nil,
  request_id: nil,
  started_before: nil,
  started_after: nil,
  before: nil,
  after: nil,
  order: nil,
  limit: nil,
  request_options: {}
)
  params = {
    'target' => target,
    'operation' => operation,
    'status' => status,
    'request_id' => request_id,
    'started_before' => started_before,
    'started_after' => started_after,
    'before' => before,
    'after' => after,
    'order' => order,
    'limit' => limit
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/system/infra_requests',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopeInfraRequestListData.new(response.body)
  result.last_response = Rafflesia::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"])
  result
end

#openapi(request_options: {}) ⇒ String

GET /v1/system/openapi

Parameters:

  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:

  • (String) 


141
142
143
144
145
146
147
148
149
 
# File 'lib/rafflesia/system.rb', line 141

def openapi(request_options: {})
  response = @client.request(
    method: :get,
    path: '/v1/system/openapi',
    auth: true,
    request_options: request_options
  )
  response.body
end