Class: PulpContainerClient::ContentSignaturesApi

Inherits:

Object

Object
PulpContainerClient::ContentSignaturesApi

show all

Defined in:: lib/pulp_container_client/api/content_signatures_api.rb

Instance Attribute Summary collapse

#api_client ⇒ Object

Returns the value of attribute api_client.

Instance Method Summary collapse

#initialize(api_client = ApiClient.default) ⇒ ContentSignaturesApi constructor

A new instance of ContentSignaturesApi.
#list(opts = {}) ⇒ PaginatedcontainerManifestSignatureResponseList

List manifest signatures ViewSet for image signatures.
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedcontainerManifestSignatureResponseList, Integer, Hash)>

List manifest signatures ViewSet for image signatures.
#read(container_manifest_signature_href, opts = {}) ⇒ ContainerManifestSignatureResponse

Inspect a manifest signature ViewSet for image signatures.
#read_with_http_info(container_manifest_signature_href, opts = {}) ⇒ Array<(ContainerManifestSignatureResponse, Integer, Hash)>

Inspect a manifest signature ViewSet for image signatures.

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ `ContentSignaturesApi`

Returns a new instance of ContentSignaturesApi.



19
20
21

# File 'lib/pulp_container_client/api/content_signatures_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ `Object`

Returns the value of attribute api_client.



17
18
19

# File 'lib/pulp_container_client/api/content_signatures_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list(opts = {}) ⇒ `PaginatedcontainerManifestSignatureResponseList`

List manifest signatures ViewSet for image signatures.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:digest (String) —

Filter results where digest matches value
:digest__in (Array<String>) —

Filter results where digest is in a comma-separated list of values
:key_id (String) —

Filter results where key_id matches value
:key_id__in (Array<String>) —

Filter results where key_id is in a comma-separated list of values
:limit (Integer) —

Number of results to return per page.
:manifest (Array<String>) —

Multiple values may be separated by commas.
:name (String) —

Filter results where name matches value
:name__contains (String) —

Filter results where name contains value
:name__icontains (String) —

Filter results where name contains value
:name__in (Array<String>) —

Filter results where name is in a comma-separated list of values
:name__startswith (String) —

Filter results where name starts with value
:offset (Integer) —

The initial index from which to return the results.
:ordering (Array<String>) —

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) * `name` - Name * `-name` - Name (descending) * `digest` - Digest * `-digest` - Digest (descending) * `type` - Type * `-type` - Type (descending) * `key_id` - Key id * `-key_id` - Key id (descending) * `timestamp` - Timestamp * `-timestamp` - Timestamp (descending) * `creator` - Creator * `-creator` - Creator (descending) * `data` - Data * `-data` - Data (descending) * `pk` - Pk * `-pk` - Pk (descending)
:pulp_href__in (Array<String>) —

Multiple values may be separated by commas.
:pulp_id__in (Array<String>) —

Multiple values may be separated by commas.
:repository_version (String) —

Repository Version referenced by HREF
:repository_version_added (String) —

Repository Version referenced by HREF
:repository_version_removed (String) —

Repository Version referenced by HREF
:fields (Array<String>) —

A list of fields to include in the response.
:exclude_fields (Array<String>) —

A list of fields to exclude from the response.

Returns:

(PaginatedcontainerManifestSignatureResponseList)

# File 'lib/pulp_container_client/api/content_signatures_api.rb', line 46

def list(opts = {})
  data, _status_code, _headers = list_with_http_info(opts)
  data
end

#list_with_http_info(opts = {}) ⇒ `Array<(PaginatedcontainerManifestSignatureResponseList, Integer, Hash)>`

List manifest signatures ViewSet for image signatures.

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:digest (String) —

Filter results where digest matches value
:digest__in (Array<String>) —

Filter results where digest is in a comma-separated list of values
:key_id (String) —

Filter results where key_id matches value
:key_id__in (Array<String>) —

Filter results where key_id is in a comma-separated list of values
:limit (Integer) —

