Class: PulpContainerClient::ContentManifestsApi

Inherits:

Object

Object
PulpContainerClient::ContentManifestsApi

show all

Defined in:: lib/pulp_container_client/api/content_manifests_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) ⇒ ContentManifestsApi constructor

A new instance of ContentManifestsApi.
#list(opts = {}) ⇒ PaginatedcontainerManifestResponseList

List manifests ViewSet for Manifest.
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedcontainerManifestResponseList, Integer, Hash)>

List manifests ViewSet for Manifest.
#read(container_manifest_href, opts = {}) ⇒ ContainerManifestResponse

Inspect a manifest ViewSet for Manifest.
#read_with_http_info(container_manifest_href, opts = {}) ⇒ Array<(ContainerManifestResponse, Integer, Hash)>

Inspect a manifest ViewSet for Manifest.

Constructor Details

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

Returns a new instance of ContentManifestsApi.



19
20
21

# File 'lib/pulp_container_client/api/content_manifests_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_manifests_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

List manifests ViewSet for Manifest.

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
:is_bootable (Boolean) —

Filter results where is_bootable matches value
:is_flatpak (Boolean) —

Filter results where is_flatpak matches value
:limit (Integer) —

Number of results to return per page.
:media_type (Array<String>) —
- `application/vnd.docker.distribution.manifest.v1+json` - application/vnd.docker.distribution.manifest.v1+json * `application/vnd.docker.distribution.manifest.v2+json` - application/vnd.docker.distribution.manifest.v2+json * `application/vnd.docker.distribution.manifest.list.v2+json` - application/vnd.docker.distribution.manifest.list.v2+json * `application/vnd.oci.image.manifest.v1+json` - application/vnd.oci.image.manifest.v1+json * `application/vnd.oci.image.index.v1+json` - application/vnd.oci.image.index.v1+json
: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) * `digest` - Digest * `-digest` - Digest (descending) * `schema_version` - Schema version * `-schema_version` - Schema version (descending) * `media_type` - Media type * `-media_type` - Media type (descending) * `type` - Type * `-type` - Type (descending) * `data` - Data * `-data` - Data (descending) * `annotations` - Annotations * `-annotations` - Annotations (descending) * `labels` - Labels * `-labels` - Labels (descending) * `architecture` - Architecture * `-architecture` - Architecture (descending) * `os` - Os * `-os` - Os (descending) * `compressed_image_size` - Compressed image size * `-compressed_image_size` - Compressed image size (descending) * `is_bootable` - Is bootable * `-is_bootable` - Is bootable (descending) * `is_flatpak` - Is flatpak * `-is_flatpak` - Is flatpak (descending) * `pk` - Pk * `-pk` - Pk (descending)
:orphaned_for (Float) —

Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
:prn__in (Array<String>) —

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

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

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

Filter results by using NOT, AND and OR operations on other filters
:repository_version (String) —

Repository Version referenced by HREF/PRN
:repository_version_added (String) —

Repository Version referenced by HREF/PRN
:repository_version_removed (String) —

Repository Version referenced by HREF/PRN
: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:

(PaginatedcontainerManifestResponseList)

# File 'lib/pulp_container_client/api/content_manifests_api.rb', line 44

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

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

List manifests ViewSet for Manifest.

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
:is_bootable (Boolean) —

Filter results where is_bootable matches value
:is_flatpak (Boolean) —

Filter results where is_flatpak matches value
:limit (Integer) —

