Class: Rafflesia::Platform

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

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Platform

Returns a new instance of Platform.



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

def initialize(client)
  @client = client
end

Instance Method Details

#artifactsRead(runs_root: nil, row_id: nil, path: nil, max_bytes: nil, request_options: {}) ⇒ Rafflesia::EnvelopePlatformArtifactReadData

GET /v1/platform/artifacts/read

Parameters:

  • runs_root (String, nil) (defaults to: nil)
  • row_id (String, nil) (defaults to: nil)
  • path (String, nil) (defaults to: nil)
  • max_bytes (Integer, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/rafflesia/platform.rb', line 20

def artifactsRead(
  runs_root: nil,
  row_id: nil,
  path: nil,
  max_bytes: nil,
  request_options: {}
)
  params = {
    'runs_root' => runs_root,
    'row_id' => row_id,
    'path' => path,
    'max_bytes' => max_bytes
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/platform/artifacts/read',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopePlatformArtifactReadData.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

#index(runs_root: nil, request_options: {}) ⇒ Rafflesia::EnvelopePlatformIndexData

GET /v1/platform/index

Parameters:

  • runs_root (String, nil) (defaults to: nil)
  • request_options (Hash) (defaults to: {}) —

    (see Rafflesia::Types::RequestOptions)

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/rafflesia/platform.rb', line 49

def index(
  runs_root: nil,
  request_options: {}
)
  params = {
    'runs_root' => runs_root
  }.compact
  response = @client.request(
    method: :get,
    path: '/v1/platform/index',
    auth: true,
    params: params,
    request_options: request_options
  )
  result = Rafflesia::EnvelopePlatformIndexData.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