Class: IbmCloudPower::PCloudJobsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ibm_cloud_power/api/p_cloud_jobs_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PCloudJobsApi

Returns a new instance of PCloudJobsApi.



19
20
21
 
# File 'lib/ibm_cloud_power/api/p_cloud_jobs_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/ibm_cloud_power/api/p_cloud_jobs_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#pcloud_cloudinstances_jobs_delete(cloud_instance_id, job_id, opts = {}) ⇒ Object

Delete a cloud instance job

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • job_id (String) —

    PCloud Job ID

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

    the optional parameters

Returns:

  • (Object) 


27
28
29
30
 
# File 'lib/ibm_cloud_power/api/p_cloud_jobs_api.rb', line 27

def pcloud_cloudinstances_jobs_delete(cloud_instance_id, job_id, opts = {})
  data, _status_code, _headers = pcloud_cloudinstances_jobs_delete_with_http_info(cloud_instance_id, job_id, opts)
  data
end

#pcloud_cloudinstances_jobs_delete_with_http_info(cloud_instance_id, job_id, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Delete a cloud instance job

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • job_id (String) —

    PCloud Job ID

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



37
38
39
40
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
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/ibm_cloud_power/api/p_cloud_jobs_api.rb', line 37

def pcloud_cloudinstances_jobs_delete_with_http_info(cloud_instance_id, job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudJobsApi.pcloud_cloudinstances_jobs_delete ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudJobsApi.pcloud_cloudinstances_jobs_delete"
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling PCloudJobsApi.pcloud_cloudinstances_jobs_delete"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/jobs/{job_id}'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['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] || []

  new_options = opts.merge(
    :operation => :"PCloudJobsApi.pcloud_cloudinstances_jobs_delete",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PCloudJobsApi#pcloud_cloudinstances_jobs_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#pcloud_cloudinstances_jobs_get(cloud_instance_id, job_id, opts = {}) ⇒ Job

List the detail of a job

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • job_id (String) —

    PCloud Job ID

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/ibm_cloud_power/api/p_cloud_jobs_api.rb', line 94

def pcloud_cloudinstances_jobs_get(cloud_instance_id, job_id, opts = {})
  data, _status_code, _headers = pcloud_cloudinstances_jobs_get_with_http_info(cloud_instance_id, job_id, opts)
  data
end

#pcloud_cloudinstances_jobs_get_with_http_info(cloud_instance_id, job_id, opts = {}) ⇒ Array<(Job, Integer, Hash)>

List the detail of a job

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

  • job_id (String) —

    PCloud Job ID

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

    the optional parameters

Returns:

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

    Job data, response status code and response headers



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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/ibm_cloud_power/api/p_cloud_jobs_api.rb', line 104

def pcloud_cloudinstances_jobs_get_with_http_info(cloud_instance_id, job_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudJobsApi.pcloud_cloudinstances_jobs_get ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudJobsApi.pcloud_cloudinstances_jobs_get"
  end
  # verify the required parameter 'job_id' is set
  if @api_client.config.client_side_validation && job_id.nil?
    fail ArgumentError, "Missing the required parameter 'job_id' when calling PCloudJobsApi.pcloud_cloudinstances_jobs_get"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/jobs/{job_id}'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_id.to_s)).sub('{' + 'job_id' + '}', CGI.escape(job_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['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] || 'Job'

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

  new_options = opts.merge(
    :operation => :"PCloudJobsApi.pcloud_cloudinstances_jobs_get",
    :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: PCloudJobsApi#pcloud_cloudinstances_jobs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#pcloud_cloudinstances_jobs_getall(cloud_instance_id, opts = {}) ⇒ Jobs

List up to the last 5 jobs initiated by the cloud instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Options Hash (opts):

  • :operation_id (String) —

    Operation ID to filter jobs (optional)

  • :operation_target (String) —

    Operation target to filter jobs (optional)

  • :operation_action (String) —

    Operation action to filter jobs (optional) vmCapture - includes operation action value (vmCapture) imageExport - includes operation action value (imageExport) imageImport - includes operation action value (imageImport) storage - includes operation action values (vmCapture,imageExport,imageImport)

Returns:



163
164
165
166
 
# File 'lib/ibm_cloud_power/api/p_cloud_jobs_api.rb', line 163

def pcloud_cloudinstances_jobs_getall(cloud_instance_id, opts = {})
  data, _status_code, _headers = pcloud_cloudinstances_jobs_getall_with_http_info(cloud_instance_id, opts)
  data
end

#pcloud_cloudinstances_jobs_getall_with_http_info(cloud_instance_id, opts = {}) ⇒ Array<(Jobs, Integer, Hash)>

List up to the last 5 jobs initiated by the cloud instance

Parameters:

  • cloud_instance_id (String) —

    Cloud Instance ID of a PCloud Instance

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

    the optional parameters

Options Hash (opts):

  • :operation_id (String) —

    Operation ID to filter jobs (optional)

  • :operation_target (String) —

    Operation target to filter jobs (optional)

  • :operation_action (String) —

    Operation action to filter jobs (optional) vmCapture - includes operation action value (vmCapture) imageExport - includes operation action value (imageExport) imageImport - includes operation action value (imageImport) storage - includes operation action values (vmCapture,imageExport,imageImport)

Returns:

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

    Jobs data, response status code and response headers



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/ibm_cloud_power/api/p_cloud_jobs_api.rb', line 175

def pcloud_cloudinstances_jobs_getall_with_http_info(cloud_instance_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudJobsApi.pcloud_cloudinstances_jobs_getall ...'
  end
  # verify the required parameter 'cloud_instance_id' is set
  if @api_client.config.client_side_validation && cloud_instance_id.nil?
    fail ArgumentError, "Missing the required parameter 'cloud_instance_id' when calling PCloudJobsApi.pcloud_cloudinstances_jobs_getall"
  end
  allowable_values = ["cloudConnection", "pvmInstance", "image", "vpnConnection"]
  if @api_client.config.client_side_validation && opts[:'operation_target'] && !allowable_values.include?(opts[:'operation_target'])
    fail ArgumentError, "invalid value for \"operation_target\", must be one of #{allowable_values}"
  end
  allowable_values = ["vmCapture", "imageExport", "imageImport", "storage"]
  if @api_client.config.client_side_validation && opts[:'operation_action'] && !allowable_values.include?(opts[:'operation_action'])
    fail ArgumentError, "invalid value for \"operation_action\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/pcloud/v1/cloud-instances/{cloud_instance_id}/jobs'.sub('{' + 'cloud_instance_id' + '}', CGI.escape(cloud_instance_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'operation.id'] = opts[:'operation_id'] if !opts[:'operation_id'].nil?
  query_params[:'operation.target'] = opts[:'operation_target'] if !opts[:'operation_target'].nil?
  query_params[:'operation.action'] = opts[:'operation_action'] if !opts[:'operation_action'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['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] || 'Jobs'

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

  new_options = opts.merge(
    :operation => :"PCloudJobsApi.pcloud_cloudinstances_jobs_getall",
    :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: PCloudJobsApi#pcloud_cloudinstances_jobs_getall\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end