=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 ContentCollectionMarksApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Create a collection version mark # ViewSet for looking at mark objects for CollectionVersion content. # @param ansible_collection_version_mark [AnsibleCollectionVersionMark] # @param [Hash] opts the optional parameters # @return [AnsibleCollectionVersionMarkResponse] def create(ansible_collection_version_mark, opts = {}) data, _status_code, _headers = create_with_http_info(ansible_collection_version_mark, opts) data end # Create a collection version mark # ViewSet for looking at mark objects for CollectionVersion content. # @param ansible_collection_version_mark [AnsibleCollectionVersionMark] # @param [Hash] opts the optional parameters # @return [Array<(AnsibleCollectionVersionMarkResponse, Integer, Hash)>] AnsibleCollectionVersionMarkResponse data, response status code and response headers def create_with_http_info(ansible_collection_version_mark, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentCollectionMarksApi.create ...' end # verify the required parameter 'ansible_collection_version_mark' is set if @api_client.config.client_side_validation && ansible_collection_version_mark.nil? fail ArgumentError, "Missing the required parameter 'ansible_collection_version_mark' when calling ContentCollectionMarksApi.create" end # resource path local_var_path = '/pulp/api/v3/content/ansible/collection_marks/' # 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_version_mark) # return_type return_type = opts[:return_type] || 'AnsibleCollectionVersionMarkResponse' # 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: ContentCollectionMarksApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # List collection version marks # ViewSet for looking at mark objects for CollectionVersion content. # @param [Hash] opts the optional parameters # @option opts [Integer] :limit Number of results to return per page. # @option opts [String] :marked_collection Filter marks for collection version # @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) * `value` - Value * `-value` - Value (descending) * `pk` - Pk * `-pk` - Pk (descending) # @option opts [Float] :orphaned_for Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. # @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] :value Filter marks by value # @option opts [Array] :value__in Filter results where value is in a comma-separated list of values # @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 [PaginatedansibleCollectionVersionMarkResponseList] def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end # List collection version marks # ViewSet for looking at mark objects for CollectionVersion content. # @param [Hash] opts the optional parameters # @option opts [Integer] :limit Number of results to return per page. # @option opts [String] :marked_collection Filter marks for collection version # @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) * `value` - Value * `-value` - Value (descending) * `pk` - Pk * `-pk` - Pk (descending) # @option opts [Float] :orphaned_for Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. # @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] :value Filter marks by value # @option opts [Array] :value__in Filter results where value is in a comma-separated list of values # @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<(PaginatedansibleCollectionVersionMarkResponseList, Integer, Hash)>] PaginatedansibleCollectionVersionMarkResponseList 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: ContentCollectionMarksApi.list ...' end allowable_values = ["-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-pulp_type", "-timestamp_of_interest", "-upstream_id", "-value", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "pulp_type", "timestamp_of_interest", "upstream_id", "value"] 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_marks/' # query parameters query_params = opts[:query_params] || {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'marked_collection'] = opts[:'marked_collection'] if !opts[:'marked_collection'].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[:'orphaned_for'] = opts[:'orphaned_for'] if !opts[:'orphaned_for'].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[:'value'] = opts[:'value'] if !opts[:'value'].nil? query_params[:'value__in'] = @api_client.build_collection_param(opts[:'value__in'], :csv) if !opts[:'value__in'].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] || 'PaginatedansibleCollectionVersionMarkResponseList' # 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: ContentCollectionMarksApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Inspect a collection version mark # ViewSet for looking at mark objects for CollectionVersion content. # @param ansible_collection_version_mark_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 [AnsibleCollectionVersionMarkResponse] def read(ansible_collection_version_mark_href, opts = {}) data, _status_code, _headers = read_with_http_info(ansible_collection_version_mark_href, opts) data end # Inspect a collection version mark # ViewSet for looking at mark objects for CollectionVersion content. # @param ansible_collection_version_mark_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<(AnsibleCollectionVersionMarkResponse, Integer, Hash)>] AnsibleCollectionVersionMarkResponse data, response status code and response headers def read_with_http_info(ansible_collection_version_mark_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: ContentCollectionMarksApi.read ...' end # verify the required parameter 'ansible_collection_version_mark_href' is set if @api_client.config.client_side_validation && ansible_collection_version_mark_href.nil? fail ArgumentError, "Missing the required parameter 'ansible_collection_version_mark_href' when calling ContentCollectionMarksApi.read" end # resource path local_var_path = '{ansible_collection_version_mark_href}'.sub('{' + 'ansible_collection_version_mark_href' + '}', CGI.escape(ansible_collection_version_mark_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] || 'AnsibleCollectionVersionMarkResponse' # 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: ContentCollectionMarksApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end