Class: Falcon::Execution

Inherits:
Object
  • Object
show all
Defined in:
lib/crimson-falcon/api/execution.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ Execution

Returns a new instance of Execution.



36
37
38
 
# File 'lib/crimson-falcon/api/execution.rb', line 36

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



34
35
36
 
# File 'lib/crimson-falcon/api/execution.rb', line 34

def api_client
  @api_client
end

Instance Method Details

#read_request_body(id, fn, filename, sha256, opts = {}) ⇒ Object

retrieve a large request body, such as a file, that has spilled into object storage

Parameters:

  • id (String) —

    Execution ID

  • fn (String) —

    function ref; form of $fn_id:$fn_version

  • filename (String) —

    filename to be retrieved

  • sha256 (String) —

    sha256 checksum for file to be retrieved

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

    the optional parameters

Returns:

  • (Object) 


46
47
48
49
 
# File 'lib/crimson-falcon/api/execution.rb', line 46

def read_request_body(id, fn, filename, sha256, opts = {})
  data, _status_code, _headers = read_request_body_with_http_info(id, fn, filename, sha256, opts)
  data
end

#read_request_body_with_http_info(id, fn, filename, sha256, opts = {}) ⇒ Array<(Object, Integer, Hash)>

retrieve a large request body, such as a file, that has spilled into object storage

Parameters:

  • id (String) —

    Execution ID

  • fn (String) —

    function ref; form of $fn_id:$fn_version

  • filename (String) —

    filename to be retrieved

  • sha256 (String) —

    sha256 checksum for file to be retrieved

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

    the optional parameters

Returns:

  • (Array<(Object, Integer, Hash)>) —

    Object data, response status code and response headers



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/crimson-falcon/api/execution.rb', line 58

def read_request_body_with_http_info(id, fn, filename, sha256, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: Execution.read_request_body ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling Execution.read_request_body"
  end
  # verify the required parameter 'fn' is set
  if @api_client.config.client_side_validation && fn.nil?
    fail ArgumentError, "Missing the required parameter 'fn' when calling Execution.read_request_body"
  end
  # verify the required parameter 'filename' is set
  if @api_client.config.client_side_validation && filename.nil?
    fail ArgumentError, "Missing the required parameter 'filename' when calling Execution.read_request_body"
  end
  # verify the required parameter 'sha256' is set
  if @api_client.config.client_side_validation && sha256.nil?
    fail ArgumentError, "Missing the required parameter 'sha256' when calling Execution.read_request_body"
  end
  # resource path
  local_var_path = '/faas-gateway/entities/execution-request-body/v2'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = id
  query_params[:'fn'] = fn
  query_params[:'filename'] = filename
  query_params[:'sha256'] = sha256

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv', 'text/plain', 'application/octet-stream', 'application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Object'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"Execution.read_request_body",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: Execution#read_request_body\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end