Class: PulpDebClient::ContentReleaseFilesApi

Inherits:

Object

Object
PulpDebClient::ContentReleaseFilesApi

show all

Defined in:: lib/pulp_deb_client/api/content_release_files_api.rb

Instance Attribute Summary collapse

#api_client ⇒ Object

Returns the value of attribute api_client.

Instance Method Summary collapse

#create(deb_release_file, opts = {}) ⇒ DebReleaseFileResponse

Create a release file A ReleaseFile represents the Release file(s) from a single APT distribution.
#create_with_http_info(deb_release_file, opts = {}) ⇒ Array<(DebReleaseFileResponse, Integer, Hash)>

Create a release file A ReleaseFile represents the Release file(s) from a single APT distribution.
#initialize(api_client = ApiClient.default) ⇒ ContentReleaseFilesApi constructor

A new instance of ContentReleaseFilesApi.
#list(opts = {}) ⇒ PaginateddebReleaseFileResponseList

List release files A ReleaseFile represents the Release file(s) from a single APT distribution.
#list_with_http_info(opts = {}) ⇒ Array<(PaginateddebReleaseFileResponseList, Integer, Hash)>

List release files A ReleaseFile represents the Release file(s) from a single APT distribution.
#read(deb_release_file_href, opts = {}) ⇒ DebReleaseFileResponse

Inspect a release file A ReleaseFile represents the Release file(s) from a single APT distribution.
#read_with_http_info(deb_release_file_href, opts = {}) ⇒ Array<(DebReleaseFileResponse, Integer, Hash)>

Inspect a release file A ReleaseFile represents the Release file(s) from a single APT distribution.

Constructor Details

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

Returns a new instance of ContentReleaseFilesApi.



19
20
21

# File 'lib/pulp_deb_client/api/content_release_files_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_deb_client/api/content_release_files_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create(deb_release_file, opts = {}) ⇒ `DebReleaseFileResponse`

Create a release file A ReleaseFile represents the Release file(s) from a single APT distribution. Associated artifacts: At least one of ‘Release’ and ‘InRelease’ file. If the ‘Release’ file is present, then there may also be a ‘Release.gpg’ detached signature file for it. Note: The verbatim publisher will republish all associated artifacts, while the APT publisher (both simple and structured mode) will generate any ‘Release’ files it needs when creating the publication. It does not make use of ReleaseFile content.

Parameters:

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

the optional parameters

Returns:

(DebReleaseFileResponse)

# File 'lib/pulp_deb_client/api/content_release_files_api.rb', line 27

def create(deb_release_file, opts = {})
  data, _status_code, _headers = create_with_http_info(deb_release_file, opts)
  data
end

#create_with_http_info(deb_release_file, opts = {}) ⇒ `Array<(DebReleaseFileResponse, Integer, Hash)>`

Create a release file A ReleaseFile represents the Release file(s) from a single APT distribution. Associated artifacts: At least one of 'Release' and 'InRelease' file. If the 'Release' file is present, then there may also be a 'Release.gpg' detached signature file for it. Note: The verbatim publisher will republish all associated artifacts, while the APT publisher (both simple and structured mode) will generate any 'Release' files it needs when creating the publication. It does not make use of ReleaseFile content.

Parameters:

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

the optional parameters

Returns:

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

DebReleaseFileResponse data, response status code and response headers

# File 'lib/pulp_deb_client/api/content_release_files_api.rb', line 37

