class PulpAnsibleClient::AnsibleCollectionsApi
Attributes
Public Class Methods
# File lib/pulp_ansible_client/api/ansible_collections_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
List collections Viewset for Ansible Collections. @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] :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 [PaginatedansibleCollectionResponseList]
# File lib/pulp_ansible_client/api/ansible_collections_api.rb, line 33 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end
List collections Viewset for Ansible Collections. @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] :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<(PaginatedansibleCollectionResponseList
, Integer, Hash)>] PaginatedansibleCollectionResponseList
data, response status code and response headers
# File lib/pulp_ansible_client/api/ansible_collections_api.rb, line 49 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AnsibleCollectionsApi.list ...' end # resource path local_var_path = '/pulp/api/v3/ansible/collections/' # 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[:'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] || 'PaginatedansibleCollectionResponseList' # 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: AnsibleCollectionsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Upload a collection Create an artifact and trigger an asynchronous task to create Collection content from it. @param file [File] The Collection tarball. @param [Hash] opts the optional parameters @option opts [String] :sha256 An optional sha256 checksum of the uploaded file. @option opts [String] :expected_namespace The expected 'namespace' of the Collection to be verified against the metadata during import. @option opts [String] :expected_name The expected 'name' of the Collection to be verified against the metadata during import. @option opts [String] :expected_version The expected version of the Collection to be verified against the metadata during import. @return [AsyncOperationResponse]
# File lib/pulp_ansible_client/api/ansible_collections_api.rb, line 108 def upload_collection(file, opts = {}) data, _status_code, _headers = upload_collection_with_http_info(file, opts) data end
Upload a collection Create an artifact and trigger an asynchronous task to create Collection content from it. @param file [File] The Collection tarball. @param [Hash] opts the optional parameters @option opts [String] :sha256 An optional sha256 checksum of the uploaded file. @option opts [String] :expected_namespace The expected 'namespace' of the Collection to be verified against the metadata during import. @option opts [String] :expected_name The expected 'name' of the Collection to be verified against the metadata during import. @option opts [String] :expected_version The expected version of the Collection to be verified against the metadata during import. @return [Array<(AsyncOperationResponse
, Integer, Hash)>] AsyncOperationResponse
data, response status code and response headers
# File lib/pulp_ansible_client/api/ansible_collections_api.rb, line 122 def upload_collection_with_http_info(file, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AnsibleCollectionsApi.upload_collection ...' end # verify the required parameter 'file' is set if @api_client.config.client_side_validation && file.nil? fail ArgumentError, "Missing the required parameter 'file' when calling AnsibleCollectionsApi.upload_collection" end # resource path local_var_path = '/ansible/collections/' # 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(['multipart/form-data', 'application/x-www-form-urlencoded']) # form parameters form_params = opts[:form_params] || {} form_params['file'] = file form_params['sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil? form_params['expected_namespace'] = opts[:'expected_namespace'] if !opts[:'expected_namespace'].nil? form_params['expected_name'] = opts[:'expected_name'] if !opts[:'expected_name'].nil? form_params['expected_version'] = opts[:'expected_version'] if !opts[:'expected_version'].nil? # 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(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: AnsibleCollectionsApi#upload_collection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end