class Nodeum::MetadataApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

index_file_metadata_definitions(opts = {}) click to toggle source

List file metadata definitions **API Key Scope**: file_metadata_definitions / index @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. @return [FileMetadataDefinitionCollection]

# File lib/nodeum_sdk/api/metadata_api.rb, line 28
def index_file_metadata_definitions(opts = {})
  data, _status_code, _headers = index_file_metadata_definitions_with_http_info(opts)
  data
end
index_file_metadata_definitions_with_http_info(opts = {}) click to toggle source

List file metadata definitions **API Key Scope**: file_metadata_definitions / index @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. @return [Array<(FileMetadataDefinitionCollection, Integer, Hash)>] FileMetadataDefinitionCollection data, response status code and response headers

# File lib/nodeum_sdk/api/metadata_api.rb, line 39
def index_file_metadata_definitions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetadataApi.index_file_metadata_definitions ...'
  end
  # resource path
  local_var_path = '/file_metadata_definitions'

  # 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?

  # 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] || 'FileMetadataDefinitionCollection' 

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

List task metadata definitions **API Key Scope**: task_metadata_definitions / index @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. @return [TaskMetadataDefinitionCollection]

# File lib/nodeum_sdk/api/metadata_api.rb, line 90
def index_task_metadata_definitions(opts = {})
  data, _status_code, _headers = index_task_metadata_definitions_with_http_info(opts)
  data
end
index_task_metadata_definitions_with_http_info(opts = {}) click to toggle source

List task metadata definitions **API Key Scope**: task_metadata_definitions / index @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. @return [Array<(TaskMetadataDefinitionCollection, Integer, Hash)>] TaskMetadataDefinitionCollection data, response status code and response headers

# File lib/nodeum_sdk/api/metadata_api.rb, line 101
def index_task_metadata_definitions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetadataApi.index_task_metadata_definitions ...'
  end
  # resource path
  local_var_path = '/task_metadata_definitions'

  # 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?

  # 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] || 'TaskMetadataDefinitionCollection' 

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

Displays a specific task metadata definition. **API Key Scope**: file_metadata_definitions / show @param metadata_definition_id [String] Numeric ID or key of a metadata definition @param [Hash] opts the optional parameters @return [FileMetadataDefinition]

# File lib/nodeum_sdk/api/metadata_api.rb, line 151
def show_file_metadata_definition(metadata_definition_id, opts = {})
  data, _status_code, _headers = show_file_metadata_definition_with_http_info(metadata_definition_id, opts)
  data
end
show_file_metadata_definition_with_http_info(metadata_definition_id, opts = {}) click to toggle source

Displays a specific task metadata definition. **API Key Scope**: file_metadata_definitions / show @param metadata_definition_id [String] Numeric ID or key of a metadata definition @param [Hash] opts the optional parameters @return [Array<(FileMetadataDefinition, Integer, Hash)>] FileMetadataDefinition data, response status code and response headers

# File lib/nodeum_sdk/api/metadata_api.rb, line 161
def show_file_metadata_definition_with_http_info(metadata_definition_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetadataApi.show_file_metadata_definition ...'
  end
  # verify the required parameter 'metadata_definition_id' is set
  if @api_client.config.client_side_validation && metadata_definition_id.nil?
    fail ArgumentError, "Missing the required parameter 'metadata_definition_id' when calling MetadataApi.show_file_metadata_definition"
  end
  # resource path
  local_var_path = '/file_metadata_definitions/{metadata_definition_id}'.sub('{' + 'metadata_definition_id' + '}', CGI.escape(metadata_definition_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] || 'FileMetadataDefinition' 

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

Displays a specific task metadata definition. **API Key Scope**: task_metadata_definitions / show @param metadata_definition_id [String] Numeric ID or key of a metadata definition @param [Hash] opts the optional parameters @return [TaskMetadataDefinition]

# File lib/nodeum_sdk/api/metadata_api.rb, line 213
def show_task_metadata_definition(metadata_definition_id, opts = {})
  data, _status_code, _headers = show_task_metadata_definition_with_http_info(metadata_definition_id, opts)
  data
end
show_task_metadata_definition_with_http_info(metadata_definition_id, opts = {}) click to toggle source

Displays a specific task metadata definition. **API Key Scope**: task_metadata_definitions / show @param metadata_definition_id [String] Numeric ID or key of a metadata definition @param [Hash] opts the optional parameters @return [Array<(TaskMetadataDefinition, Integer, Hash)>] TaskMetadataDefinition data, response status code and response headers

# File lib/nodeum_sdk/api/metadata_api.rb, line 223
def show_task_metadata_definition_with_http_info(metadata_definition_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetadataApi.show_task_metadata_definition ...'
  end
  # verify the required parameter 'metadata_definition_id' is set
  if @api_client.config.client_side_validation && metadata_definition_id.nil?
    fail ArgumentError, "Missing the required parameter 'metadata_definition_id' when calling MetadataApi.show_task_metadata_definition"
  end
  # resource path
  local_var_path = '/task_metadata_definitions/{metadata_definition_id}'.sub('{' + 'metadata_definition_id' + '}', CGI.escape(metadata_definition_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] || 'TaskMetadataDefinition' 

  # 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: MetadataApi#show_task_metadata_definition\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end