class PulpAnsibleClient::ContentRolesApi
Attributes
Public Class Methods
# File lib/pulp_ansible_client/api/content_roles_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create a role ViewSet for Role. @param ansible_role [AnsibleRole] @param [Hash] opts the optional parameters @return [AnsibleRoleResponse]
# File lib/pulp_ansible_client/api/content_roles_api.rb, line 27 def create(ansible_role, opts = {}) data, _status_code, _headers = create_with_http_info(ansible_role, opts) data end
Create a role ViewSet for Role. @param ansible_role [AnsibleRole] @param [Hash] opts the optional parameters @return [Array<(AnsibleRoleResponse
, Integer, Hash)>] AnsibleRoleResponse
data, response status code and response headers
# File lib/pulp_ansible_client/api/content_roles_api.rb, line 37 def create_with_http_info(ansible_role, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentRolesApi.create ...' end # verify the required parameter 'ansible_role' is set if @api_client.config.client_side_validation && ansible_role.nil? fail ArgumentError, "Missing the required parameter 'ansible_role' when calling ContentRolesApi.create" end # resource path local_var_path = '/pulp/api/v3/content/ansible/roles/' # 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) # return_type return_type = opts[:return_type] || 'AnsibleRoleResponse' # 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: ContentRolesApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List roles ViewSet for Role. @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] :namespace namespace @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] :repository_version repository_version @option opts [String] :repository_version_added repository_version_added @option opts [String] :repository_version_removed repository_version_removed @option opts [String] :version version @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 [PaginatedansibleRoleResponseList]
# File lib/pulp_ansible_client/api/content_roles_api.rb, line 101 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end
List roles ViewSet for Role. @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] :namespace namespace @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] :repository_version repository_version @option opts [String] :repository_version_added repository_version_added @option opts [String] :repository_version_removed repository_version_removed @option opts [String] :version version @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<(PaginatedansibleRoleResponseList
, Integer, Hash)>] PaginatedansibleRoleResponseList
data, response status code and response headers
# File lib/pulp_ansible_client/api/content_roles_api.rb, line 121 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentRolesApi.list ...' end # resource path local_var_path = '/pulp/api/v3/content/ansible/roles/' # 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[:'namespace'] = opts[:'namespace'] if !opts[:'namespace'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'ordering'] = opts[:'ordering'] if !opts[:'ordering'].nil? query_params[:'repository_version'] = opts[:'repository_version'] if !opts[:'repository_version'].nil? query_params[:'repository_version_added'] = opts[:'repository_version_added'] if !opts[:'repository_version_added'].nil? query_params[:'repository_version_removed'] = opts[:'repository_version_removed'] if !opts[:'repository_version_removed'].nil? query_params[:'version'] = opts[:'version'] if !opts[:'version'].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] || 'PaginatedansibleRoleResponseList' # 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: ContentRolesApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Inspect a role ViewSet for Role. @param ansible_role_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 [AnsibleRoleResponse]
# File lib/pulp_ansible_client/api/content_roles_api.rb, line 182 def read(ansible_role_href, opts = {}) data, _status_code, _headers = read_with_http_info(ansible_role_href, opts) data end
Inspect a role ViewSet for Role. @param ansible_role_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<(AnsibleRoleResponse
, Integer, Hash)>] AnsibleRoleResponse
data, response status code and response headers
# File lib/pulp_ansible_client/api/content_roles_api.rb, line 194 def read_with_http_info(ansible_role_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentRolesApi.read ...' end # verify the required parameter 'ansible_role_href' is set if @api_client.config.client_side_validation && ansible_role_href.nil? fail ArgumentError, "Missing the required parameter 'ansible_role_href' when calling ContentRolesApi.read" end # resource path local_var_path = '{ansible_role_href}'.sub('{' + 'ansible_role_href' + '}', CGI.escape(ansible_role_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] || 'AnsibleRoleResponse' # 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: ContentRolesApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end