Number of results to return per page.
:media_type (Array<String>) —
- `application/vnd.docker.distribution.manifest.v1+json` - application/vnd.docker.distribution.manifest.v1+json * `application/vnd.docker.distribution.manifest.v2+json` - application/vnd.docker.distribution.manifest.v2+json * `application/vnd.docker.distribution.manifest.list.v2+json` - application/vnd.docker.distribution.manifest.list.v2+json * `application/vnd.oci.image.manifest.v1+json` - application/vnd.oci.image.manifest.v1+json * `application/vnd.oci.image.index.v1+json` - application/vnd.oci.image.index.v1+json
: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) * `digest` - Digest * `-digest` - Digest (descending) * `schema_version` - Schema version * `-schema_version` - Schema version (descending) * `media_type` - Media type * `-media_type` - Media type (descending) * `type` - Type * `-type` - Type (descending) * `data` - Data * `-data` - Data (descending) * `annotations` - Annotations * `-annotations` - Annotations (descending) * `labels` - Labels * `-labels` - Labels (descending) * `architecture` - Architecture * `-architecture` - Architecture (descending) * `os` - Os * `-os` - Os (descending) * `compressed_image_size` - Compressed image size * `-compressed_image_size` - Compressed image size (descending) * `is_bootable` - Is bootable * `-is_bootable` - Is bootable (descending) * `is_flatpak` - Is flatpak * `-is_flatpak` - Is flatpak (descending) * `pk` - Pk * `-pk` - Pk (descending)
:orphaned_for (Float) —

Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
:prn__in (Array<String>) —

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

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

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

Filter results by using NOT, AND and OR operations on other filters
:repository_version (String) —

Repository Version referenced by HREF/PRN
:repository_version_added (String) —

Repository Version referenced by HREF/PRN
:repository_version_removed (String) —

Repository Version referenced by HREF/PRN
: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<(PaginatedcontainerManifestResponseList, Integer, Hash)>) —

PaginatedcontainerManifestResponseList data, response status code and response headers

# File 'lib/pulp_container_client/api/content_manifests_api.rb', line 71

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentManifestsApi.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 = ["-annotations", "-architecture", "-compressed_image_size", "-data", "-digest", "-is_bootable", "-is_flatpak", "-labels", "-media_type", "-os", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-pulp_type", "-schema_version", "-timestamp_of_interest", "-type", "-upstream_id", "annotations", "architecture", "compressed_image_size", "data", "digest", "is_bootable", "is_flatpak", "labels", "media_type", "os", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "pulp_type", "schema_version", "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/manifests/'

  # 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[:'is_bootable'] = opts[:'is_bootable'] if !opts[:'is_bootable'].nil?
  query_params[:'is_flatpak'] = opts[:'is_flatpak'] if !opts[:'is_flatpak'].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[:'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[:'prn__in'] = @api_client.build_collection_param(opts[:'prn__in'], :csv) if !opts[:'prn__in'].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] || 'PaginatedcontainerManifestResponseList' 

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

#read(container_manifest_href, opts = {}) ⇒ `ContainerManifestResponse`

Inspect a manifest ViewSet for Manifest.

Parameters:

container_manifest_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:

(ContainerManifestResponse)

# File 'lib/pulp_container_client/api/content_manifests_api.rb', line 147

def read(container_manifest_href, opts = {})
  data, _status_code, _headers = read_with_http_info(container_manifest_href, opts)
  data
end

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

Inspect a manifest ViewSet for Manifest.

Parameters:

container_manifest_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<(ContainerManifestResponse, Integer, Hash)>) —

ContainerManifestResponse data, response status code and response headers

# File 'lib/pulp_container_client/api/content_manifests_api.rb', line 159

def read_with_http_info(container_manifest_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentManifestsApi.read ...'
  end
  # verify the required parameter 'container_manifest_href' is set
  if @api_client.config.client_side_validation && container_manifest_href.nil?
    fail ArgumentError, "Missing the required parameter 'container_manifest_href' when calling ContentManifestsApi.read"
  end
  # resource path
  local_var_path = '{container_manifest_href}'.sub('{' + 'container_manifest_href' + '}', CGI.escape(container_manifest_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] || 'ContainerManifestResponse' 

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

Class: PulpContainerClient::ContentManifestsApi

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentManifestsApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

#list(opts = {}) ⇒ PaginatedcontainerManifestResponseList

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

#read(container_manifest_href, opts = {}) ⇒ ContainerManifestResponse

#read_with_http_info(container_manifest_href, opts = {}) ⇒ Array<(ContainerManifestResponse, Integer, Hash)>

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

#api_client ⇒ `Object`

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

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

#read(container_manifest_href, opts = {}) ⇒ `ContainerManifestResponse`

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