class PulpContainerClient::ContentSignaturesApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/pulp_container_client/api/content_signatures_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 manifest signatures ViewSet for image signatures. @param [Hash] opts the optional parameters @option opts [String] :digest Filter results where digest matches value @option opts [Array<String>] :digest__in Filter results where digest is in a comma-separated list of values @option opts [String] :key_id Filter results where key_id matches value @option opts [Array<String>] :key_id__in Filter results where key_id is in a comma-separated list of values @option opts [Integer] :limit Number of results to return per page. @option opts [Array<String>] :manifest Multiple values may be separated by commas. @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 [String] :name__iexact 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 [String] :name__istartswith Filter results where name starts with value @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 * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;digest&#x60; - Digest * &#x60;-digest&#x60; - Digest (descending) * &#x60;type&#x60; - Type * &#x60;-type&#x60; - Type (descending) * &#x60;key_id&#x60; - Key id * &#x60;-key_id&#x60; - Key id (descending) * &#x60;timestamp&#x60; - Timestamp * &#x60;-timestamp&#x60; - Timestamp (descending) * &#x60;creator&#x60; - Creator * &#x60;-creator&#x60; - Creator (descending) * &#x60;data&#x60; - Data * &#x60;-data&#x60; - Data (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas. @option opts [Array<String>] :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 [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 [PaginatedcontainerManifestSignatureResponseList]

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

List manifest signatures ViewSet for image signatures. @param [Hash] opts the optional parameters @option opts [String] :digest Filter results where digest matches value @option opts [Array<String>] :digest__in Filter results where digest is in a comma-separated list of values @option opts [String] :key_id Filter results where key_id matches value @option opts [Array<String>] :key_id__in Filter results where key_id is in a comma-separated list of values @option opts [Integer] :limit Number of results to return per page. @option opts [Array<String>] :manifest Multiple values may be separated by commas. @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 [String] :name__iexact 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 [String] :name__istartswith Filter results where name starts with value @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 * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;digest&#x60; - Digest * &#x60;-digest&#x60; - Digest (descending) * &#x60;type&#x60; - Type * &#x60;-type&#x60; - Type (descending) * &#x60;key_id&#x60; - Key id * &#x60;-key_id&#x60; - Key id (descending) * &#x60;timestamp&#x60; - Timestamp * &#x60;-timestamp&#x60; - Timestamp (descending) * &#x60;creator&#x60; - Creator * &#x60;-creator&#x60; - Creator (descending) * &#x60;data&#x60; - Data * &#x60;-data&#x60; - Data (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending) @option opts [Array<String>] :pulp_href__in Multiple values may be separated by commas. @option opts [Array<String>] :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 [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<(PaginatedcontainerManifestSignatureResponseList, Integer, Hash)>] PaginatedcontainerManifestSignatureResponseList data, response status code and response headers

# File lib/pulp_container_client/api/content_signatures_api.rb, line 81
def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentSignaturesApi.list ...'
  end
  allowable_values = ["-creator", "-data", "-digest", "-key_id", "-name", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-pulp_type", "-timestamp", "-timestamp_of_interest", "-type", "-upstream_id", "creator", "data", "digest", "key_id", "name", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "pulp_type", "timestamp", "timestamp_of_interest", "type", "upstream_id"]
  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/signatures/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'digest'] = opts[:'digest'] if !opts[:'digest'].nil?
  query_params[:'digest__in'] = @api_client.build_collection_param(opts[:'digest__in'], :csv) if !opts[:'digest__in'].nil?
  query_params[:'key_id'] = opts[:'key_id'] if !opts[:'key_id'].nil?
  query_params[:'key_id__in'] = @api_client.build_collection_param(opts[:'key_id__in'], :csv) if !opts[:'key_id__in'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'manifest'] = @api_client.build_collection_param(opts[:'manifest'], :csv) if !opts[:'manifest'].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__iexact'] = opts[:'name__iexact'] if !opts[:'name__iexact'].nil?
  query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
  query_params[:'name__istartswith'] = opts[:'name__istartswith'] if !opts[:'name__istartswith'].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_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[:'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] || 'PaginatedcontainerManifestSignatureResponseList' 

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

Inspect a manifest signature ViewSet for image signatures. @param container_manifest_signature_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 [ContainerManifestSignatureResponse]

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

Inspect a manifest signature ViewSet for image signatures. @param container_manifest_signature_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<(ContainerManifestSignatureResponse, Integer, Hash)>] ContainerManifestSignatureResponse data, response status code and response headers

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

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