Class: BatchlyApi::RunsController

Inherits:
Object
  • Object
show all
Defined in:
lib/batchly_api/controllers/runs_controller.rb

Instance Method Summary collapse

Instance Method Details

#delete_run(id) ⇒ Object

Removes the run from the active list. The values are still considered for cost and savings calculation.

Only completed, terminated and error runs can be archived.
Active execution should first be stopped and then archived.

Parameters:

  • id (String) —

    Required parameter: Run Identifier

Returns:

  • void response from the API call



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/batchly_api/controllers/runs_controller.rb', line 122

def delete_run id
  # the base uri for api requests

  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call

  query_builder << "/api/Runs/{id}"

  # process optional query parameters

  query_builder = APIHelper.append_url_with_template_parameters query_builder, {
    "id" => id,
  }

  # validate and preprocess url

  query_url = APIHelper.clean_url query_builder

  # prepare headers

  headers = {
    "user-agent" => "batchly/1.0.1"
  }

  # append custom auth authorization

  CustomAuthUtility.append_custom_auth_params query_url, "DELETE", headers

  # invoke the API call request to fetch the response

  response = Unirest.delete query_url, headers:headers

  # Error handling using HTTP status codes

  if response.code == 404
    raise APIException.new "NotFound", 404, response.raw_body
  elsif !(response.code.between?(200,206)) # [200,206] = HTTP OK

    raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
  end
end

#describe_run(id) ⇒ Object

Returns the detailed information about the requested run

Parameters:

  • id (String) —

    Required parameter: Run Identifier

Returns:

  • RunModel response from the API call



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/batchly_api/controllers/runs_controller.rb', line 41

def describe_run id
  # the base uri for api requests

  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call

  query_builder << "/api/Runs/{id}"

  # process optional query parameters

  query_builder = APIHelper.append_url_with_template_parameters query_builder, {
    "id" => id,
  }

  # validate and preprocess url

  query_url = APIHelper.clean_url query_builder

  # prepare headers

  headers = {
    "user-agent" => "batchly/1.0.1",
    "accept" => "application/json"
  }

  # append custom auth authorization

  CustomAuthUtility.append_custom_auth_params query_url, "GET", headers

  # invoke the API call request to fetch the response

  response = Unirest.get query_url, headers:headers

  # Error handling using HTTP status codes

  if response.code == 404
    raise APIException.new "NotFound", 404, response.raw_body
  elsif !(response.code.between?(200,206)) # [200,206] = HTTP OK

    raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
  end

  response.body
end

#list_runs ⇒ Object

Returns the active runs with details about the current status



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/batchly_api/controllers/runs_controller.rb', line 8

def list_runs
  # the base uri for api requests

  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call

  query_builder << "/api/Runs"

  # validate and preprocess url

  query_url = APIHelper.clean_url query_builder

  # prepare headers

  headers = {
    "user-agent" => "batchly/1.0.1",
    "accept" => "application/json"
  }

  # append custom auth authorization

  CustomAuthUtility.append_custom_auth_params query_url, "GET", headers

  # invoke the API call request to fetch the response

  response = Unirest.get query_url, headers:headers

  #Error handling using HTTP status codes

  if !(response.code.between?(200,206)) # [200,206] = HTTP OK

    raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
  end

  response.body
end

#stop_run(id) ⇒ Object

Stops the run if its executing and returns 200 true response. Repeat calls to a run which is currently stopping returns a 200 false response

Parameters:

  • id (String) —

    Required parameter: Run Identifier

Returns:

  • Boolean response from the API call



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
 
# File 'lib/batchly_api/controllers/runs_controller.rb', line 81

def stop_run id
  # the base uri for api requests

  query_builder = Configuration.BASE_URI.dup

  # prepare query string for API call

  query_builder << "/api/Runs/{id}"

  # process optional query parameters

  query_builder = APIHelper.append_url_with_template_parameters query_builder, {
    "id" => id,
  }

  # validate and preprocess url

  query_url = APIHelper.clean_url query_builder

  # prepare headers

  headers = {
    "user-agent" => "batchly/1.0.1"
  }

  # append custom auth authorization

  CustomAuthUtility.append_custom_auth_params query_url, "PUT", headers

  # invoke the API call request to fetch the response

  response = Unirest.put query_url, headers:headers

  # Error handling using HTTP status codes

  if response.code == 404
    raise APIException.new "NotFound", 404, response.raw_body
  elsif !(response.code.between?(200,206)) # [200,206] = HTTP OK

    raise APIException.new "HTTP Response Not OK", response.code, response.raw_body
  end

  response.body
end