class PulpAnsibleClient::RemotesRoleApi

Attributes

api_client[RW]

Public Class Methods

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

Public Instance Methods

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

Create a role remote ViewSet for Role Remotes. @param ansible_role_remote [AnsibleRoleRemote] @param [Hash] opts the optional parameters @return [AnsibleRoleRemoteResponse]

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

Create a role remote ViewSet for Role Remotes. @param ansible_role_remote [AnsibleRoleRemote] @param [Hash] opts the optional parameters @return [Array<(AnsibleRoleRemoteResponse, Integer, Hash)>] AnsibleRoleRemoteResponse data, response status code and response headers

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

  # 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_role_remote) 

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

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

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

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

Delete a role remote Trigger an asynchronous delete task @param ansible_role_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_role_api.rb, line 101
def delete_with_http_info(ansible_role_remote_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesRoleApi.delete ...'
  end
  # verify the required parameter 'ansible_role_remote_href' is set
  if @api_client.config.client_side_validation && ansible_role_remote_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_role_remote_href' when calling RemotesRoleApi.delete"
  end
  # resource path
  local_var_path = '{ansible_role_remote_href}'.sub('{' + 'ansible_role_remote_href' + '}', CGI.escape(ansible_role_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: RemotesRoleApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
list(opts = {}) click to toggle source

List role remotes ViewSet for Role Remotes. @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name @option opts [String] :name__contains Filter results where name contains value @option opts [String] :name__icontains Filter results where name contains value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :name__startswith Filter results where name starts with value @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_label_select Filter labels by search string @option opts [DateTime] :pulp_last_updated ISO 8601 formatted dates are supported @option opts [DateTime] :pulp_last_updated__gt Filter results where pulp_last_updated is greater than value @option opts [DateTime] :pulp_last_updated__gte Filter results where pulp_last_updated is greater than or equal to value @option opts [DateTime] :pulp_last_updated__lt Filter results where pulp_last_updated is less than value @option opts [DateTime] :pulp_last_updated__lte Filter results where pulp_last_updated is less than or equal to value @option opts [Array<DateTime>] :pulp_last_updated__range Filter results where pulp_last_updated is between two comma separated values @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 [PaginatedansibleRoleRemoteResponseList]

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

List role remotes ViewSet for Role Remotes. @param [Hash] opts the optional parameters @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name @option opts [String] :name__contains Filter results where name contains value @option opts [String] :name__icontains Filter results where name contains value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [String] :name__startswith Filter results where name starts with value @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_label_select Filter labels by search string @option opts [DateTime] :pulp_last_updated ISO 8601 formatted dates are supported @option opts [DateTime] :pulp_last_updated__gt Filter results where pulp_last_updated is greater than value @option opts [DateTime] :pulp_last_updated__gte Filter results where pulp_last_updated is greater than or equal to value @option opts [DateTime] :pulp_last_updated__lt Filter results where pulp_last_updated is less than value @option opts [DateTime] :pulp_last_updated__lte Filter results where pulp_last_updated is less than or equal to value @option opts [Array<DateTime>] :pulp_last_updated__range Filter results where pulp_last_updated is between two comma separated values @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<(PaginatedansibleRoleRemoteResponseList, Integer, Hash)>] PaginatedansibleRoleRemoteResponseList data, response status code and response headers

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

  # 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__contains'] = opts[:'name__contains'] if !opts[:'name__contains'].nil?
  query_params[:'name__icontains'] = opts[:'name__icontains'] if !opts[:'name__icontains'].nil?
  query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
  query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil?
  query_params[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].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'] = @api_client.build_collection_param(opts[:'pulp_last_updated__range'], :csv) 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] || 'PaginatedansibleRoleRemoteResponseList' 

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

Update a role remote Trigger an asynchronous partial update task @param ansible_role_remote_href [String] @param patchedansible_role_remote [PatchedansibleRoleRemote] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_ansible_client/api/remotes_role_api.rb, line 261
def partial_update(ansible_role_remote_href, patchedansible_role_remote, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(ansible_role_remote_href, patchedansible_role_remote, opts)
  data
end
partial_update_with_http_info(ansible_role_remote_href, patchedansible_role_remote, opts = {}) click to toggle source

Update a role remote Trigger an asynchronous partial update task @param ansible_role_remote_href [String] @param patchedansible_role_remote [PatchedansibleRoleRemote] @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_role_api.rb, line 272
def partial_update_with_http_info(ansible_role_remote_href, patchedansible_role_remote, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesRoleApi.partial_update ...'
  end
  # verify the required parameter 'ansible_role_remote_href' is set
  if @api_client.config.client_side_validation && ansible_role_remote_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_role_remote_href' when calling RemotesRoleApi.partial_update"
  end
  # verify the required parameter 'patchedansible_role_remote' is set
  if @api_client.config.client_side_validation && patchedansible_role_remote.nil?
    fail ArgumentError, "Missing the required parameter 'patchedansible_role_remote' when calling RemotesRoleApi.partial_update"
  end
  # resource path
  local_var_path = '{ansible_role_remote_href}'.sub('{' + 'ansible_role_remote_href' + '}', CGI.escape(ansible_role_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_role_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: RemotesRoleApi#partial_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
read(ansible_role_remote_href, opts = {}) click to toggle source

Inspect a role remote ViewSet for Role Remotes. @param ansible_role_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 [AnsibleRoleRemoteResponse]

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

Inspect a role remote ViewSet for Role Remotes. @param ansible_role_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<(AnsibleRoleRemoteResponse, Integer, Hash)>] AnsibleRoleRemoteResponse data, response status code and response headers

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

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

Update a role remote Trigger an asynchronous update task @param ansible_role_remote_href [String] @param ansible_role_remote [AnsibleRoleRemote] @param [Hash] opts the optional parameters @return [AsyncOperationResponse]

# File lib/pulp_ansible_client/api/remotes_role_api.rb, line 399
def update(ansible_role_remote_href, ansible_role_remote, opts = {})
  data, _status_code, _headers = update_with_http_info(ansible_role_remote_href, ansible_role_remote, opts)
  data
end
update_with_http_info(ansible_role_remote_href, ansible_role_remote, opts = {}) click to toggle source

Update a role remote Trigger an asynchronous update task @param ansible_role_remote_href [String] @param ansible_role_remote [AnsibleRoleRemote] @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_role_api.rb, line 410
def update_with_http_info(ansible_role_remote_href, ansible_role_remote, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RemotesRoleApi.update ...'
  end
  # verify the required parameter 'ansible_role_remote_href' is set
  if @api_client.config.client_side_validation && ansible_role_remote_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_role_remote_href' when calling RemotesRoleApi.update"
  end
  # verify the required parameter 'ansible_role_remote' is set
  if @api_client.config.client_side_validation && ansible_role_remote.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_role_remote' when calling RemotesRoleApi.update"
  end
  # resource path
  local_var_path = '{ansible_role_remote_href}'.sub('{' + 'ansible_role_remote_href' + '}', CGI.escape(ansible_role_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_role_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: RemotesRoleApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end