class IbmCloudPower::PCloudTasksApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/ibm_cloud_power/api/p_cloud_tasks_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

pcloud_tasks_delete(task_id, opts = {}) click to toggle source

Delete a task @param task_id [String] PCloud Task ID @param [Hash] opts the optional parameters @return [Object]

# File lib/ibm_cloud_power/api/p_cloud_tasks_api.rb, line 26
def pcloud_tasks_delete(task_id, opts = {})
  data, _status_code, _headers = pcloud_tasks_delete_with_http_info(task_id, opts)
  data
end
pcloud_tasks_delete_with_http_info(task_id, opts = {}) click to toggle source

Delete a task @param task_id [String] PCloud Task ID @param [Hash] opts the optional parameters @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers

# File lib/ibm_cloud_power/api/p_cloud_tasks_api.rb, line 35
def pcloud_tasks_delete_with_http_info(task_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudTasksApi.pcloud_tasks_delete ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling PCloudTasksApi.pcloud_tasks_delete"
  end
  # resource path
  local_var_path = '/pcloud/v1/tasks/{task_id}'.sub('{' + 'task_id' + '}', CGI.escape(task_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[:body] 

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

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

  new_options = opts.merge(
    :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: PCloudTasksApi#pcloud_tasks_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
pcloud_tasks_get(task_id, opts = {}) click to toggle source

Get a task @param task_id [String] PCloud Task ID @param [Hash] opts the optional parameters @return [Task]

# File lib/ibm_cloud_power/api/p_cloud_tasks_api.rb, line 86
def pcloud_tasks_get(task_id, opts = {})
  data, _status_code, _headers = pcloud_tasks_get_with_http_info(task_id, opts)
  data
end
pcloud_tasks_get_with_http_info(task_id, opts = {}) click to toggle source

Get a task @param task_id [String] PCloud Task ID @param [Hash] opts the optional parameters @return [Array<(Task, Integer, Hash)>] Task data, response status code and response headers

# File lib/ibm_cloud_power/api/p_cloud_tasks_api.rb, line 95
def pcloud_tasks_get_with_http_info(task_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PCloudTasksApi.pcloud_tasks_get ...'
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling PCloudTasksApi.pcloud_tasks_get"
  end
  # resource path
  local_var_path = '/pcloud/v1/tasks/{task_id}'.sub('{' + 'task_id' + '}', CGI.escape(task_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[:body] 

  # return_type
  return_type = opts[:return_type] || 'Task' 

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

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