Class: PulpRpmClient::ContentAdvisoriesApi

Inherits:

Object

Object
PulpRpmClient::ContentAdvisoriesApi

show all

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

Instance Attribute Summary collapse

#api_client ⇒ Object

Returns the value of attribute api_client.

Instance Method Summary collapse

#create(opts = {}) ⇒ AsyncOperationResponse

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

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

A new instance of ContentAdvisoriesApi.
#list(opts = {}) ⇒ PaginatedrpmUpdateRecordResponseList

List update records A ViewSet for UpdateRecord.
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedrpmUpdateRecordResponseList, Integer, Hash)>

List update records A ViewSet for UpdateRecord.
#read(rpm_update_record_href, opts = {}) ⇒ RpmUpdateRecordResponse

Inspect an update record A ViewSet for UpdateRecord.
#read_with_http_info(rpm_update_record_href, opts = {}) ⇒ Array<(RpmUpdateRecordResponse, Integer, Hash)>

Inspect an update record A ViewSet for UpdateRecord.

Constructor Details

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

Returns a new instance of ContentAdvisoriesApi.



19
20
21

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

def api_client
  @api_client
end

Instance Method Details

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

Create an update record Trigger an asynchronous task to create content,optionally create new repository version.

Parameters:

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

the optional parameters

Options Hash (opts):

:repository (String) —

A URI of a repository the new content unit should be associated with.
:file (File) —

An uploaded file that may be turned into the content unit.
:upload (String) —

An uncommitted upload that may be turned into the content unit.
:file_url (String) —

A url that Pulp can download and turn into the content unit.

Returns:

(AsyncOperationResponse)

# File 'lib/pulp_rpm_client/api/content_advisories_api.rb', line 30

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

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

Create an update record Trigger an asynchronous task to create content,optionally create new repository version.

Parameters:

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

the optional parameters

Options Hash (opts):

:repository (String) —

A URI of a repository the new content unit should be associated with.
:file (File) —

An uploaded file that may be turned into the content unit.
:upload (String) —

An uncommitted upload that may be turned into the content unit.
:file_url (String) —

A url that Pulp can download and turn into the content unit.

Returns:

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

AsyncOperationResponse data, response status code and response headers

# File 'lib/pulp_rpm_client/api/content_advisories_api.rb', line 43

def create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentAdvisoriesApi.create ...'
  end
  if @api_client.config.client_side_validation && !opts[:'file_url'].nil? && opts[:'file_url'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"file_url"]" when calling ContentAdvisoriesApi.create, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/pulp/api/v3/content/rpm/advisories/'

  # 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(['multipart/form-data', 'application/x-www-form-urlencoded'])

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['repository'] = opts[:'repository'] if !opts[:'repository'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['upload'] = opts[:'upload'] if !opts[:'upload'].nil?
  form_params['file_url'] = opts[:'file_url'] if !opts[:'file_url'].nil?

  # http body (model)
  post_body = opts[:body] 

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

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

List update records

A ViewSet for UpdateRecord. Define endpoint name which will appear in the API endpoint for this content type. For example: pulp.example.com/pulp/api/v3/content/rpm/advisories/ Also specify queryset and serializer for UpdateRecord.

Parameters:

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

the optional parameters

Options Hash (opts):

:id (String) —

Filter results where id matches value
:id__in (Array<String>) —

Filter results where id is in a comma-separated list of values
: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) * `id` - Id * `-id` - Id (descending) * `updated_date` - Updated date * `-updated_date` - Updated date (descending) * `description` - Description * `-description` - Description (descending) * `issued_date` - Issued date * `-issued_date` - Issued date (descending) * `fromstr` - Fromstr * `-fromstr` - Fromstr (descending) * `status` - Status * `-status` - Status (descending) * `title` - Title * `-title` - Title (descending) * `summary` - Summary * `-summary` - Summary (descending) * `version` - Version * `-version` - Version (descending) * `type` - Type * `-type` - Type (descending) * `severity` - Severity * `-severity` - Severity (descending) * `solution` - Solution * `-solution` - Solution (descending) * `release` - Release * `-release` - Release (descending) * `rights` - Rights * `-rights` - Rights (descending) * `reboot_suggested` - Reboot suggested * `-reboot_suggested` - Reboot suggested (descending) * `pushcount` - Pushcount * `-pushcount` - Pushcount (descending) * `digest` - Digest * `-digest` - Digest (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
:severity (String) —

Filter results where severity matches value
:severity__in (Array<String>) —

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

Filter results where severity not equal to value
:status (String) —

Filter results where status matches value
:status__in (Array<String>) —

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

Filter results where status not equal to value
:type (String) —

Filter results where type matches value
:type__in (Array<String>) —

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

Filter results where type not equal to 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:

(PaginatedrpmUpdateRecordResponseList)

# File 'lib/pulp_rpm_client/api/content_advisories_api.rb', line 124

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

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

List update records

A ViewSet for UpdateRecord. Define endpoint name which will appear in the API endpoint for this content type. For example: pulp.example.com/pulp/api/v3/content/rpm/advisories/ Also specify queryset and serializer for UpdateRecord.

Parameters:

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

the optional parameters

Options Hash (opts):

:id (String) —

Filter results where id matches value
:id__in (Array<String>) —

Filter results where id is in a comma-separated list of values
: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) * `id` - Id * `-id` - Id (descending) * `updated_date` - Updated date * `-updated_date` - Updated date (descending) * `description` - Description * `-description` - Description (descending) * `issued_date` - Issued date * `-issued_date` - Issued date (descending) * `fromstr` - Fromstr * `-fromstr` - Fromstr (descending) * `status` - Status * `-status` - Status (descending) * `title` - Title * `-title` - Title (descending) * `summary` - Summary * `-summary` - Summary (descending) * `version` - Version * `-version` - Version (descending) * `type` - Type * `-type` - Type (descending) * `severity` - Severity * `-severity` - Severity (descending) * `solution` - Solution * `-solution` - Solution (descending) * `release` - Release * `-release` - Release (descending) * `rights` - Rights * `-rights` - Rights (descending) * `reboot_suggested` - Reboot suggested * `-reboot_suggested` - Reboot suggested (descending) * `pushcount` - Pushcount * `-pushcount` - Pushcount (descending) * `digest` - Digest * `-digest` - Digest (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
:severity (String) —

Filter results where severity matches value
:severity__in (Array<String>) —

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

Filter results where severity not equal to value
:status (String) —

Filter results where status matches value
:status__in (Array<String>) —

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

Filter results where status not equal to value
:type (String) —

Filter results where type matches value
:type__in (Array<String>) —

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

Filter results where type not equal to 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<(PaginatedrpmUpdateRecordResponseList, Integer, Hash)>) —

