class PulpAnsibleClient::RepositoriesAnsibleApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

create(data, opts = {}) click to toggle source

Create an ansible repository ViewSet for Ansible Remotes. @param data [AnsibleAnsibleRepository] @param [Hash] opts the optional parameters @return [AnsibleAnsibleRepository]

# File lib/pulp_ansible_client/api/repositories_ansible_api.rb, line 27
def create(data, opts = {})
  data, _status_code, _headers = create_with_http_info(data, opts)
  data
end
create_with_http_info(data, opts = {}) click to toggle source

Create an ansible repository ViewSet for Ansible Remotes. @param data [AnsibleAnsibleRepository] @param [Hash] opts the optional parameters @return [Array<(AnsibleAnsibleRepository, Integer, Hash)>] AnsibleAnsibleRepository data, response status code and response headers

# File lib/pulp_ansible_client/api/repositories_ansible_api.rb, line 37
def create_with_http_info(data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesAnsibleApi.create ...'
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling RepositoriesAnsibleApi.create"
  end
  # resource path
  local_var_path = '/pulp/api/v3/repositories/ansible/ansible/'

  # 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(data) 

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

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

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

Delete an ansible repository Trigger an asynchronous delete task @param ansible_repository_href [String] URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/ @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_ansible_client/api/repositories_ansible_api.rb, line 91
def delete(ansible_repository_href, opts = {})
  data, _status_code, _headers = delete_with_http_info(ansible_repository_href, opts)
  data
end
delete_with_http_info(ansible_repository_href, opts = {}) click to toggle source

Delete an ansible repository Trigger an asynchronous delete task @param ansible_repository_href [String] URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/ @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulp_ansible_client/api/repositories_ansible_api.rb, line 101
def delete_with_http_info(ansible_repository_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesAnsibleApi.delete ...'
  end
  # verify the required parameter 'ansible_repository_href' is set
  if @api_client.config.client_side_validation && ansible_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_repository_href' when calling RepositoriesAnsibleApi.delete"
  end
  # resource path
  local_var_path = '{ansible_repository_href}'.sub('{' + 'ansible_repository_href' + '}', CGI.escape(ansible_repository_href.to_s).gsub('%2F', '/'))

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

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

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

List ansible repositorys ViewSet for Ansible Remotes. @param [Hash] opts the optional parameters @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :name @option opts [String] :name__in Filter results where name is in a comma-separated list of values @option opts [Integer] :limit Number of results to return per page. @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [InlineResponse2007]

# File lib/pulp_ansible_client/api/repositories_ansible_api.rb, line 159
def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end
list_with_http_info(opts = {}) click to toggle source

List ansible repositorys ViewSet for Ansible Remotes. @param [Hash] opts the optional parameters @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :name @option opts [String] :name__in Filter results where name is in a comma-separated list of values @option opts [Integer] :limit Number of results to return per page. @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(InlineResponse2007, Integer, Hash)>] InlineResponse2007 data, response status code and response headers

# File lib/pulp_ansible_client/api/repositories_ansible_api.rb, line 175
def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesAnsibleApi.list ...'
  end
  # resource path
  local_var_path = '/pulp/api/v3/repositories/ansible/ansible/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__in'] = opts[:'name__in'] if !opts[:'name__in'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].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] || 'InlineResponse2007' 

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

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

Modify Repository Content Trigger an asynchronous task to create a new repository version. @param ansible_repository_href [String] URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/ @param data [RepositoryAddRemoveContent] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_ansible_client/api/repositories_ansible_api.rb, line 231
def modify(ansible_repository_href, data, opts = {})
  data, _status_code, _headers = modify_with_http_info(ansible_repository_href, data, opts)
  data
end
modify_with_http_info(ansible_repository_href, data, opts = {}) click to toggle source

