Class: PulpAnsibleClient::ContentCollectionVersionsApi

Inherits:

Object

Object
PulpAnsibleClient::ContentCollectionVersionsApi

show all

Defined in:: lib/pulp_ansible_client/api/content_collection_versions_api.rb

Instance Attribute Summary collapse

#api_client ⇒ Object

Returns the value of attribute api_client.

Instance Method Summary collapse

#create(opts = {}) ⇒ AsyncOperationResponse

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

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

A new instance of ContentCollectionVersionsApi.
#list(opts = {}) ⇒ PaginatedansibleCollectionVersionResponseList

List collection versions ViewSet for Ansible Collection.
#list_with_http_info(opts = {}) ⇒ Array<(PaginatedansibleCollectionVersionResponseList, Integer, Hash)>

List collection versions ViewSet for Ansible Collection.
#read(ansible_collection_version_href, opts = {}) ⇒ AnsibleCollectionVersionResponse

Inspect a collection version ViewSet for Ansible Collection.
#read_with_http_info(ansible_collection_version_href, opts = {}) ⇒ Array<(AnsibleCollectionVersionResponse, Integer, Hash)>

Inspect a collection version ViewSet for Ansible Collection.

Constructor Details

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

Returns a new instance of ContentCollectionVersionsApi.



19
20
21

# File 'lib/pulp_ansible_client/api/content_collection_versions_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_ansible_client/api/content_collection_versions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

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

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

Parameters:

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

the optional parameters

Options Hash (opts):

:file (File) —

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

Artifact file representing the physical content
:repository (String) —

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

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

The name of the collection.
:expected_namespace (String) —

The namespace of the collection.
:expected_version (String) —

The version of the collection.

Returns:

(AsyncOperationResponse)

# File 'lib/pulp_ansible_client/api/content_collection_versions_api.rb', line 33

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

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

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

Parameters:

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

the optional parameters

Options Hash (opts):

:file (File) —

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

Artifact file representing the physical content
:repository (String) —

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

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

The name of the collection.
:expected_namespace (String) —

The namespace of the collection.
:expected_version (String) —

The version of the collection.

Returns:

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

AsyncOperationResponse data, response status code and response headers

# File 'lib/pulp_ansible_client/api/content_collection_versions_api.rb', line 49

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

  if @api_client.config.client_side_validation && !opts[:'expected_name'].nil? && opts[:'expected_name'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"expected_name"]" when calling ContentCollectionVersionsApi.create, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'expected_namespace'].nil? && opts[:'expected_namespace'].to_s.length > 64
    fail ArgumentError, 'invalid value for "opts[:"expected_namespace"]" when calling ContentCollectionVersionsApi.create, the character length must be smaller than or equal to 64.'
  end

  if @api_client.config.client_side_validation && !opts[:'expected_namespace'].nil? && opts[:'expected_namespace'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"expected_namespace"]" when calling ContentCollectionVersionsApi.create, the character length must be great than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'expected_version'].nil? && opts[:'expected_version'].to_s.length > 128
    fail ArgumentError, 'invalid value for "opts[:"expected_version"]" when calling ContentCollectionVersionsApi.create, the character length must be smaller than or equal to 128.'
  end

  if @api_client.config.client_side_validation && !opts[:'expected_version'].nil? && opts[:'expected_version'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"expected_version"]" when calling ContentCollectionVersionsApi.create, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/pulp/api/v3/content/ansible/collection_versions/'

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

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

List collection versions ViewSet for Ansible Collection.

Parameters:

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

the optional parameters

Options Hash (opts):

:is_highest (Boolean)
:limit (Integer) —

Number of results to return per page.
:name (String)
:namespace (String)
: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) * `authors` - Authors * `-authors` - Authors (descending) * `contents` - Contents * `-contents` - Contents (descending) * `dependencies` - Dependencies * `-dependencies` - Dependencies (descending) * `description` - Description * `-description` - Description (descending) * `docs_blob` - Docs blob * `-docs_blob` - Docs blob (descending) * `manifest` - Manifest * `-manifest` - Manifest (descending) * `files` - Files * `-files` - Files (descending) * `documentation` - Documentation * `-documentation` - Documentation (descending) * `homepage` - Homepage * `-homepage` - Homepage (descending) * `issues` - Issues * `-issues` - Issues (descending) * `license` - License * `-license` - License (descending) * `name` - Name * `-name` - Name (descending) * `namespace` - Namespace * `-namespace` - Namespace (descending) * `repository` - Repository * `-repository` - Repository (descending) * `requires_ansible` - Requires ansible * `-requires_ansible` - Requires ansible (descending) * `version` - Version * `-version` - Version (descending) * `version_major` - Version major * `-version_major` - Version major (descending) * `version_minor` - Version minor * `-version_minor` - Version minor (descending) * `version_patch` - Version patch * `-version_patch` - Version patch (descending) * `version_prerelease` - Version prerelease * `-version_prerelease` - Version prerelease (descending) * `is_highest` - Is highest * `-is_highest` - Is highest (descending) * `search_vector` - Search vector * `-search_vector` - Search vector (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)
: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
:tags (String) —

