Class: PulpDebClient::ContentGenericContentsApi

Inherits:

Object

Object
PulpDebClient::ContentGenericContentsApi

show all

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

Instance Attribute Summary collapse

#api_client ⇒ Object

Returns the value of attribute api_client.

Instance Method Summary collapse

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

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

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

A new instance of ContentGenericContentsApi.
#list(opts = {}) ⇒ PaginateddebGenericContentResponseList

List generic contents GenericContent is a catch all category for storing files not covered by any other type.
#list_with_http_info(opts = {}) ⇒ Array<(PaginateddebGenericContentResponseList, Integer, Hash)>

List generic contents GenericContent is a catch all category for storing files not covered by any other type.
#read(deb_generic_content_href, opts = {}) ⇒ DebGenericContentResponse

Inspect a generic content GenericContent is a catch all category for storing files not covered by any other type.
#read_with_http_info(deb_generic_content_href, opts = {}) ⇒ Array<(DebGenericContentResponse, Integer, Hash)>

Inspect a generic content GenericContent is a catch all category for storing files not covered by any other type.

Constructor Details

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

Returns a new instance of ContentGenericContentsApi.



19
20
21

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

def api_client
  @api_client
end

Instance Method Details

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

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

Parameters:

relative_path (String) —

Path where the artifact is located relative to distributions base_path
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.
:artifact (String) —

Artifact file representing the physical content
: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.

Returns:

(AsyncOperationResponse)

# File 'lib/pulp_deb_client/api/content_generic_contents_api.rb', line 31

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

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

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

Parameters:

relative_path (String) —

Path where the artifact is located relative to distributions base_path
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.
:artifact (String) —

Artifact file representing the physical content
: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.

Returns:

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

AsyncOperationResponse data, response status code and response headers

# File 'lib/pulp_deb_client/api/content_generic_contents_api.rb', line 45

def create_with_http_info(relative_path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentGenericContentsApi.create ...'
  end
  # verify the required parameter 'relative_path' is set
  if @api_client.config.client_side_validation && relative_path.nil?
    fail ArgumentError, "Missing the required parameter 'relative_path' when calling ContentGenericContentsApi.create"
  end
  if @api_client.config.client_side_validation && relative_path.to_s.length < 1
    fail ArgumentError, 'invalid value for "relative_path" when calling ContentGenericContentsApi.create, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/pulp/api/v3/content/deb/generic_contents/'

  # 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['relative_path'] = relative_path
  form_params['repository'] = opts[:'repository'] if !opts[:'repository'].nil?
  form_params['artifact'] = opts[:'artifact'] if !opts[:'artifact'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
  form_params['upload'] = opts[:'upload'] if !opts[:'upload'].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: ContentGenericContentsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

List generic contents GenericContent is a catch all category for storing files not covered by any other type. Associated artifacts: Exactly one arbitrary file that does not match any other type. This is needed to store arbitrary files for use with the verbatim publisher. If you are not using the verbatim publisher, you may ignore this type.

Parameters:

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

the optional parameters

Options Hash (opts):

: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) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `pk` - Pk * `-pk` - Pk (descending)
:orphaned_for (Float) —

Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
: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)
:relative_path (String) —

Filter results where relative_path matches value
:repository_version (String) —

Repository Version referenced by HREF
:repository_version_added (String) —

Repository Version referenced by HREF
:repository_version_removed (String) —

Repository Version referenced by HREF
:sha256 (String) —

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

(PaginateddebGenericContentResponseList)

# File 'lib/pulp_deb_client/api/content_generic_contents_api.rb', line 121

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

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

Parameters:

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

the optional parameters

Options Hash (opts):

: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) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `sha256` - Sha256 * `-sha256` - Sha256 (descending) * `pk` - Pk * `-pk` - Pk (descending)
:orphaned_for (Float) —

Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
: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)
:relative_path (String) —

Filter results where relative_path matches value
:repository_version (String) —

Repository Version referenced by HREF
:repository_version_added (String) —

Repository Version referenced by HREF
:repository_version_removed (String) —

Repository Version referenced by HREF
:sha256 (String) —

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

PaginateddebGenericContentResponseList data, response status code and response headers

# File 'lib/pulp_deb_client/api/content_generic_contents_api.rb', line 144

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

  # query parameters
  query_params = opts[:query_params] || {}
  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[:'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[:'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] || 'PaginateddebGenericContentResponseList' 

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

#read(deb_generic_content_href, opts = {}) ⇒ `DebGenericContentResponse`

Inspect a generic content GenericContent is a catch all category for storing files not covered by any other type. Associated artifacts: Exactly one arbitrary file that does not match any other type. This is needed to store arbitrary files for use with the verbatim publisher. If you are not using the verbatim publisher, you may ignore this type.

Parameters:

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

(DebGenericContentResponse)

# File 'lib/pulp_deb_client/api/content_generic_contents_api.rb', line 212

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

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

Parameters:

deb_generic_content_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<(DebGenericContentResponse, Integer, Hash)>) —

DebGenericContentResponse data, response status code and response headers

# File 'lib/pulp_deb_client/api/content_generic_contents_api.rb', line 224

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

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

Class: PulpDebClient::ContentGenericContentsApi

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentGenericContentsApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

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

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

#list(opts = {}) ⇒ PaginateddebGenericContentResponseList

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

#read(deb_generic_content_href, opts = {}) ⇒ DebGenericContentResponse

#read_with_http_info(deb_generic_content_href, opts = {}) ⇒ Array<(DebGenericContentResponse, Integer, Hash)>

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

#api_client ⇒ `Object`

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

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

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

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

#read(deb_generic_content_href, opts = {}) ⇒ `DebGenericContentResponse`

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