Modify Repository Content Trigger an asynchronous task to create a new repository version. @param ansible_repository_href [String] URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/ @param data [RepositoryAddRemoveContent] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulp_ansible_client/api/repositories_ansible_api.rb, line 242
def modify_with_http_info(ansible_repository_href, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesAnsibleApi.modify ...'
  end
  # verify the required parameter 'ansible_repository_href' is set
  if @api_client.config.client_side_validation && ansible_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_repository_href' when calling RepositoriesAnsibleApi.modify"
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling RepositoriesAnsibleApi.modify"
  end
  # resource path
  local_var_path = '{ansible_repository_href}modify/'.sub('{' + 'ansible_repository_href' + '}', CGI.escape(ansible_repository_href.to_s).gsub('%2F', '/'))

  # 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(data) 

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

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

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

Partially update an ansible repository Trigger an asynchronous partial update task @param ansible_repository_href [String] URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/ @param data [AnsibleAnsibleRepository] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_ansible_client/api/repositories_ansible_api.rb, line 301
def partial_update(ansible_repository_href, data, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(ansible_repository_href, data, opts)
  data
end
partial_update_with_http_info(ansible_repository_href, data, opts = {}) click to toggle source

Partially update an ansible repository Trigger an asynchronous partial update task @param ansible_repository_href [String] URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/ @param data [AnsibleAnsibleRepository] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulp_ansible_client/api/repositories_ansible_api.rb, line 312
def partial_update_with_http_info(ansible_repository_href, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesAnsibleApi.partial_update ...'
  end
  # verify the required parameter 'ansible_repository_href' is set
  if @api_client.config.client_side_validation && ansible_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_repository_href' when calling RepositoriesAnsibleApi.partial_update"
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling RepositoriesAnsibleApi.partial_update"
  end
  # resource path
  local_var_path = '{ansible_repository_href}'.sub('{' + 'ansible_repository_href' + '}', CGI.escape(ansible_repository_href.to_s).gsub('%2F', '/'))

  # 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(data) 

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

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

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

Inspect an ansible repository ViewSet for Ansible Remotes. @param ansible_repository_href [String] URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/ @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [AnsibleAnsibleRepository]

# File lib/pulp_ansible_client/api/repositories_ansible_api.rb, line 372
def read(ansible_repository_href, opts = {})
  data, _status_code, _headers = read_with_http_info(ansible_repository_href, opts)
  data
end
read_with_http_info(ansible_repository_href, opts = {}) click to toggle source

Inspect an ansible repository ViewSet for Ansible Remotes. @param ansible_repository_href [String] URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/ @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @return [Array<(AnsibleAnsibleRepository, Integer, Hash)>] AnsibleAnsibleRepository data, response status code and response headers

# File lib/pulp_ansible_client/api/repositories_ansible_api.rb, line 384
def read_with_http_info(ansible_repository_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesAnsibleApi.read ...'
  end
  # verify the required parameter 'ansible_repository_href' is set
  if @api_client.config.client_side_validation && ansible_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_repository_href' when calling RepositoriesAnsibleApi.read"
  end
  # resource path
  local_var_path = '{ansible_repository_href}'.sub('{' + 'ansible_repository_href' + '}', CGI.escape(ansible_repository_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].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] || 'AnsibleAnsibleRepository' 

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

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

Trigger an asynchronous task to sync Ansible content. @param ansible_repository_href [String] URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/ @param data [RepositorySyncURL] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_ansible_client/api/repositories_ansible_api.rb, line 438
def sync(ansible_repository_href, data, opts = {})
  data, _status_code, _headers = sync_with_http_info(ansible_repository_href, data, opts)
  data
end
sync_with_http_info(ansible_repository_href, data, opts = {}) click to toggle source

Trigger an asynchronous task to sync Ansible content. @param ansible_repository_href [String] URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/ @param data [RepositorySyncURL] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulp_ansible_client/api/repositories_ansible_api.rb, line 448
def sync_with_http_info(ansible_repository_href, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesAnsibleApi.sync ...'
  end
  # verify the required parameter 'ansible_repository_href' is set
  if @api_client.config.client_side_validation && ansible_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_repository_href' when calling RepositoriesAnsibleApi.sync"
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling RepositoriesAnsibleApi.sync"
  end
  # resource path
  local_var_path = '{ansible_repository_href}sync/'.sub('{' + 'ansible_repository_href' + '}', CGI.escape(ansible_repository_href.to_s).gsub('%2F', '/'))

  # 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(data) 

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

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

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

Update an ansible repository Trigger an asynchronous update task @param ansible_repository_href [String] URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/ @param data [AnsibleAnsibleRepository] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_ansible_client/api/repositories_ansible_api.rb, line 507
def update(ansible_repository_href, data, opts = {})
  data, _status_code, _headers = update_with_http_info(ansible_repository_href, data, opts)
  data
end
update_with_http_info(ansible_repository_href, data, opts = {}) click to toggle source

Update an ansible repository Trigger an asynchronous update task @param ansible_repository_href [String] URI of Ansible Repository. e.g.: /pulp/api/v3/repositories/ansible/ansible/1/ @param data [AnsibleAnsibleRepository] @param [Hash] opts the optional parameters @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulp_ansible_client/api/repositories_ansible_api.rb, line 518
def update_with_http_info(ansible_repository_href, data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RepositoriesAnsibleApi.update ...'
  end
  # verify the required parameter 'ansible_repository_href' is set
  if @api_client.config.client_side_validation && ansible_repository_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_repository_href' when calling RepositoriesAnsibleApi.update"
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling RepositoriesAnsibleApi.update"
  end
  # resource path
  local_var_path = '{ansible_repository_href}'.sub('{' + 'ansible_repository_href' + '}', CGI.escape(ansible_repository_href.to_s).gsub('%2F', '/'))

  # 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(data) 

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

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

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