Class: PulpDebClient::ContentReleasesApi

Inherits:

Object

Object
PulpDebClient::ContentReleasesApi

show all

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

Instance Attribute Summary collapse

#api_client ⇒ Object

Returns the value of attribute api_client.

Instance Method Summary collapse

#create(deb_release, opts = {}) ⇒ AsyncOperationResponse

Create a release Trigger an asynchronous task to create content,optionally create new repository version.
#create_with_http_info(deb_release, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Create a release Trigger an asynchronous task to create content,optionally create new repository version.
#initialize(api_client = ApiClient.default) ⇒ ContentReleasesApi constructor

A new instance of ContentReleasesApi.
#list(opts = {}) ⇒ PaginateddebReleaseResponseList

List releases The Release contains release file fields, that are not relevant to the APT repo structure.
#list_with_http_info(opts = {}) ⇒ Array<(PaginateddebReleaseResponseList, Integer, Hash)>

List releases The Release contains release file fields, that are not relevant to the APT repo structure.
#read(deb_release_href, opts = {}) ⇒ DebReleaseResponse

Inspect a release The Release contains release file fields, that are not relevant to the APT repo structure.
#read_with_http_info(deb_release_href, opts = {}) ⇒ Array<(DebReleaseResponse, Integer, Hash)>

Inspect a release The Release contains release file fields, that are not relevant to the APT repo structure.

Constructor Details

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

Returns a new instance of ContentReleasesApi.



19
20
21

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

def api_client
  @api_client
end

Instance Method Details

#create(deb_release, opts = {}) ⇒ `AsyncOperationResponse`

Create a release Trigger an asynchronous task to create content,optionally create new repository version.

Parameters:

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

the optional parameters

Returns:

(AsyncOperationResponse)

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

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

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

Create a release Trigger an asynchronous task to create content,optionally create new repository version.

Parameters:

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

the optional parameters

Returns:

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

AsyncOperationResponse data, response status code and response headers

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

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

  # 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) 

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

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

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

List releases The Release contains release file fields, that are not relevant to the APT repo structure. Associated artifacts: None; contains only metadata. By non-structure relevant release file fields, we mean anything other than the Components and Architectures fields. These are handled by their own models and are not part of this model. Note that the distribution field is part of this model, but is not added to any published release files. The "distribution" is defined as the path between ‘dists/’ and some ‘Release’ file. As such, it encodes the path to the relevant release file within the APT repository. It is often (but not always) equal to the "codename" or the "suite".

Parameters:

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

the optional parameters

Options Hash (opts):

:codename (String) —

Filter results where codename matches value
:distribution (String) —

Filter results where distribution matches value
:label (String) —

Filter results where label 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) * `version` - Version * `-version` - Version (descending) * `origin` - Origin * `-origin` - Origin (descending) * `label` - Label * `-label` - Label (descending) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending)
:origin (String) —

Filter results where origin matches value
:orphaned_for (Float) —

Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
:package (String) —

Must be a comma-separated string: "package_href,repository_or_repository_version_href" package_href: Filter results where Release contains Package repository_or_repository_version_href: The RepositoryVersion href to filter by, or Repository href (assume latest version)
: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
:suite (String) —

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

Filter results where version 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:

(PaginateddebReleaseResponseList)

# File 'lib/pulp_deb_client/api/content_releases_api.rb', line 110

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

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

List releases The Release contains release file fields, that are not relevant to the APT repo structure. Associated artifacts: None; contains only metadata. By non-structure relevant release file fields, we mean anything other than the Components and Architectures fields. These are handled by their own models and are not part of this model. Note that the distribution field is part of this model, but is not added to any published release files. The "distribution" is defined as the path between 'dists/' and some 'Release' file. As such, it encodes the path to the relevant release file within the APT repository. It is often (but not always) equal to the "codename" or the "suite".

Parameters:

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

the optional parameters

Options Hash (opts):

:codename (String) —

Filter results where codename matches value
:distribution (String) —

Filter results where distribution matches value
:label (String) —

