class PulpcoreClient::DistributionsArtifactsApi
Attributes
Public Class Methods
# File lib/pulpcore_client/api/distributions_artifacts_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
List artifact distributions ViewSet for ArtifactDistribution. @param [Hash] opts the optional parameters @option opts [String] :base_path Filter results where base_path matches value @option opts [String] :base_path__contains Filter results where base_path contains value @option opts [String] :base_path__icontains Filter results where base_path contains value @option opts [Array<String>] :base_path__in Filter results where base_path is in a comma-separated list of values @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name Filter results where name matches value @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 [Array<String>] :ordering Ordering @option opts [String] :pulp_label_select Filter labels by search string @option opts [String] :with_content Filter distributions based on the content served by them @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [PaginatedArtifactDistributionResponseList]
# File lib/pulpcore_client/api/distributions_artifacts_api.rb, line 42 def list(opts = {}) data, _status_code, _headers = list_with_http_info(opts) data end
List artifact distributions ViewSet for ArtifactDistribution. @param [Hash] opts the optional parameters @option opts [String] :base_path Filter results where base_path matches value @option opts [String] :base_path__contains Filter results where base_path contains value @option opts [String] :base_path__icontains Filter results where base_path contains value @option opts [Array<String>] :base_path__in Filter results where base_path is in a comma-separated list of values @option opts [Integer] :limit Number of results to return per page. @option opts [String] :name Filter results where name matches value @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 [Array<String>] :ordering Ordering @option opts [String] :pulp_label_select Filter labels by search string @option opts [String] :with_content Filter distributions based on the content served by them @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [Array<(PaginatedArtifactDistributionResponseList
, Integer, Hash)>] PaginatedArtifactDistributionResponseList
data, response status code and response headers
# File lib/pulpcore_client/api/distributions_artifacts_api.rb, line 67 def list_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsArtifactsApi.list ...' end allowable_values = ["-base_path", "-name", "-pk", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "base_path", "name", "pk", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type"] 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/distributions/core/artifacts/' # query parameters query_params = opts[:query_params] || {} query_params[:'base_path'] = opts[:'base_path'] if !opts[:'base_path'].nil? query_params[:'base_path__contains'] = opts[:'base_path__contains'] if !opts[:'base_path__contains'].nil? query_params[:'base_path__icontains'] = opts[:'base_path__icontains'] if !opts[:'base_path__icontains'].nil? query_params[:'base_path__in'] = @api_client.build_collection_param(opts[:'base_path__in'], :csv) if !opts[:'base_path__in'].nil? 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'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil? query_params[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].nil? query_params[:'with_content'] = opts[:'with_content'] if !opts[:'with_content'].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] || 'PaginatedArtifactDistributionResponseList' # 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: DistributionsArtifactsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Inspect an artifact distribution ViewSet for ArtifactDistribution. @param artifact_distribution_href [String] @param [Hash] opts the optional parameters @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [ArtifactDistributionResponse]
# File lib/pulpcore_client/api/distributions_artifacts_api.rb, line 137 def read(artifact_distribution_href, opts = {}) data, _status_code, _headers = read_with_http_info(artifact_distribution_href, opts) data end
Inspect an artifact distribution ViewSet for ArtifactDistribution. @param artifact_distribution_href [String] @param [Hash] opts the optional parameters @option opts [Array<String>] :fields A list of fields to include in the response. @option opts [Array<String>] :exclude_fields A list of fields to exclude from the response. @return [Array<(ArtifactDistributionResponse
, Integer, Hash)>] ArtifactDistributionResponse
data, response status code and response headers
# File lib/pulpcore_client/api/distributions_artifacts_api.rb, line 149 def read_with_http_info(artifact_distribution_href, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: DistributionsArtifactsApi.read ...' end # verify the required parameter 'artifact_distribution_href' is set if @api_client.config.client_side_validation && artifact_distribution_href.nil? fail ArgumentError, "Missing the required parameter 'artifact_distribution_href' when calling DistributionsArtifactsApi.read" end # resource path local_var_path = '{artifact_distribution_href}'.sub('{' + 'artifact_distribution_href' + '}', CGI.escape(artifact_distribution_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] || 'ArtifactDistributionResponse' # 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: DistributionsArtifactsApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end