Class: PulpcoreClient::ContentOpenpgpSignatureApi

Inherits:

Object

Object
PulpcoreClient::ContentOpenpgpSignatureApi

show all

Defined in:: lib/pulpcore_client/api/content_openpgp_signature_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) ⇒ ContentOpenpgpSignatureApi constructor

A new instance of ContentOpenpgpSignatureApi.
#list(opts = {}) ⇒ PaginatedOpenPGPSignatureResponseList

List open pgp signatures Content viewset that supports only GET by default.
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedOpenPGPSignatureResponseList, Integer, Hash)>

List open pgp signatures Content viewset that supports only GET by default.
#read(open_p_g_p_signature_href, opts = {}) ⇒ OpenPGPSignatureResponse

Inspect an open pgp signature Content viewset that supports only GET by default.
#read_with_http_info(open_p_g_p_signature_href, opts = {}) ⇒ Array<(OpenPGPSignatureResponse, Integer, Hash)>

Inspect an open pgp signature Content viewset that supports only GET by default.

Constructor Details

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

Returns a new instance of ContentOpenpgpSignatureApi.



19
20
21

# File 'lib/pulpcore_client/api/content_openpgp_signature_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/pulpcore_client/api/content_openpgp_signature_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

List open pgp signatures Content viewset that supports only GET by default.

Parameters:

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

the optional parameters

Options Hash (opts):

:issuer (String) —

Filter results where issuer 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) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `raw_data` - Raw data * `-raw_data` - Raw data (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `signature_type` - Signature type * `-signature_type` - Signature type (descending) * `created` - Created * `-created` - Created (descending) * `expiration_time` - Expiration time * `-expiration_time` - Expiration time (descending) * `key_expiration_time` - Key expiration time * `-key_expiration_time` - Key expiration time (descending) * `issuer` - Issuer * `-issuer` - Issuer (descending) * `signers_user_id` - Signers user id * `-signers_user_id` - Signers user id (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.
:pulp_label_select (String) —

Filter labels by search string
: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:

(PaginatedOpenPGPSignatureResponseList)

# File 'lib/pulpcore_client/api/content_openpgp_signature_api.rb', line 41

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

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

List open pgp signatures Content viewset that supports only GET by default.

Parameters:

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

the optional parameters

Options Hash (opts):

:issuer (String) —

Filter results where issuer 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) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `raw_data` - Raw data * `-raw_data` - Raw data (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `signature_type` - Signature type * `-signature_type` - Signature type (descending) * `created` - Created * `-created` - Created (descending) * `expiration_time` - Expiration time * `-expiration_time` - Expiration time (descending) * `key_expiration_time` - Key expiration time * `-key_expiration_time` - Key expiration time (descending) * `issuer` - Issuer * `-issuer` - Issuer (descending) * `signers_user_id` - Signers user id * `-signers_user_id` - Signers user id (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.
:pulp_label_select (String) —

Filter labels by search string
: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<(PaginatedOpenPGPSignatureResponseList, Integer, Hash)>) —

PaginatedOpenPGPSignatureResponseList data, response status code and response headers

# File 'lib/pulpcore_client/api/content_openpgp_signature_api.rb', line 65

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentOpenpgpSignatureApi.list ...'
  end
  allowable_values = ["-created", "-expiration_time", "-issuer", "-key_expiration_time", "-pk", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-raw_data", "-sha256", "-signature_type", "-signers_user_id", "-timestamp_of_interest", "-upstream_id", "created", "expiration_time", "issuer", "key_expiration_time", "pk", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "raw_data", "sha256", "signature_type", "signers_user_id", "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/core/openpgp_signature/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'issuer'] = opts[:'issuer'] if !opts[:'issuer'].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[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].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']) unless header_params['Accept']

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'PaginatedOpenPGPSignatureResponseList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ContentOpenpgpSignatureApi.list",
    :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: ContentOpenpgpSignatureApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read(open_p_g_p_signature_href, opts = {}) ⇒ `OpenPGPSignatureResponse`

Inspect an open pgp signature Content viewset that supports only GET by default.

Parameters:

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

(OpenPGPSignatureResponse)

# File 'lib/pulpcore_client/api/content_openpgp_signature_api.rb', line 135

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

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

Inspect an open pgp signature Content viewset that supports only GET by default.

Parameters:

open_p_g_p_signature_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<(OpenPGPSignatureResponse, Integer, Hash)>) —

OpenPGPSignatureResponse data, response status code and response headers

# File 'lib/pulpcore_client/api/content_openpgp_signature_api.rb', line 147

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

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'OpenPGPSignatureResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ContentOpenpgpSignatureApi.read",
    :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: ContentOpenpgpSignatureApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Class: PulpcoreClient::ContentOpenpgpSignatureApi

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentOpenpgpSignatureApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

#list(opts = {}) ⇒ PaginatedOpenPGPSignatureResponseList

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

#read(open_p_g_p_signature_href, opts = {}) ⇒ OpenPGPSignatureResponse

#read_with_http_info(open_p_g_p_signature_href, opts = {}) ⇒ Array<(OpenPGPSignatureResponse, Integer, Hash)>

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

#api_client ⇒ `Object`

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

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

#read(open_p_g_p_signature_href, opts = {}) ⇒ `OpenPGPSignatureResponse`

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