Filter results where label 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) * `version` - Version * `-version` - Version (descending) * `origin` - Origin * `-origin` - Origin (descending) * `label` - Label * `-label` - Label (descending) * `description` - Description * `-description` - Description (descending) * `pk` - Pk * `-pk` - Pk (descending)
:origin (String) —

Filter results where origin matches value
:orphaned_for (Float) —

Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
:package (String) —

Must be a comma-separated string: "package_href,repository_or_repository_version_href" package_href: Filter results where Release contains Package repository_or_repository_version_href: The RepositoryVersion href to filter by, or Repository href (assume latest version)
: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
:suite (String) —

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

Filter results where version 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<(PaginateddebReleaseResponseList, Integer, Hash)>) —

PaginateddebReleaseResponseList data, response status code and response headers

# File 'lib/pulp_deb_client/api/content_releases_api.rb', line 139

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentReleasesApi.list ...'
  end
  allowable_values = ["-codename", "-description", "-distribution", "-label", "-origin", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-pulp_type", "-suite", "-timestamp_of_interest", "-upstream_id", "-version", "codename", "description", "distribution", "label", "origin", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "pulp_type", "suite", "timestamp_of_interest", "upstream_id", "version"]
  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/releases/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'codename'] = opts[:'codename'] if !opts[:'codename'].nil?
  query_params[:'distribution'] = opts[:'distribution'] if !opts[:'distribution'].nil?
  query_params[:'label'] = opts[:'label'] if !opts[:'label'].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[:'origin'] = opts[:'origin'] if !opts[:'origin'].nil?
  query_params[:'orphaned_for'] = opts[:'orphaned_for'] if !opts[:'orphaned_for'].nil?
  query_params[:'package'] = opts[:'package'] if !opts[:'package'].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[:'suite'] = opts[:'suite'] if !opts[:'suite'].nil?
  query_params[:'version'] = opts[:'version'] if !opts[:'version'].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] || 'PaginateddebReleaseResponseList' 

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

#read(deb_release_href, opts = {}) ⇒ `DebReleaseResponse`

Inspect a release The Release contains release file fields, that are not relevant to the APT repo structure. Associated artifacts: None; contains only metadata. By non-structure relevant release file fields, we mean anything other than the Components and Architectures fields. These are handled by their own models and are not part of this model. Note that the distribution field is part of this model, but is not added to any published release files. The "distribution" is defined as the path between ‘dists/’ and some ‘Release’ file. As such, it encodes the path to the relevant release file within the APT repository. It is often (but not always) equal to the "codename" or the "suite".

Parameters:

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

(DebReleaseResponse)

# File 'lib/pulp_deb_client/api/content_releases_api.rb', line 213

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

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

Inspect a release The Release contains release file fields, that are not relevant to the APT repo structure. Associated artifacts: None; contains only metadata. By non-structure relevant release file fields, we mean anything other than the Components and Architectures fields. These are handled by their own models and are not part of this model. Note that the distribution field is part of this model, but is not added to any published release files. The "distribution" is defined as the path between 'dists/' and some 'Release' file. As such, it encodes the path to the relevant release file within the APT repository. It is often (but not always) equal to the "codename" or the "suite".

Parameters:

deb_release_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<(DebReleaseResponse, Integer, Hash)>) —

DebReleaseResponse data, response status code and response headers

# File 'lib/pulp_deb_client/api/content_releases_api.rb', line 225

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

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

Class: PulpDebClient::ContentReleasesApi

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentReleasesApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

#create(deb_release, opts = {}) ⇒ AsyncOperationResponse

#create_with_http_info(deb_release, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

#list(opts = {}) ⇒ PaginateddebReleaseResponseList

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

#read(deb_release_href, opts = {}) ⇒ DebReleaseResponse

#read_with_http_info(deb_release_href, opts = {}) ⇒ Array<(DebReleaseResponse, Integer, Hash)>

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

#api_client ⇒ `Object`

#create(deb_release, opts = {}) ⇒ `AsyncOperationResponse`

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

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

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

#read(deb_release_href, opts = {}) ⇒ `DebReleaseResponse`

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