=begin #Pulp 3 API #Fetch, Upload, Organize, and Distribute Software Packages The version of the OpenAPI document: v3 Contact: pulp-list@redhat.com Generated by: https://openapi-generator.tech OpenAPI Generator version: 4.3.1 =end require 'cgi' module PulpAnsibleClient class ContentCollectionVersionsApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Create a collection version # Trigger an asynchronous task to create content,optionally create new repository version. # @param [Hash] opts the optional parameters # @option opts [String] :upload An uncommitted upload that may be turned into the artifact of the content unit. # @option opts [String] :repository A URI of a repository the new content unit should be associated with. # @option opts [File] :file An uploaded file that may be turned into the artifact of the content unit. # @option opts [String] :artifact Artifact file representing the physical content # @option opts [String] :expected_name The name of the collection. # @option opts [String] :expected_namespace The namespace of the collection. # @option opts [String] :expected_version The version of the collection. # @return [AsyncOperationResponse] def create(opts = {}) data, _status_code, _headers = create_with_http_info(opts) data end # Create a collection version # Trigger an asynchronous task to create content,optionally create new repository version. # @param [Hash] opts the optional parameters # @option opts [String] :upload An uncommitted upload that may be turned into the artifact of the content unit. # @option opts [String] :repository A URI of a repository the new content unit should be associated with. # @option opts [File] :file An uploaded file that may be turned into the artifact of the content unit. # @option opts [String] :artifact Artifact file representing the physical content # @option opts [String] :expected_name The name of the collection. # @option opts [String] :expected_namespace The namespace of the collection. # @option opts [String] :expected_version The version of the collection. # @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers def create_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentCollectionVersionsApi.create ...' end if @api_client.config.client_side_validation && !opts[:'expected_name'].nil? && opts[:'expected_name'].to_s.length > 64 fail ArgumentError, 'invalid value for "opts[:"expected_name"]" when calling ContentCollectionVersionsApi.create, the character length must be smaller than or equal to 64.' end if @api_client.config.client_side_validation && !opts[:'expected_name'].nil? && opts[:'expected_name'].to_s.length < 1 fail ArgumentError, 'invalid value for "opts[:"expected_name"]" when calling ContentCollectionVersionsApi.create, the character length must be great than or equal to 1.' end if @api_client.config.client_side_validation && !opts[:'expected_namespace'].nil? && opts[:'expected_namespace'].to_s.length > 64 fail ArgumentError, 'invalid value for "opts[:"expected_namespace"]" when calling ContentCollectionVersionsApi.create, the character length must be smaller than or equal to 64.' end if @api_client.config.client_side_validation && !opts[:'expected_namespace'].nil? && opts[:'expected_namespace'].to_s.length < 1 fail ArgumentError, 'invalid value for "opts[:"expected_namespace"]" when calling ContentCollectionVersionsApi.create, the character length must be great than or equal to 1.' end if @api_client.config.client_side_validation && !opts[:'expected_version'].nil? && opts[:'expected_version'].to_s.length > 128 fail ArgumentError, 'invalid value for "opts[:"expected_version"]" when calling ContentCollectionVersionsApi.create, the character length must be smaller than or equal to 128.' end if @api_client.config.client_side_validation && !opts[:'expected_version'].nil? && opts[:'expected_version'].to_s.length < 1 fail ArgumentError, 'invalid value for "opts[:"expected_version"]" when calling ContentCollectionVersionsApi.create, the character length must be great than or equal to 1.' end # resource path local_var_path = '/pulp/api/v3/content/ansible/collection_versions/' # 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['upload'] = opts[:'upload'] if !opts[:'upload'].nil? form_params['repository'] = opts[:'repository'] if !opts[:'repository'].nil? form_params['file'] = opts[:'file'] if !opts[:'file'].nil? form_params['artifact'] = opts[:'artifact'] if !opts[:'artifact'].nil? form_params['expected_name'] = opts[:'expected_name'] if !opts[:'expected_name'].nil? form_params['expected_namespace'] = opts[:'expected_namespace'] if !opts[:'expected_namespace'].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: ContentCollectionVersionsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # List collection versions # ViewSet for Ansible Collection. # @param [Hash] opts the optional parameters # @option opts [Boolean] :is_highest # @option opts [Integer] :limit Number of results to return per page. # @option opts [String] :name # @option opts [String] :namespace # @option opts [Integer] :offset The initial index from which to return the results. # @option opts [Array] :ordering Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `authors` - Authors * `-authors` - Authors (descending) * `contents` - Contents * `-contents` - Contents (descending) * `dependencies` - Dependencies * `-dependencies` - Dependencies (descending) * `description` - Description * `-description` - Description (descending) * `docs_blob` - Docs blob * `-docs_blob` - Docs blob (descending) * `manifest` - Manifest * `-manifest` - Manifest (descending) * `files` - Files * `-files` - Files (descending) * `documentation` - Documentation * `-documentation` - Documentation (descending) * `homepage` - Homepage * `-homepage` - Homepage (descending) * `issues` - Issues * `-issues` - Issues (descending) * `license` - License * `-license` - License (descending) * `name` - Name * `-name` - Name (descending) * `namespace` - Namespace * `-namespace` - Namespace (descending) * `repository` - Repository * `-repository` - Repository (descending) * `requires_ansible` - Requires ansible * `-requires_ansible` - Requires ansible (descending) * `version` - Version * `-version` - Version (descending) * `version_major` - Version major * `-version_major` - Version major (descending) * `version_minor` - Version minor * `-version_minor` - Version minor (descending) * `version_patch` - Version patch * `-version_patch` - Version patch (descending) * `version_prerelease` - Version prerelease * `-version_prerelease` - Version prerelease (descending) * `is_highest` - Is highest * `-is_highest` - Is highest (descending) * `search_vector` - Search vector * `-search_vector` - Search vector (descending) * `pk` - Pk * `-pk` - Pk (descending) # @option opts [Array] :pulp_href__in Multiple values may be separated by commas. # @option opts [Array] :pulp_id__in Multiple values may be separated by commas. # @option opts [String] :q # @option opts [String] :repository_version Repository Version referenced by HREF # @option opts [String] :repository_version_added Repository Version referenced by HREF # @option opts [String] :repository_version_removed Repository Version referenced by HREF # @option opts [String] :tags Filter by comma separate list of tags that must all be matched # @option opts [String] :version Filter results where version matches value # @option opts [Array] :fields A list of fields to include in the response. # @option opts [Array] :exclude_fields A list of fields to exclude from the response. # @return [PaginatedansibleCollectionVersionResponseList] def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end # List collection versions # ViewSet for Ansible Collection. # @param [Hash] opts the optional parameters # @option opts [Boolean] :is_highest # @option opts [Integer] :limit Number of results to return per page. # @option opts [String] :name # @option opts [String] :namespace # @option opts [Integer] :offset The initial index from which to return the results. # @option opts [Array] :ordering Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `authors` - Authors * `-authors` - Authors (descending) * `contents` - Contents * `-contents` - Contents (descending) * `dependencies` - Dependencies * `-dependencies` - Dependencies (descending) * `description` - Description * `-description` - Description (descending) * `docs_blob` - Docs blob * `-docs_blob` - Docs blob (descending) * `manifest` - Manifest * `-manifest` - Manifest (descending) * `files` - Files * `-files` - Files (descending) * `documentation` - Documentation * `-documentation` - Documentation (descending) * `homepage` - Homepage * `-homepage` - Homepage (descending) * `issues` - Issues * `-issues` - Issues (descending) * `license` - License * `-license` - License (descending) * `name` - Name * `-name` - Name (descending) * `namespace` - Namespace * `-namespace` - Namespace (descending) * `repository` - Repository * `-repository` - Repository (descending) * `requires_ansible` - Requires ansible * `-requires_ansible` - Requires ansible (descending) * `version` - Version * `-version` - Version (descending) * `version_major` - Version major * `-version_major` - Version major (descending) * `version_minor` - Version minor * `-version_minor` - Version minor (descending) * `version_patch` - Version patch * `-version_patch` - Version patch (descending) * `version_prerelease` - Version prerelease * `-version_prerelease` - Version prerelease (descending) * `is_highest` - Is highest * `-is_highest` - Is highest (descending) * `search_vector` - Search vector * `-search_vector` - Search vector (descending) * `pk` - Pk * `-pk` - Pk (descending) # @option opts [Array] :pulp_href__in Multiple values may be separated by commas. # @option opts [Array] :pulp_id__in Multiple values may be separated by commas. # @option opts [String] :q # @option opts [String] :repository_version Repository Version referenced by HREF # @option opts [String] :repository_version_added Repository Version referenced by HREF # @option opts [String] :repository_version_removed Repository Version referenced by HREF # @option opts [String] :tags Filter by comma separate list of tags that must all be matched # @option opts [String] :version Filter results where version matches value # @option opts [Array] :fields A list of fields to include in the response. # @option opts [Array] :exclude_fields A list of fields to exclude from the response. # @return [Array<(PaginatedansibleCollectionVersionResponseList, Integer, Hash)>] PaginatedansibleCollectionVersionResponseList data, response status code and response headers def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentCollectionVersionsApi.list ...' end allowable_values = ["-authors", "-contents", "-dependencies", "-description", "-docs_blob", "-documentation", "-files", "-homepage", "-is_highest", "-issues", "-license", "-manifest", "-name", "-namespace", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-pulp_type", "-repository", "-requires_ansible", "-search_vector", "-timestamp_of_interest", "-upstream_id", "-version", "-version_major", "-version_minor", "-version_patch", "-version_prerelease", "authors", "contents", "dependencies", "description", "docs_blob", "documentation", "files", "homepage", "is_highest", "issues", "license", "manifest", "name", "namespace", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "pulp_type", "repository", "requires_ansible", "search_vector", "timestamp_of_interest", "upstream_id", "version", "version_major", "version_minor", "version_patch", "version_prerelease"] if @api_client.config.client_side_validation && opts[:'ordering'] && !opts[:'ordering'].all? { |item| allowable_values.include?(item) } fail ArgumentError, "invalid value for \"ordering\", must include one of #{allowable_values}" end # resource path local_var_path = '/pulp/api/v3/content/ansible/collection_versions/' # query parameters query_params = opts[:query_params] || {} query_params[:'is_highest'] = opts[:'is_highest'] if !opts[:'is_highest'].nil? 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'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil? query_params[:'pulp_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__in'].nil? query_params[:'pulp_id__in'] = @api_client.build_collection_param(opts[:'pulp_id__in'], :csv) if !opts[:'pulp_id__in'].nil? query_params[:'q'] = opts[:'q'] if !opts[:'q'].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[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil? query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil? query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil? query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) 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] || 'PaginatedansibleCollectionVersionResponseList' # 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: ContentCollectionVersionsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Inspect a collection version # ViewSet for Ansible Collection. # @param ansible_collection_version_href [String] # @param [Hash] opts the optional parameters # @option opts [Array] :fields A list of fields to include in the response. # @option opts [Array] :exclude_fields A list of fields to exclude from the response. # @return [AnsibleCollectionVersionResponse] def read(ansible_collection_version_href, opts = {}) data, _status_code, _headers = read_with_http_info(ansible_collection_version_href, opts) data end # Inspect a collection version # ViewSet for Ansible Collection. # @param ansible_collection_version_href [String] # @param [Hash] opts the optional parameters # @option opts [Array] :fields A list of fields to include in the response. # @option opts [Array] :exclude_fields A list of fields to exclude from the response. # @return [Array<(AnsibleCollectionVersionResponse, Integer, Hash)>] AnsibleCollectionVersionResponse data, response status code and response headers def read_with_http_info(ansible_collection_version_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentCollectionVersionsApi.read ...' end # verify the required parameter 'ansible_collection_version_href' is set if @api_client.config.client_side_validation && ansible_collection_version_href.nil? fail ArgumentError, "Missing the required parameter 'ansible_collection_version_href' when calling ContentCollectionVersionsApi.read" end # resource path local_var_path = '{ansible_collection_version_href}'.sub('{' + 'ansible_collection_version_href' + '}', CGI.escape(ansible_collection_version_href.to_s).gsub('%2F', '/')) # query parameters query_params = opts[:query_params] || {} query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil? query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) 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] || 'AnsibleCollectionVersionResponse' # 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: ContentCollectionVersionsApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end