Class: PulpRpmClient::ContentModulemdsApi

Inherits:

Object

Object
PulpRpmClient::ContentModulemdsApi

show all

Defined in:: lib/pulp_rpm_client/api/content_modulemds_api.rb

Instance Attribute Summary collapse

#api_client ⇒ Object

Returns the value of attribute api_client.

Instance Method Summary collapse

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

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

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

A new instance of ContentModulemdsApi.
#list(opts = {}) ⇒ PaginatedrpmModulemdResponseList

List modulemds ViewSet for Modulemd.
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedrpmModulemdResponseList, Integer, Hash)>

List modulemds ViewSet for Modulemd.
#read(rpm_modulemd_href, opts = {}) ⇒ RpmModulemdResponse

Inspect a modulemd ViewSet for Modulemd.
#read_with_http_info(rpm_modulemd_href, opts = {}) ⇒ Array<(RpmModulemdResponse, Integer, Hash)>

Inspect a modulemd ViewSet for Modulemd.

Constructor Details

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

Returns a new instance of ContentModulemdsApi.



19
20
21

# File 'lib/pulp_rpm_client/api/content_modulemds_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_rpm_client/api/content_modulemds_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

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

Parameters:

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

the optional parameters

Returns:

(AsyncOperationResponse)

# File 'lib/pulp_rpm_client/api/content_modulemds_api.rb', line 27

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

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

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

Parameters:

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

the optional parameters

Returns:

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

AsyncOperationResponse data, response status code and response headers

# File 'lib/pulp_rpm_client/api/content_modulemds_api.rb', line 37

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

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

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

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

List modulemds ViewSet for Modulemd.

Parameters:

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

the optional parameters

Options Hash (opts):

:arch (String) —

Filter results where arch matches value
:arch__in (Array<String>) —

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

Filter results where context matches value
:context__in (Array<String>) —

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

Number of results to return per page.
:name (String) —

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

Filter results where name is in a comma-separated list of values
: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) * `stream` - Stream * `-stream` - Stream (descending) * `version` - Version * `-version` - Version (descending) * `context` - Context * `-context` - Context (descending) * `arch` - Arch * `-arch` - Arch (descending) * `static_context` - Static context * `-static_context` - Static context (descending) * `dependencies` - Dependencies * `-dependencies` - Dependencies (descending) * `artifacts` - Artifacts * `-artifacts` - Artifacts (descending) * `profiles` - Profiles * `-profiles` - Profiles (descending) * `description` - Description * `-description` - Description (descending) * `digest` - Digest * `-digest` - Digest (descending) * `snippet` - Snippet * `-snippet` - Snippet (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
:sha256 (String)
:stream (String) —

Filter results where stream matches value
:stream__in (Array<String>) —

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

Filter results where version matches value
:version__in (Array<String>) —

Filter results where version is in a comma-separated list of values
: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:

(PaginatedrpmModulemdResponseList)

# File 'lib/pulp_rpm_client/api/content_modulemds_api.rb', line 114

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

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

List modulemds ViewSet for Modulemd.

Parameters:

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

the optional parameters

Options Hash (opts):

:arch (String) —

Filter results where arch matches value
:arch__in (Array<String>) —

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

Filter results where context matches value
:context__in (Array<String>) —

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

Number of results to return per page.
:name (String) —

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

Filter results where name is in a comma-separated list of values
: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) * `stream` - Stream * `-stream` - Stream (descending) * `version` - Version * `-version` - Version (descending) * `context` - Context * `-context` - Context (descending) * `arch` - Arch * `-arch` - Arch (descending) * `static_context` - Static context * `-static_context` - Static context (descending) * `dependencies` - Dependencies * `-dependencies` - Dependencies (descending) * `artifacts` - Artifacts * `-artifacts` - Artifacts (descending) * `profiles` - Profiles * `-profiles` - Profiles (descending) * `description` - Description * `-description` - Description (descending) * `digest` - Digest * `-digest` - Digest (descending) * `snippet` - Snippet * `-snippet` - Snippet (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
:sha256 (String)
:stream (String) —

Filter results where stream matches value
:stream__in (Array<String>) —

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

Filter results where version matches value
:version__in (Array<String>) —

Filter results where version is in a comma-separated list of values
: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<(PaginatedrpmModulemdResponseList, Integer, Hash)>) —

PaginatedrpmModulemdResponseList data, response status code and response headers

# File 'lib/pulp_rpm_client/api/content_modulemds_api.rb', line 147

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentModulemdsApi.list ...'
  end
  allowable_values = ["-arch", "-artifacts", "-context", "-dependencies", "-description", "-digest", "-name", "-pk", "-profiles", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-pulp_type", "-snippet", "-static_context", "-stream", "-timestamp_of_interest", "-upstream_id", "-version", "arch", "artifacts", "context", "dependencies", "description", "digest", "name", "pk", "profiles", "pulp_created", "pulp_id", "pulp_last_updated", "pulp_type", "snippet", "static_context", "stream", "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/rpm/modulemds/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'arch'] = opts[:'arch'] if !opts[:'arch'].nil?
  query_params[:'arch__in'] = @api_client.build_collection_param(opts[:'arch__in'], :csv) if !opts[:'arch__in'].nil?
  query_params[:'context'] = opts[:'context'] if !opts[:'context'].nil?
  query_params[:'context__in'] = @api_client.build_collection_param(opts[:'context__in'], :csv) if !opts[:'context__in'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].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[:'sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil?
  query_params[:'stream'] = opts[:'stream'] if !opts[:'stream'].nil?
  query_params[:'stream__in'] = @api_client.build_collection_param(opts[:'stream__in'], :csv) if !opts[:'stream__in'].nil?
  query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
  query_params[:'version__in'] = @api_client.build_collection_param(opts[:'version__in'], :csv) if !opts[:'version__in'].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] || 'PaginatedrpmModulemdResponseList' 

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

#read(rpm_modulemd_href, opts = {}) ⇒ `RpmModulemdResponse`

Inspect a modulemd ViewSet for Modulemd.

Parameters:

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

(RpmModulemdResponse)

# File 'lib/pulp_rpm_client/api/content_modulemds_api.rb', line 225

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

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

Inspect a modulemd ViewSet for Modulemd.

Parameters:

rpm_modulemd_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<(RpmModulemdResponse, Integer, Hash)>) —

RpmModulemdResponse data, response status code and response headers

# File 'lib/pulp_rpm_client/api/content_modulemds_api.rb', line 237

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

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

Class: PulpRpmClient::ContentModulemdsApi

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentModulemdsApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

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

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

#list(opts = {}) ⇒ PaginatedrpmModulemdResponseList

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

#read(rpm_modulemd_href, opts = {}) ⇒ RpmModulemdResponse

#read_with_http_info(rpm_modulemd_href, opts = {}) ⇒ Array<(RpmModulemdResponse, Integer, Hash)>

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

#api_client ⇒ `Object`

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

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

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

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

#read(rpm_modulemd_href, opts = {}) ⇒ `RpmModulemdResponse`

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