class Nodeum::TaskMetadataApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

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

Creates a new task metadatum. **API Key Scope**: task_metadata / create @param task_id [String] Numeric ID or name of task. Task names are not unique, it's recommanded to use numeric ID. @param task_metadatum_body [TaskMetadatum] @param [Hash] opts the optional parameters @return [TaskMetadatum]

# File lib/nodeum_sdk/api/task_metadata_api.rb, line 28
def create_task_metadatum(task_id, task_metadatum_body, opts = {})
  data, _status_code, _headers = create_task_metadatum_with_http_info(task_id, task_metadatum_body, opts)
  data
end
create_task_metadatum_with_http_info(task_id, task_metadatum_body, opts = {}) click to toggle source

Creates a new task metadatum. **API Key Scope**: task_metadata / create @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param task_metadatum_body [TaskMetadatum] @param [Hash] opts the optional parameters @return [Array<(TaskMetadatum, Integer, Hash)>] TaskMetadatum data, response status code and response headers

# File lib/nodeum_sdk/api/task_metadata_api.rb, line 39
def create_task_metadatum_with_http_info(task_id, task_metadatum_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaskMetadataApi.create_task_metadatum ...'
  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 TaskMetadataApi.create_task_metadatum"
  end
  # verify the required parameter 'task_metadatum_body' is set
  if @api_client.config.client_side_validation && task_metadatum_body.nil?
    fail ArgumentError, "Missing the required parameter 'task_metadatum_body' when calling TaskMetadataApi.create_task_metadatum"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/task_metadata'.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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(task_metadatum_body) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaskMetadataApi#create_task_metadatum\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
destroy_task_metadatum(task_id, task_metadatum_id, opts = {}) click to toggle source

Destroys a specific task metadatum. **API Key Scope**: task_metadata / destroy @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param task_metadatum_id [Integer] Numeric ID of task metadatum. @param [Hash] opts the optional parameters @return [nil]

# File lib/nodeum_sdk/api/task_metadata_api.rb, line 98
def destroy_task_metadatum(task_id, task_metadatum_id, opts = {})
  destroy_task_metadatum_with_http_info(task_id, task_metadatum_id, opts)
  nil
end
destroy_task_metadatum_with_http_info(task_id, task_metadatum_id, opts = {}) click to toggle source

Destroys a specific task metadatum. **API Key Scope**: task_metadata / destroy @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param task_metadatum_id [Integer] Numeric ID of task metadatum. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

# File lib/nodeum_sdk/api/task_metadata_api.rb, line 109
def destroy_task_metadatum_with_http_info(task_id, task_metadatum_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaskMetadataApi.destroy_task_metadatum ...'
  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 TaskMetadataApi.destroy_task_metadatum"
  end
  # verify the required parameter 'task_metadatum_id' is set
  if @api_client.config.client_side_validation && task_metadatum_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_metadatum_id' when calling TaskMetadataApi.destroy_task_metadatum"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/task_metadata/{task_metadatum_id}'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s)).sub('{' + 'task_metadatum_id' + '}', CGI.escape(task_metadatum_id.to_s))

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

  # header parameters
  header_params = opts[:header_params] || {}

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

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

  # return_type
  return_type = opts[:return_type] 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

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

Lists all task metadata. **API Key Scope**: task_metadata / index @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;. @option opts [String] :id Filter on id @option opts [String] :key Filter on key @option opts [String] :value Filter on value @return [TaskMetadatumCollection]

# File lib/nodeum_sdk/api/task_metadata_api.rb, line 169
def index_task_metadata(task_id, opts = {})
  data, _status_code, _headers = index_task_metadata_with_http_info(task_id, opts)
  data
end
index_task_metadata_with_http_info(task_id, opts = {}) click to toggle source

Lists all task metadata. **API Key Scope**: task_metadata / index @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param [Hash] opts the optional parameters @option opts [Integer] :limit The number of items to display for pagination. @option opts [Integer] :offset The number of items to skip for pagination. @option opts [Array<String>] :sort_by Sort results by attribute. Can sort on multiple attributes, separated by &#x60;|&#x60;. Order direction can be suffixing the attribute by either &#x60;:asc&#x60; (default) or &#x60;:desc&#x60;. @option opts [String] :id Filter on id @option opts [String] :key Filter on key @option opts [String] :value Filter on value @return [Array<(TaskMetadatumCollection, Integer, Hash)>] TaskMetadatumCollection data, response status code and response headers