Filter by comma separate list of tags that must all be matched
: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:

(PaginatedansibleCollectionVersionResponseList)

# File 'lib/pulp_ansible_client/api/content_collection_versions_api.rb', line 146

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

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

List collection versions ViewSet for Ansible Collection.

Parameters:

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

the optional parameters

Options Hash (opts):

:is_highest (Boolean)
:limit (Integer) —

Number of results to return per page.
:name (String)
:namespace (String)
: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) * `authors` - Authors * `-authors` - Authors (descending) * `contents` - Contents * `-contents` - Contents (descending) * `dependencies` - Dependencies * `-dependencies` - Dependencies (descending) * `description` - Description * `-description` - Description (descending) * `docs_blob` - Docs blob * `-docs_blob` - Docs blob (descending) * `manifest` - Manifest * `-manifest` - Manifest (descending) * `files` - Files * `-files` - Files (descending) * `documentation` - Documentation * `-documentation` - Documentation (descending) * `homepage` - Homepage * `-homepage` - Homepage (descending) * `issues` - Issues * `-issues` - Issues (descending) * `license` - License * `-license` - License (descending) * `name` - Name * `-name` - Name (descending) * `namespace` - Namespace * `-namespace` - Namespace (descending) * `repository` - Repository * `-repository` - Repository (descending) * `requires_ansible` - Requires ansible * `-requires_ansible` - Requires ansible (descending) * `version` - Version * `-version` - Version (descending) * `version_major` - Version major * `-version_major` - Version major (descending) * `version_minor` - Version minor * `-version_minor` - Version minor (descending) * `version_patch` - Version patch * `-version_patch` - Version patch (descending) * `version_prerelease` - Version prerelease * `-version_prerelease` - Version prerelease (descending) * `is_highest` - Is highest * `-is_highest` - Is highest (descending) * `search_vector` - Search vector * `-search_vector` - Search vector (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)
: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
:tags (String) —

Filter by comma separate list of tags that must all be matched
: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<(PaginatedansibleCollectionVersionResponseList, Integer, Hash)>) —

PaginatedansibleCollectionVersionResponseList data, response status code and response headers

# File 'lib/pulp_ansible_client/api/content_collection_versions_api.rb', line 172

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentCollectionVersionsApi.list ...'
  end
  allowable_values = ["-authors", "-contents", "-dependencies", "-description", "-docs_blob", "-documentation", "-files", "-homepage", "-is_highest", "-issues", "-license", "-manifest", "-name", "-namespace", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-pulp_type", "-repository", "-requires_ansible", "-search_vector", "-timestamp_of_interest", "-upstream_id", "-version", "-version_major", "-version_minor", "-version_patch", "-version_prerelease", "authors", "contents", "dependencies", "description", "docs_blob", "documentation", "files", "homepage", "is_highest", "issues", "license", "manifest", "name", "namespace", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "pulp_type", "repository", "requires_ansible", "search_vector", "timestamp_of_interest", "upstream_id", "version", "version_major", "version_minor", "version_patch", "version_prerelease"]
  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/ansible/collection_versions/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'is_highest'] = opts[:'is_highest'] if !opts[:'is_highest'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'namespace'] = opts[:'namespace'] if !opts[:'namespace'].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[:'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[:'tags'] = opts[:'tags'] if !opts[:'tags'].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] || 'PaginatedansibleCollectionVersionResponseList' 

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

#read(ansible_collection_version_href, opts = {}) ⇒ `AnsibleCollectionVersionResponse`

Inspect a collection version ViewSet for Ansible Collection.

Parameters:

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

(AnsibleCollectionVersionResponse)

# File 'lib/pulp_ansible_client/api/content_collection_versions_api.rb', line 243

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

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

Inspect a collection version ViewSet for Ansible Collection.

Parameters:

ansible_collection_version_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<(AnsibleCollectionVersionResponse, Integer, Hash)>) —

AnsibleCollectionVersionResponse data, response status code and response headers

# File 'lib/pulp_ansible_client/api/content_collection_versions_api.rb', line 255

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

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

Class: PulpAnsibleClient::ContentCollectionVersionsApi

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentCollectionVersionsApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

#create(opts = {}) ⇒ AsyncOperationResponse

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

#list(opts = {}) ⇒ PaginatedansibleCollectionVersionResponseList

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

#read(ansible_collection_version_href, opts = {}) ⇒ AnsibleCollectionVersionResponse

#read_with_http_info(ansible_collection_version_href, opts = {}) ⇒ Array<(AnsibleCollectionVersionResponse, Integer, Hash)>

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

#api_client ⇒ `Object`

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

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

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

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

#read(ansible_collection_version_href, opts = {}) ⇒ `AnsibleCollectionVersionResponse`

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