class PulpAnsibleClient::RemotesCollectionApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

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

Create a collection remote ViewSet for Collection Remotes. @param ansible_collection_remote [AnsibleCollectionRemote] @param [Hash] opts the optional parameters @return [AnsibleCollectionRemoteResponse]

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

Create a collection remote ViewSet for Collection Remotes. @param ansible_collection_remote [AnsibleCollectionRemote] @param [Hash] opts the optional parameters @return [Array<(AnsibleCollectionRemoteResponse, Integer, Hash)>] AnsibleCollectionRemoteResponse data, response status code and response headers

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

  # 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', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

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

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

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

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

Delete a collection remote Trigger an asynchronous delete task @param ansible_collection_remote_href [String] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

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

Delete a collection remote Trigger an asynchronous delete task @param ansible_collection_remote_href [String] @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/remotes_collection_api.rb, line 101
def delete_with_http_info(ansible_collection_remote_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesCollectionApi.delete ...'
  end
  # verify the required parameter 'ansible_collection_remote_href' is set
  if @api_client.config.client_side_validation && ansible_collection_remote_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_collection_remote_href' when calling RemotesCollectionApi.delete"
  end
  # resource path
  local_var_path = '{ansible_collection_remote_href}'.sub('{' + 'ansible_collection_remote_href' + '}', CGI.escape(ansible_collection_remote_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] || ['basicAuth']

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

List collection remotes ViewSet for Collection Remotes. @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name name @option opts [String] :name__in name__in @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :pulp_last_updated pulp_last_updated @option opts [String] :pulp_last_updated__gt pulp_last_updated__gt @option opts [String] :pulp_last_updated__gte pulp_last_updated__gte @option opts [String] :pulp_last_updated__lt pulp_last_updated__lt @option opts [String] :pulp_last_updated__lte pulp_last_updated__lte @option opts [String] :pulp_last_updated__range pulp_last_updated__range @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 [InlineResponse2005]

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

List collection remotes ViewSet for Collection Remotes. @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name name @option opts [String] :name__in name__in @option opts [Integer] :offset The initial index from which to return the results. @option opts [String] :ordering Which field to use when ordering the results. @option opts [String] :pulp_last_updated pulp_last_updated @option opts [String] :pulp_last_updated__gt pulp_last_updated__gt @option opts [String] :pulp_last_updated__gte pulp_last_updated__gte @option opts [String] :pulp_last_updated__lt pulp_last_updated__lt @option opts [String] :pulp_last_updated__lte pulp_last_updated__lte @option opts [String] :pulp_last_updated__range pulp_last_updated__range @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<(InlineResponse2005, Integer, Hash)>] InlineResponse2005 data, response status code and response headers

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__in'] = opts[:'name__in'] if !opts[:'name__in'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'pulp_last_updated'] = opts[:'pulp_last_updated'] if !opts[:'pulp_last_updated'].nil?
  query_params[:'pulp_last_updated__gt'] = opts[:'pulp_last_updated__gt'] if !opts[:'pulp_last_updated__gt'].nil?
  query_params[:'pulp_last_updated__gte'] = opts[:'pulp_last_updated__gte'] if !opts[:'pulp_last_updated__gte'].nil?
  query_params[:'pulp_last_updated__lt'] = opts[:'pulp_last_updated__lt'] if !opts[:'pulp_last_updated__lt'].nil?
  query_params[:'pulp_last_updated__lte'] = opts[:'pulp_last_updated__lte'] if !opts[:'pulp_last_updated__lte'].nil?
  query_params[:'pulp_last_updated__range'] = opts[:'pulp_last_updated__range'] if !opts[:'pulp_last_updated__range'].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] || 'InlineResponse2005' 

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

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

