class PulpContainerClient::ContentTagsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/pulp_container_client/api/content_tags_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

list(opts = {}) click to toggle source

List tags ViewSet for Tag. @param [Hash] opts the optional parameters @option opts [Array<String>] :digest Multiple values may be separated by commas. @option opts [Integer] :limit Number of results to return per page. @option opts [Array<String>] :media_type @option opts [String] :name Filter results where name matches value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [Integer] :offset The initial index from which to return the results. @option opts [Array<String>] :ordering Ordering @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] :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 [PaginatedcontainerTagResponseList]

# File lib/pulp_container_client/api/content_tags_api.rb, line 38
def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end
list_with_http_info(opts = {}) click to toggle source

List tags ViewSet for Tag. @param [Hash] opts the optional parameters @option opts [Array<String>] :digest Multiple values may be separated by commas. @option opts [Integer] :limit Number of results to return per page. @option opts [Array<String>] :media_type @option opts [String] :name Filter results where name matches value @option opts [Array<String>] :name__in Filter results where name is in a comma-separated list of values @option opts [Integer] :offset The initial index from which to return the results. @option opts [Array<String>] :ordering Ordering @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] :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<(PaginatedcontainerTagResponseList, Integer, Hash)>] PaginatedcontainerTagResponseList data, response status code and response headers

# File lib/pulp_container_client/api/content_tags_api.rb, line 59
def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentTagsApi.list ...'
  end
  allowable_values = ["application/vnd.docker.distribution.manifest.list.v2+json", "application/vnd.docker.distribution.manifest.v1+json", "application/vnd.docker.distribution.manifest.v2+json", "application/vnd.oci.image.index.v1+json", "application/vnd.oci.image.manifest.v1+json"]
  if @api_client.config.client_side_validation && opts[:'media_type'] && !opts[:'media_type'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"media_type\", must include one of #{allowable_values}"
  end
  allowable_values = ["-_artifacts", "-content_ptr", "-contentartifact", "-group_roles", "-name", "-pk", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-repositories", "-tagged_manifest", "-timestamp_of_interest", "-upstream_id", "-user_roles", "-version_memberships", "_artifacts", "content_ptr", "contentartifact", "group_roles", "name", "pk", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "repositories", "tagged_manifest", "timestamp_of_interest", "upstream_id", "user_roles", "version_memberships"]
  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/container/tags/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'digest'] = @api_client.build_collection_param(opts[:'digest'], :csv) if !opts[:'digest'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'media_type'] = @api_client.build_collection_param(opts[:'media_type'], :multi) if !opts[:'media_type'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].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[:'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[:'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] || 'PaginatedcontainerTagResponseList' 

  # 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: ContentTagsApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
read(container_tag_href, opts = {}) click to toggle source

Inspect a tag ViewSet for Tag. @param container_tag_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 [ContainerTagResponse]

# File lib/pulp_container_client/api/content_tags_api.rb, line 129
def read(container_tag_href, opts = {})
  data, _status_code, _headers = read_with_http_info(container_tag_href, opts)
  data
end
read_with_http_info(container_tag_href, opts = {}) click to toggle source

Inspect a tag ViewSet for Tag. @param container_tag_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<(ContainerTagResponse, Integer, Hash)>] ContainerTagResponse data, response status code and response headers

# File lib/pulp_container_client/api/content_tags_api.rb, line 141
def read_with_http_info(container_tag_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentTagsApi.read ...'
  end
  # verify the required parameter 'container_tag_href' is set
  if @api_client.config.client_side_validation && container_tag_href.nil?
    fail ArgumentError, "Missing the required parameter 'container_tag_href' when calling ContentTagsApi.read"
  end
  # resource path
  local_var_path = '{container_tag_href}'.sub('{' + 'container_tag_href' + '}', CGI.escape(container_tag_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] || 'ContainerTagResponse' 

  # 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: ContentTagsApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end