# File lib/nodeum_sdk/api/task_metadata_api.rb, line 185
def index_task_metadata_with_http_info(task_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaskMetadataApi.index_task_metadata ...'
  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 TaskMetadataApi.index_task_metadata"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/task_metadata'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sort_by'] = @api_client.build_collection_param(opts[:'sort_by'], :pipe) if !opts[:'sort_by'].nil?
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'key'] = opts[:'key'] if !opts[:'key'].nil?
  query_params[:'value'] = opts[:'value'] if !opts[:'value'].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[:body] 

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

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  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: TaskMetadataApi#index_task_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
show_task_metadatum(task_id, task_metadatum_id, opts = {}) click to toggle source

Displays a specific task metadatum. **API Key Scope**: task_metadata / show @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param task_metadatum_id [Integer] Numeric ID of task metadatum. @param [Hash] opts the optional parameters @return [TaskMetadatum]

# File lib/nodeum_sdk/api/task_metadata_api.rb, line 244
def show_task_metadatum(task_id, task_metadatum_id, opts = {})
  data, _status_code, _headers = show_task_metadatum_with_http_info(task_id, task_metadatum_id, opts)
  data
end
show_task_metadatum_with_http_info(task_id, task_metadatum_id, opts = {}) click to toggle source

Displays a specific task metadatum. **API Key Scope**: task_metadata / show @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param task_metadatum_id [Integer] Numeric ID of task metadatum. @param [Hash] opts the optional parameters @return [Array<(TaskMetadatum, Integer, Hash)>] TaskMetadatum data, response status code and response headers

# File lib/nodeum_sdk/api/task_metadata_api.rb, line 255
def show_task_metadatum_with_http_info(task_id, task_metadatum_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaskMetadataApi.show_task_metadatum ...'
  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 TaskMetadataApi.show_task_metadatum"
  end
  # verify the required parameter 'task_metadatum_id' is set
  if @api_client.config.client_side_validation && task_metadatum_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_metadatum_id' when calling TaskMetadataApi.show_task_metadatum"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/task_metadata/{task_metadatum_id}'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s)).sub('{' + 'task_metadatum_id' + '}', CGI.escape(task_metadatum_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] || 'TaskMetadatum' 

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  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: TaskMetadataApi#show_task_metadatum\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
update_task_metadatum(task_id, task_metadatum_id, task_metadatum_body, opts = {}) click to toggle source

Updates a specific task metadatum. **API Key Scope**: task_metadata / update @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param task_metadatum_id [Integer] Numeric ID of task metadatum. @param task_metadatum_body [TaskMetadatum] @param [Hash] opts the optional parameters @return [TaskMetadatum]

# File lib/nodeum_sdk/api/task_metadata_api.rb, line 313
def update_task_metadatum(task_id, task_metadatum_id, task_metadatum_body, opts = {})
  data, _status_code, _headers = update_task_metadatum_with_http_info(task_id, task_metadatum_id, task_metadatum_body, opts)
  data
end
update_task_metadatum_with_http_info(task_id, task_metadatum_id, task_metadatum_body, opts = {}) click to toggle source

Updates a specific task metadatum. **API Key Scope**: task_metadata / update @param task_id [String] Numeric ID or name of task. Task names are not unique, it&#39;s recommanded to use numeric ID. @param task_metadatum_id [Integer] Numeric ID of task metadatum. @param task_metadatum_body [TaskMetadatum] @param [Hash] opts the optional parameters @return [Array<(TaskMetadatum, Integer, Hash)>] TaskMetadatum data, response status code and response headers

# File lib/nodeum_sdk/api/task_metadata_api.rb, line 325
def update_task_metadatum_with_http_info(task_id, task_metadatum_id, task_metadatum_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TaskMetadataApi.update_task_metadatum ...'
  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 TaskMetadataApi.update_task_metadatum"
  end
  # verify the required parameter 'task_metadatum_id' is set
  if @api_client.config.client_side_validation && task_metadatum_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_metadatum_id' when calling TaskMetadataApi.update_task_metadatum"
  end
  # verify the required parameter 'task_metadatum_body' is set
  if @api_client.config.client_side_validation && task_metadatum_body.nil?
    fail ArgumentError, "Missing the required parameter 'task_metadatum_body' when calling TaskMetadataApi.update_task_metadatum"
  end
  # resource path
  local_var_path = '/tasks/{task_id}/task_metadata/{task_metadatum_id}'.sub('{' + 'task_id' + '}', CGI.escape(task_id.to_s)).sub('{' + 'task_metadatum_id' + '}', CGI.escape(task_metadatum_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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(task_metadatum_body) 

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

  # auth_names
  auth_names = opts[:auth_names] || ['BasicAuth', 'BearerAuth']

  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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TaskMetadataApi#update_task_metadatum\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end