Class: PulpAnsibleClient::PulpAnsibleGalaxyApiV3CollectionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_v3_collections_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PulpAnsibleGalaxyApiV3CollectionsApi 



19
20
21
 
# 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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_v3_collections_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create(path, file, opts = {}) ⇒ AsyncOperationResponse

Upload a collection Create an artifact and trigger an asynchronous task to create Collection content from it.

Options Hash (opts):

  • :sha256 (String) —

    An optional sha256 checksum of the uploaded file.

  • :expected_namespace (String) —

    The expected 'namespace' of the Collection to be verified against the metadata during import.

  • :expected_name (String) —

    The expected 'name' of the Collection to be verified against the metadata during import.

  • :expected_version (String) —

    The expected version of the Collection to be verified against the metadata during import.



32
33
34
35
 
# 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 = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Upload a collection Create an artifact and trigger an asynchronous task to create Collection content from it.

Options Hash (opts):

  • :sha256 (String) —

    An optional sha256 checksum of the uploaded file.

  • :expected_namespace (String) —

    The expected &#39;namespace&#39; of the Collection to be verified against the metadata during import.

  • :expected_name (String) —

    The expected &#39;name&#39; of the Collection to be verified against the metadata during import.

  • :expected_version (String) —

    The expected version of the Collection to be verified against the metadata during import.



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# 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
  # 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] || []

  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