Update a collection remote Trigger an asynchronous partial update task @param ansible_collection_remote_href [String] @param patchedansible_collection_remote [PatchedansibleCollectionRemote] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_ansible_client/api/remotes_collection_api.rb, line 249
def partial_update(ansible_collection_remote_href, patchedansible_collection_remote, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(ansible_collection_remote_href, patchedansible_collection_remote, opts)
  data
end
partial_update_with_http_info(ansible_collection_remote_href, patchedansible_collection_remote, opts = {}) click to toggle source

Update a collection remote Trigger an asynchronous partial update task @param ansible_collection_remote_href [String] @param patchedansible_collection_remote [PatchedansibleCollectionRemote] @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/remotes_collection_api.rb, line 260
def partial_update_with_http_info(ansible_collection_remote_href, patchedansible_collection_remote, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesCollectionApi.partial_update ...'
  end
  # verify the required parameter 'ansible_collection_remote_href' is set
  if @api_client.config.client_side_validation && ansible_collection_remote_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_collection_remote_href' when calling RemotesCollectionApi.partial_update"
  end
  # verify the required parameter 'patchedansible_collection_remote' is set
  if @api_client.config.client_side_validation && patchedansible_collection_remote.nil?
    fail ArgumentError, "Missing the required parameter 'patchedansible_collection_remote' when calling RemotesCollectionApi.partial_update"
  end
  # resource path
  local_var_path = '{ansible_collection_remote_href}'.sub('{' + 'ansible_collection_remote_href' + '}', CGI.escape(ansible_collection_remote_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', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

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

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

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

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

Inspect a collection remote ViewSet for Collection Remotes. @param ansible_collection_remote_href [String] @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 [AnsibleCollectionRemoteResponse]

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

Inspect a collection remote ViewSet for Collection Remotes. @param ansible_collection_remote_href [String] @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<(AnsibleCollectionRemoteResponse, Integer, Hash)>] AnsibleCollectionRemoteResponse data, response status code and response headers

# File lib/pulp_ansible_client/api/remotes_collection_api.rb, line 332
def read_with_http_info(ansible_collection_remote_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesCollectionApi.read ...'
  end
  # verify the required parameter 'ansible_collection_remote_href' is set
  if @api_client.config.client_side_validation && ansible_collection_remote_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_collection_remote_href' when calling RemotesCollectionApi.read"
  end
  # resource path
  local_var_path = '{ansible_collection_remote_href}'.sub('{' + 'ansible_collection_remote_href' + '}', CGI.escape(ansible_collection_remote_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] || 'AnsibleCollectionRemoteResponse' 

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

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

Update a collection remote Trigger an asynchronous update task @param ansible_collection_remote_href [String] @param ansible_collection_remote [AnsibleCollectionRemote] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_ansible_client/api/remotes_collection_api.rb, line 387
def update(ansible_collection_remote_href, ansible_collection_remote, opts = {})
  data, _status_code, _headers = update_with_http_info(ansible_collection_remote_href, ansible_collection_remote, opts)
  data
end
update_with_http_info(ansible_collection_remote_href, ansible_collection_remote, opts = {}) click to toggle source

Update a collection remote Trigger an asynchronous update task @param ansible_collection_remote_href [String] @param ansible_collection_remote [AnsibleCollectionRemote] @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/remotes_collection_api.rb, line 398
def update_with_http_info(ansible_collection_remote_href, ansible_collection_remote, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesCollectionApi.update ...'
  end
  # verify the required parameter 'ansible_collection_remote_href' is set
  if @api_client.config.client_side_validation && ansible_collection_remote_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_collection_remote_href' when calling RemotesCollectionApi.update"
  end
  # verify the required parameter 'ansible_collection_remote' is set
  if @api_client.config.client_side_validation && ansible_collection_remote.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_collection_remote' when calling RemotesCollectionApi.update"
  end
  # resource path
  local_var_path = '{ansible_collection_remote_href}'.sub('{' + 'ansible_collection_remote_href' + '}', CGI.escape(ansible_collection_remote_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', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

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

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

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

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