Class: JobRun

Inherits:
BsaSoapBase show all
Defined in:
lib/bl_soap/job_run.rb

Constant Summary

Constants inherited from BsaSoapBase

BsaSoapBase::CLI_SERVICE, BsaSoapBase::CLI_WSDL, BsaSoapBase::DEFAULT_AUTH_TYPE, BsaSoapBase::HTTP_READ_TIMEOUT, BsaSoapBase::LOGIN_SERVICE, BsaSoapBase::LOGIN_WSDL, BsaSoapBase::ROLE_SERVICE, BsaSoapBase::ROLE_WSDL

Instance Method Summary collapse

Methods inherited from BsaSoapBase

#execute_cli_with_attachments, #execute_cli_with_param_list, #get_all_servers, #get_cli_return_value, #initialize, #validate_cli_option_hash_string_values, #validate_cli_options_hash, #validate_cli_result, #validate_servers

Constructor Details

This class inherits a constructor from BsaSoapBase

Instance Method Details

#change_priority_of_running_job_by_job_run_id(options = {}) ⇒ Object 



2
3
4
5
6
7
8
9
10
11
12
 
# File 'lib/bl_soap/job_run.rb', line 2

def change_priority_of_running_job_by_job_run_id(options = {})
  validate_cli_options_hash([:job_run_id, :priority_string], options)
  void_result = execute_cli_with_param_list(self.class, "changePriorityOfRunningJobByJobRunId",
                                            [
                                                options[:job_run_id],		# Job run ID number
                                                options[:priority_string]	# Priority to change job run to
                                            ])
  void_value = get_cli_return_value(void_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#find_all_run_keys_by_job_key(options = {}) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
 
# File 'lib/bl_soap/job_run.rb', line 14

def find_all_run_keys_by_job_key(options = {})
  validate_cli_options_hash([:job_key], options)
  string_result = execute_cli_with_param_list(self.class, "findAllRunKeysByJobKey",
                                              [
                                                  options[:job_key]	# DBKey key for the job
                                              ])
  string_value = get_cli_return_value(string_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#find_last_run_key_by_job_key(options = {}) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/bl_soap/job_run.rb', line 25

def find_last_run_key_by_job_key(options = {})
  validate_cli_options_hash([:job_key], options)
  db_key_result = execute_cli_with_param_list(self.class, "findLastRunKeyByJobKey",
                                              [
                                                  options[:job_key],							# DBKey for the job
                                              # NIEK options[:exclude_deploy_attempts] || false	# Exclude deploy attempt run id
                                              ])
  db_key = get_cli_return_value(db_key_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#find_last_run_key_by_job_key_ignore_version(options = {}) ⇒ Object 



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/bl_soap/job_run.rb', line 37

def find_last_run_key_by_job_key_ignore_version(options = {})
  validate_cli_options_hash([:job_key], options)
  db_key_result = execute_cli_with_param_list(self.class, "findLastRunKeyByJobKeyIgnoreVersion",
                                              [
                                                  options[:job_key]	# DBKey for the job
                                              ])
  db_key = get_cli_return_value(db_key_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#find_run_count_by_job_key(options = {}) ⇒ Object 



48
49
50
51
52
53
54
55
56
57
 
# File 'lib/bl_soap/job_run.rb', line 48

def find_run_count_by_job_key(options = {})
  validate_cli_options_hash([:job_key], options)
  integer_result = execute_cli_with_param_list(self.class, "findRunCountByJobKey",
                                               [
                                                   options[:job_key]	# DBKey for the job
                                               ])
  integer_value = get_cli_return_value(integer_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#find_run_key_by_id(options = {}) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/bl_soap/job_run.rb', line 59

def find_run_key_by_id(options = {})
  #findRunKeyById_1 is deprecated => No support for job_key option
  validate_cli_options_hash([:job_run_id], options)
  db_key_result = execute_cli_with_param_list(self.class, "findRunKeyById",
                                              [
                                                  options[:job_run_id]	# Run number of the job run
                                              ])
  db_key = get_cli_return_value(db_key_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#get_aborted_job_runs_by_end_date(options = {}) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
 
# File 'lib/bl_soap/job_run.rb', line 71

def get_aborted_job_runs_by_end_date(options = {})
  validate_cli_options_hash([:end_type], options)
  string_result = execute_cli_with_param_list(self.class, "getAbortedJobRunsByEndDate",
                                              [
                                                  options[:end_time]	# Time to use as the earliest end date, only runs aborted after this date will be shown
                                              ])
  string_value = get_cli_return_value(string_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#get_deploy_job_max_run_id(options = {}) ⇒ Object 



261
262
263
264
265
266
267
268
269
270
 
# File 'lib/bl_soap/job_run.rb', line 261

def get_deploy_job_max_run_id(options = {})
  validate_cli_options_hash([:db_key_of_deploy_job], options)
  void_result = execute_cli_with_param_list(self.class, "getDeployJobMaxRunId",
                                            [
                                                options[:db_key_of_deploy_job]	# Handle identifying a particular job run
                                            ])
  void_value = get_cli_return_value(void_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#get_end_time_by_run_key(options = {}) ⇒ Object 



82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/bl_soap/job_run.rb', line 82

def get_end_time_by_run_key(options = {})
  validate_cli_options_hash([:job_run_key], options)
  object_result = execute_cli_with_param_list(self.class, "getEndTimeByRunKey",
                                              [
                                                  options[:job_run_key],						# Handle identifying a particular job run
                                                  options[:format] || "yyyy/MM/dd HH:mm:ss"	# Format for presenting time
                                              ])
  object_value = get_cli_return_value(object_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#get_executing_user_and_role_by_run_key(options = {}) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
 
# File 'lib/bl_soap/job_run.rb', line 94

def get_executing_user_and_role_by_run_key(options = {})
  validate_cli_options_hash([:job_run_key], options)
  string_result = execute_cli_with_param_list(self.class, "getExecutingUserAndRoleByRunKey",
                                              [
                                                  options[:job_run_key]	# Handle identifying a particular job run
                                              ])
  string_value = get_cli_return_value(string_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#get_job_run_had_errors(options = {}) ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/bl_soap/job_run.rb', line 105

def get_job_run_had_errors(options = {})
  # getJobRunHadErrors_1 deprecated => No support
  validate_cli_options_hash([:job_run_key], options)
  boolean_result = execute_cli_with_param_list(self.class, "getJobRunHadErrors",
                                               [
                                                   options[:job_run_key]	# Handle identifying a particular job run
                                               ])
  boolean_value = get_cli_return_value(boolean_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#get_job_run_had_errors_by_id(options = {}) ⇒ Object 



117
118
119
120
121
122
123
124
125
126
 
# File 'lib/bl_soap/job_run.rb', line 117

def get_job_run_had_errors_by_id(options = {})
  validate_cli_options_hash([:job_run_id], options)
  boolean_result = execute_cli_with_param_list(self.class, "getJobRunHadErrorsById",
                                               [
                                                   options[:job_run_id]	# Run ID for the job run
                                               ])
  boolean_value = get_cli_return_value(boolean_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#get_job_run_is_running_by_run_key(options = {}) ⇒ Object 



128
129
130
131
132
133
134
135
136
137
 
# File 'lib/bl_soap/job_run.rb', line 128

def get_job_run_is_running_by_run_key(options = {})
  validate_cli_options_hash([:job_run_key], options)
  boolean_result = execute_cli_with_param_list(self.class, "getJobRunIsRunningByRunKey",
                                               [
                                                   options[:job_run_key]	# Handle identifying a particular job run
                                               ])
  boolean_value = get_cli_return_value(boolean_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#get_job_run_status_by_schedule_id(options = {}) ⇒ Object 



139
140
141
142
143
144
145
146
147
148
 
# File 'lib/bl_soap/job_run.rb', line 139

def get_job_run_status_by_schedule_id(options = {})
  validate_cli_options_hash([:schedule_id], options)
  string_result = execute_cli_with_param_list(self.class, "getJobRunStatusByScheduleId",
                                              [
                                                  options[:schedule_id]	# Handle identifying a particular job run
                                              ])
  string_value = get_cli_return_value(string_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#get_log_items_by_job_run_id(options = {}) ⇒ Object 



150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/bl_soap/job_run.rb', line 150

def get_log_items_by_job_run_id(options = {})
  validate_cli_options_hash([:job_key, :job_run_id], options)
  string_result = execute_cli_with_param_list(self.class, "getLogItemsByJobRunId",
                                              [
                                                  options[:job_key],		# DB Key of the job
                                                  options[:job_run_id]	# Job run ID number
                                              ])
  string_value = get_cli_return_value(string_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#get_servers_status_by_job_run(options = {}) ⇒ Object 



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/bl_soap/job_run.rb', line 162

def get_servers_status_by_job_run(options = {})
  validate_cli_options_hash([:job_run_id], options)
  map_result = execute_cli_with_param_list(self.class, "getServerStatusByJobRun",
                                           [
                                               options[:job_run_id]	# Job run ID number
                                           ])
  map_value = get_cli_return_value(map_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#get_start_time_by_run_key(options = {}) ⇒ Object 



173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/bl_soap/job_run.rb', line 173

def get_start_time_by_run_key(options = {})
  validate_cli_options_hash([:job_run_key], options)
  object_result = execute_cli_with_param_list(self.class, "getStartTimeByRunKey",
                                              [
                                                  options[:job_run_key],						# Handle identifying a particular job run
                                                  options[:format] || "yyyy/MM/dd HH:mm:ss"	# Format for presenting time
                                              ])
  object_value = get_cli_return_value(object_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#job_run_key_to_job_run_id(options = {}) ⇒ Object 



185
186
187
188
189
190
191
192
193
194
 
# File 'lib/bl_soap/job_run.rb', line 185

def job_run_key_to_job_run_id(options = {})
  validate_cli_options_hash([:job_run_key], options)
  integer_result = execute_cli_with_param_list(self.class, "jobRunKeyToJobRunId",
                                               [
                                                   options[:job_run_key]	# Handle identifying a particular job run
                                               ])
  integer_value = get_cli_return_value(integer_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#pause_running_job_by_job_run_key(options = {}) ⇒ Object 



196
197
198
199
200
201
202
203
204
205
 
# File 'lib/bl_soap/job_run.rb', line 196

def pause_running_job_by_job_run_key(options = {})
  validate_cli_options_hash([:job_run_key], options)
  void_result = execute_cli_with_param_list(self.class, "pauseRunningJobByJobRunKey",
                                            [
                                                options[:job_run_key]	# Handle identifying a particular job run
                                            ])
  void_value = get_cli_return_value(void_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#resume_paused_job_by_job_run_key(options = {}) ⇒ Object 



207
208
209
210
211
212
213
214
215
216
 
# File 'lib/bl_soap/job_run.rb', line 207

def resume_paused_job_by_job_run_key(options = {})
  validate_cli_options_hash([:job_run_key], options)
  void_result = execute_cli_with_param_list(self.class, "resumePausedJobByJobRunKey",
                                            [
                                                options[:job_run_key]	# Handle identifying a particular job run
                                            ])
  void_value = get_cli_return_value(void_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#show_all_running_batch_job_run_status(options = {}) ⇒ Object 



218
219
220
221
222
223
 
# File 'lib/bl_soap/job_run.rb', line 218

def show_all_running_batch_job_run_status(options = {})
  void_result = execute_cli_with_param_list(self.class, "showAllRunningBatchJobRunStatus")
  void_value = get_cli_return_value(void_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#show_all_running_post_prov_batch_job_run_status(options = {}) ⇒ Object 



225
226
227
228
229
230
 
# File 'lib/bl_soap/job_run.rb', line 225

def show_all_running_post_prov_batch_job_run_status(options = {})
  list_result = execute_cli_with_param_list(self.class, "showAllRunningPostProvBatchJobRunStatus")
  list_value = get_cli_return_value(list_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#show_batch_job_run_status_by_run_id(options = {}) ⇒ Object 



232
233
234
235
236
237
238
239
240
241
 
# File 'lib/bl_soap/job_run.rb', line 232

def show_batch_job_run_status_by_run_id(options = {})
  validate_cli_options_hash([:run_id], options)
  void_result = execute_cli_with_param_list(self.class, "showBatchJobRunStatusByRunId",
                                            [
                                                options[:run_id]	# Handle identifying a particular job run
                                            ])
  void_value = get_cli_return_value(void_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#show_batch_job_run_status_by_run_key(options = {}) ⇒ Object 



243
244
245
246
247
248
249
250
251
252
 
# File 'lib/bl_soap/job_run.rb', line 243

def show_batch_job_run_status_by_run_key(options = {})
  validate_cli_options_hash([:job_run_key], options)
  void_result = execute_cli_with_param_list(self.class, "showBatchJobRunStatusByRunId",
                                            [
                                                options[:job_run_key]	# Handle identifying a particular job run
                                            ])
  void_value = get_cli_return_value(void_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end

#show_running_jobs(options = {}) ⇒ Object 



254
255
256
257
258
259
 
# File 'lib/bl_soap/job_run.rb', line 254

def show_running_jobs(options = {})
  void_result = execute_cli_with_param_list(self.class, "showRunningJobs")
  void_value = get_cli_return_value(void_result)
rescue => exception
  raise "#{self.class} Exception: #{exception.to_s}"
end