Number of results to return per page.
:manifest (Array<String>) —

Multiple values may be separated by commas.
:name (String) —

Filter results where name matches value
:name__contains (String) —

Filter results where name contains value
:name__icontains (String) —

Filter results where name contains value
:name__in (Array<String>) —

Filter results where name is in a comma-separated list of values
:name__startswith (String) —

Filter results where name starts with value
:offset (Integer) —

The initial index from which to return the results.
:ordering (Array<String>) —

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) * `name` - Name * `-name` - Name (descending) * `digest` - Digest * `-digest` - Digest (descending) * `type` - Type * `-type` - Type (descending) * `key_id` - Key id * `-key_id` - Key id (descending) * `timestamp` - Timestamp * `-timestamp` - Timestamp (descending) * `creator` - Creator * `-creator` - Creator (descending) * `data` - Data * `-data` - Data (descending) * `pk` - Pk * `-pk` - Pk (descending)
:pulp_href__in (Array<String>) —

Multiple values may be separated by commas.
:pulp_id__in (Array<String>) —

Multiple values may be separated by commas.
:repository_version (String) —

Repository Version referenced by HREF
:repository_version_added (String) —

Repository Version referenced by HREF
:repository_version_removed (String) —

Repository Version referenced by HREF
:fields (Array<String>) —

A list of fields to include in the response.
:exclude_fields (Array<String>) —

A list of fields to exclude from the response.

Returns:

(Array<(PaginatedcontainerManifestSignatureResponseList, Integer, Hash)>) —

PaginatedcontainerManifestSignatureResponseList data, response status code and response headers

# File 'lib/pulp_container_client/api/content_signatures_api.rb', line 75

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__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_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[:'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 = {}) ⇒ `ContainerManifestSignatureResponse`

Inspect a manifest signature ViewSet for image signatures.

Parameters:

container_manifest_signature_href (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:fields (Array<String>) —

A list of fields to include in the response.
:exclude_fields (Array<String>) —

A list of fields to exclude from the response.

Returns:

(ContainerManifestSignatureResponse)

# File 'lib/pulp_container_client/api/content_signatures_api.rb', line 149

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 = {}) ⇒ `Array<(ContainerManifestSignatureResponse, Integer, Hash)>`

Inspect a manifest signature ViewSet for image signatures.

Parameters:

container_manifest_signature_href (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:fields (Array<String>) —

A list of fields to include in the response.
:exclude_fields (Array<String>) —

A list of fields to exclude from the response.

Returns:

(Array<(ContainerManifestSignatureResponse, Integer, Hash)>) —

ContainerManifestSignatureResponse data, response status code and response headers

# File 'lib/pulp_container_client/api/content_signatures_api.rb', line 161

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

Class: PulpContainerClient::ContentSignaturesApi

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentSignaturesApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

#list(opts = {}) ⇒ PaginatedcontainerManifestSignatureResponseList

#list_with_http_info(opts = {}) ⇒ Array<(PaginatedcontainerManifestSignatureResponseList, Integer, Hash)>

#read(container_manifest_signature_href, opts = {}) ⇒ ContainerManifestSignatureResponse

#read_with_http_info(container_manifest_signature_href, opts = {}) ⇒ Array<(ContainerManifestSignatureResponse, Integer, Hash)>

#initialize(api_client = ApiClient.default) ⇒ `ContentSignaturesApi`

#api_client ⇒ `Object`

#list(opts = {}) ⇒ `PaginatedcontainerManifestSignatureResponseList`

#list_with_http_info(opts = {}) ⇒ `Array<(PaginatedcontainerManifestSignatureResponseList, Integer, Hash)>`

#read(container_manifest_signature_href, opts = {}) ⇒ `ContainerManifestSignatureResponse`

#read_with_http_info(container_manifest_signature_href, opts = {}) ⇒ `Array<(ContainerManifestSignatureResponse, Integer, Hash)>`