class PulpAnsibleClient::PulpAnsibleGalaxyApiV3CollectionsApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_v3_collections_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

create(path, file, opts = {}) click to toggle source

Upload a collection Create an artifact and trigger an asynchronous task to create Collection content from it. @param path [String] @param file [File] The Collection tarball. @param [Hash] opts the optional parameters @option opts [String] :sha256 An optional sha256 checksum of the uploaded file. @option opts [String] :expected_namespace The expected 'namespace' of the Collection to be verified against the metadata during import. @option opts [String] :expected_name The expected 'name' of the Collection to be verified against the metadata during import. @option opts [String] :expected_version The expected version of the Collection to be verified against the metadata during import. @return [AsyncOperationResponse]

# File lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_v3_collections_api.rb, line 32
def create(path, file, opts = {})
  data, _status_code, _headers = create_with_http_info(path, file, opts)
  data
end
create_with_http_info(path, file, opts = {}) click to toggle source

Upload a collection Create an artifact and trigger an asynchronous task to create Collection content from it. @param path [String] @param file [File] The Collection tarball. @param [Hash] opts the optional parameters @option opts [String] :sha256 An optional sha256 checksum of the uploaded file. @option opts [String] :expected_namespace The expected &#39;namespace&#39; of the Collection to be verified against the metadata during import. @option opts [String] :expected_name The expected &#39;name&#39; of the Collection to be verified against the metadata during import. @option opts [String] :expected_version The expected version of the Collection to be verified against the metadata during import. @return [Array<(AsyncOperationResponse, Integer, Hash)>] AsyncOperationResponse data, response status code and response headers

# File lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_v3_collections_api.rb, line 47
def create_with_http_info(path, file, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PulpAnsibleGalaxyApiV3CollectionsApi.create ...'
  end
  # verify the required parameter 'path' is set
  if @api_client.config.client_side_validation && path.nil?
    fail ArgumentError, "Missing the required parameter 'path' when calling PulpAnsibleGalaxyApiV3CollectionsApi.create"
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling PulpAnsibleGalaxyApiV3CollectionsApi.create"
  end
  if @api_client.config.client_side_validation && !opts[:'sha256'].nil? && opts[:'sha256'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"sha256"]" when calling PulpAnsibleGalaxyApiV3CollectionsApi.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 < 1
    fail ArgumentError, 'invalid value for "opts[:"expected_namespace"]" when calling PulpAnsibleGalaxyApiV3CollectionsApi.create, the character length must be great than or equal to 1.'
  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 PulpAnsibleGalaxyApiV3CollectionsApi.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 < 1
    fail ArgumentError, 'invalid value for "opts[:"expected_version"]" when calling PulpAnsibleGalaxyApiV3CollectionsApi.create, the character length must be great than or equal to 1.'
  end

  # resource path
  local_var_path = '/pulp_ansible/galaxy/{path}/api/v3/artifacts/collections/'.sub('{' + 'path' + '}', CGI.escape(path.to_s).gsub('%2F', '/'))

  # 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'] = file
  form_params['sha256'] = opts[:'sha256'] if !opts[:'sha256'].nil?
  form_params['expected_namespace'] = opts[:'expected_namespace'] if !opts[:'expected_namespace'].nil?
  form_params['expected_name'] = opts[:'expected_name'] if !opts[:'expected_name'].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] || ['Basic']

  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: PulpAnsibleGalaxyApiV3CollectionsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end
read(collection_import_href, opts = {}) click to toggle source

Inspect a collection import Returns a CollectionImport object. @param collection_import_href [String] URI of Collection Import. e.g.: /pulp_ansible/galaxy/1/api/v3/imports/collections/1/ @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @option opts [DateTime] :since Filter messages since a given timestamp @return [CollectionImportDetail]

# File lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_v3_collections_api.rb, line 129
def read(collection_import_href, opts = {})
  data, _status_code, _headers = read_with_http_info(collection_import_href, opts)
  data
end
read_with_http_info(collection_import_href, opts = {}) click to toggle source

Inspect a collection import Returns a CollectionImport object. @param collection_import_href [String] URI of Collection Import. e.g.: /pulp_ansible/galaxy/1/api/v3/imports/collections/1/ @param [Hash] opts the optional parameters @option opts [String] :fields A list of fields to include in the response. @option opts [String] :exclude_fields A list of fields to exclude from the response. @option opts [DateTime] :since Filter messages since a given timestamp @return [Array<(CollectionImportDetail, Integer, Hash)>] CollectionImportDetail data, response status code and response headers

# File lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_v3_collections_api.rb, line 142
def read_with_http_info(collection_import_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PulpAnsibleGalaxyApiV3CollectionsApi.read ...'
  end
  # verify the required parameter 'collection_import_href' is set
  if @api_client.config.client_side_validation && collection_import_href.nil?
    fail ArgumentError, "Missing the required parameter 'collection_import_href' when calling PulpAnsibleGalaxyApiV3CollectionsApi.read"
  end
  # resource path
  local_var_path = '{collection_import_href}'.sub('{' + 'collection_import_href' + '}', CGI.escape(collection_import_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'fields'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] if !opts[:'exclude_fields'].nil?
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].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] || 'CollectionImportDetail' 

  # auth_names
  auth_names = opts[:auth_names] || ['Basic']

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