Class: PulpAnsibleClient::ContentCollectionVersionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

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(name, namespace, version, opts = {}) ⇒ AsyncOperationResponse

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

Parameters:

  • name (String) —

    The name of the collection.

  • namespace (String) —

    The namespace of the collection.

  • version (String) —

    The version of the collection.

  • 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.

  • :file (File) —

    An uploaded file that may be turned into the artifact of the content unit.

Returns:



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

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

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

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

Parameters:

  • name (String) —

    The name of the collection.

  • namespace (String) —

    The namespace of the collection.

  • version (String) —

    The version of the collection.

  • 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.

  • :file (File) —

    An uploaded file that may be turned into the artifact of the content unit.

Returns:

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

    AsyncOperationResponse data, response status code and response headers



45
46
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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/pulp_ansible_client/api/content_collection_versions_api.rb', line 45

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

  # verify the required parameter 'namespace' is set
  if @api_client.config.client_side_validation && namespace.nil?
    fail ArgumentError, "Missing the required parameter 'namespace' when calling ContentCollectionVersionsApi.create"
  end
  if @api_client.config.client_side_validation && namespace.to_s.length > 64
    fail ArgumentError, 'invalid value for "namespace" when calling ContentCollectionVersionsApi.create, the character length must be smaller than or equal to 64.'
  end

  # verify the required parameter 'version' is set
  if @api_client.config.client_side_validation && version.nil?
    fail ArgumentError, "Missing the required parameter 'version' when calling ContentCollectionVersionsApi.create"
  end
  if @api_client.config.client_side_validation && version.to_s.length > 128
    fail ArgumentError, 'invalid value for "version" when calling ContentCollectionVersionsApi.create, the character length must be smaller than or equal to 128.'
  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['name'] = name
  form_params['namespace'] = namespace
  form_params['version'] = version
  form_params['repository'] = opts[:'repository'] if !opts[:'repository'].nil?
  form_params['file'] = opts[:'file'] if !opts[:'file'].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 (String) —

    Which field to use when ordering the results.

  • :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 (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



137
138
139
140
 
# File 'lib/pulp_ansible_client/api/content_collection_versions_api.rb', line 137

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 (String) —

    Which field to use when ordering the results.

  • :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 (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/pulp_ansible_client/api/content_collection_versions_api.rb', line 160

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentCollectionVersionsApi.list ...'
  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'] = opts[:'ordering'] if !opts[:'ordering'].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'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] 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 (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



224
225
226
227
 
# File 'lib/pulp_ansible_client/api/content_collection_versions_api.rb', line 224

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 (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/pulp_ansible_client/api/content_collection_versions_api.rb', line 236

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'] = opts[:'fields'] if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = opts[:'exclude_fields'] 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