def create_with_http_info(deb_release_file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentReleaseFilesApi.create ...'
  end
  # verify the required parameter 'deb_release_file' is set
  if @api_client.config.client_side_validation && deb_release_file.nil?
    fail ArgumentError, "Missing the required parameter 'deb_release_file' when calling ContentReleaseFilesApi.create"
  end
  # resource path
  local_var_path = '/pulp/api/v3/content/deb/release_files/'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(deb_release_file) 

  # return_type
  return_type = opts[:return_type] || 'DebReleaseFileResponse' 

  # 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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ContentReleaseFilesApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

List release files A ReleaseFile represents the Release file(s) from a single APT distribution. Associated artifacts: At least one of ‘Release’ and ‘InRelease’ file. If the ‘Release’ file is present, then there may also be a ‘Release.gpg’ detached signature file for it. Note: The verbatim publisher will republish all associated artifacts, while the APT publisher (both simple and structured mode) will generate any ‘Release’ files it needs when creating the publication. It does not make use of ReleaseFile content.

Parameters:

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

the optional parameters

Options Hash (opts):

:codename (String) —

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

Number of results to return per page.
: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) * `codename` - Codename * `-codename` - Codename (descending) * `suite` - Suite * `-suite` - Suite (descending) * `distribution` - Distribution * `-distribution` - Distribution (descending) * `components` - Components * `-components` - Components (descending) * `architectures` - Architectures * `-architectures` - Architectures (descending) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `artifact_set_sha256` - Artifact set sha256 * `-artifact_set_sha256` - Artifact set sha256 (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
:relative_path (String) —

Filter results where relative_path matches value
: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
:sha256 (String) —

Filter results where sha256 matches value
:suite (String) —

Filter results where suite matches value
: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:

(PaginateddebReleaseFileResponseList)

# File 'lib/pulp_deb_client/api/content_release_files_api.rb', line 107

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

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

List release files A ReleaseFile represents the Release file(s) from a single APT distribution. Associated artifacts: At least one of 'Release' and 'InRelease' file. If the 'Release' file is present, then there may also be a 'Release.gpg' detached signature file for it. Note: The verbatim publisher will republish all associated artifacts, while the APT publisher (both simple and structured mode) will generate any 'Release' files it needs when creating the publication. It does not make use of ReleaseFile content.

Parameters:

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

the optional parameters

Options Hash (opts):

:codename (String) —

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

Number of results to return per page.
: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) * `codename` - Codename * `-codename` - Codename (descending) * `suite` - Suite * `-suite` - Suite (descending) * `distribution` - Distribution * `-distribution` - Distribution (descending) * `components` - Components * `-components` - Components (descending) * `architectures` - Architectures * `-architectures` - Architectures (descending) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `artifact_set_sha256` - Artifact set sha256 * `-artifact_set_sha256` - Artifact set sha256 (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
:relative_path (String) —

Filter results where relative_path matches value
: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
:sha256 (String) —

Filter results where sha256 matches value
:suite (String) —

Filter results where suite matches value
: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<(PaginateddebReleaseFileResponseList, Integer, Hash)>) —

PaginateddebReleaseFileResponseList data, response status code and response headers

# File 'lib/pulp_deb_client/api/content_release_files_api.rb', line 133

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentReleaseFilesApi.list ...'
  end
  allowable_values = ["-architectures", "-artifact_set_sha256", "-codename", "-components", "-distribution", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-pulp_type", "-relative_path", "-sha256", "-suite", "-timestamp_of_interest", "-upstream_id", "architectures", "artifact_set_sha256", "codename", "components", "distribution", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "pulp_type", "relative_path", "sha256", "suite", "timestamp_of_interest", "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/deb/release_files/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'codename'] = opts[:'codename'] if !opts[:'codename'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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[:'relative_path'] = opts[:'relative_path'] if !opts[:'relative_path'].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[:'sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil?
  query_params[:'suite'] = opts[:'suite'] if !opts[:'suite'].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] || 'PaginateddebReleaseFileResponseList' 

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

#read(deb_release_file_href, opts = {}) ⇒ `DebReleaseFileResponse`

Inspect a release file A ReleaseFile represents the Release file(s) from a single APT distribution. Associated artifacts: At least one of ‘Release’ and ‘InRelease’ file. If the ‘Release’ file is present, then there may also be a ‘Release.gpg’ detached signature file for it. Note: The verbatim publisher will republish all associated artifacts, while the APT publisher (both simple and structured mode) will generate any ‘Release’ files it needs when creating the publication. It does not make use of ReleaseFile content.

Parameters:

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

(DebReleaseFileResponse)

# File 'lib/pulp_deb_client/api/content_release_files_api.rb', line 204

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

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

Inspect a release file A ReleaseFile represents the Release file(s) from a single APT distribution. Associated artifacts: At least one of 'Release' and 'InRelease' file. If the 'Release' file is present, then there may also be a 'Release.gpg' detached signature file for it. Note: The verbatim publisher will republish all associated artifacts, while the APT publisher (both simple and structured mode) will generate any 'Release' files it needs when creating the publication. It does not make use of ReleaseFile content.

Parameters:

deb_release_file_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<(DebReleaseFileResponse, Integer, Hash)>) —

DebReleaseFileResponse data, response status code and response headers

# File 'lib/pulp_deb_client/api/content_release_files_api.rb', line 216

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

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

Class: PulpDebClient::ContentReleaseFilesApi

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentReleaseFilesApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

#create(deb_release_file, opts = {}) ⇒ DebReleaseFileResponse

#create_with_http_info(deb_release_file, opts = {}) ⇒ Array<(DebReleaseFileResponse, Integer, Hash)>

#list(opts = {}) ⇒ PaginateddebReleaseFileResponseList

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

#read(deb_release_file_href, opts = {}) ⇒ DebReleaseFileResponse

#read_with_http_info(deb_release_file_href, opts = {}) ⇒ Array<(DebReleaseFileResponse, Integer, Hash)>

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

#api_client ⇒ `Object`

#create(deb_release_file, opts = {}) ⇒ `DebReleaseFileResponse`

#create_with_http_info(deb_release_file, opts = {}) ⇒ `Array<(DebReleaseFileResponse, Integer, Hash)>`

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

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

#read(deb_release_file_href, opts = {}) ⇒ `DebReleaseFileResponse`

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