PaginatedrpmUpdateRecordResponseList data, response status code and response headers

# File 'lib/pulp_rpm_client/api/content_advisories_api.rb', line 157

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentAdvisoriesApi.list ...'
  end
  allowable_values = ["-description", "-digest", "-fromstr", "-id", "-issued_date", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-pulp_type", "-pushcount", "-reboot_suggested", "-release", "-rights", "-severity", "-solution", "-status", "-summary", "-timestamp_of_interest", "-title", "-type", "-updated_date", "-upstream_id", "-version", "description", "digest", "fromstr", "id", "issued_date", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "pulp_type", "pushcount", "reboot_suggested", "release", "rights", "severity", "solution", "status", "summary", "timestamp_of_interest", "title", "type", "updated_date", "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/advisories/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
  query_params[:'id__in'] = @api_client.build_collection_param(opts[:'id__in'], :csv) if !opts[:'id__in'].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[:'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[:'severity'] = opts[:'severity'] if !opts[:'severity'].nil?
  query_params[:'severity__in'] = @api_client.build_collection_param(opts[:'severity__in'], :csv) if !opts[:'severity__in'].nil?
  query_params[:'severity__ne'] = opts[:'severity__ne'] if !opts[:'severity__ne'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'status__in'] = @api_client.build_collection_param(opts[:'status__in'], :csv) if !opts[:'status__in'].nil?
  query_params[:'status__ne'] = opts[:'status__ne'] if !opts[:'status__ne'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'type__in'] = @api_client.build_collection_param(opts[:'type__in'], :csv) if !opts[:'type__in'].nil?
  query_params[:'type__ne'] = opts[:'type__ne'] if !opts[:'type__ne'].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] || 'PaginatedrpmUpdateRecordResponseList' 

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

#read(rpm_update_record_href, opts = {}) ⇒ `RpmUpdateRecordResponse`

Inspect an update record

A ViewSet for UpdateRecord. Define endpoint name which will appear in the API endpoint for this content type. For example: pulp.example.com/pulp/api/v3/content/rpm/advisories/ Also specify queryset and serializer for UpdateRecord.

Parameters:

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

(RpmUpdateRecordResponse)

# File 'lib/pulp_rpm_client/api/content_advisories_api.rb', line 235

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

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

Inspect an update record

A ViewSet for UpdateRecord. Define endpoint name which will appear in the API endpoint for this content type. For example: pulp.example.com/pulp/api/v3/content/rpm/advisories/ Also specify queryset and serializer for UpdateRecord.

Parameters:

rpm_update_record_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<(RpmUpdateRecordResponse, Integer, Hash)>) —

RpmUpdateRecordResponse data, response status code and response headers

# File 'lib/pulp_rpm_client/api/content_advisories_api.rb', line 247

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

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

Class: PulpRpmClient::ContentAdvisoriesApi

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentAdvisoriesApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

#create(opts = {}) ⇒ AsyncOperationResponse

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

#list(opts = {}) ⇒ PaginatedrpmUpdateRecordResponseList

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

#read(rpm_update_record_href, opts = {}) ⇒ RpmUpdateRecordResponse

#read_with_http_info(rpm_update_record_href, opts = {}) ⇒ Array<(RpmUpdateRecordResponse, Integer, Hash)>

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

#api_client ⇒ `Object`

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

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

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

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

#read(rpm_update_record_href, opts = {}) ⇒ `RpmUpdateRecordResponse`

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