Class: PulpAnsibleClient::PulpAnsibleDefaultApiV3CollectionsVersionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PulpAnsibleDefaultApiV3CollectionsVersionsApi

Returns a new instance of PulpAnsibleDefaultApiV3CollectionsVersionsApi.



19
20
21
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_collections_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/pulp_ansible_default_api_v3_collections_versions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete(name, namespace, version, opts = {}) ⇒ AsyncOperationResponse

Legacy v3 endpoint.

Parameters:

  • name (String)
  • namespace (String)
  • version (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_collections_versions_api.rb', line 28

def delete(name, namespace, version, opts = {})
  data, _status_code, _headers = delete_with_http_info(name, namespace, version, opts)
  data
end

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

Legacy v3 endpoint.

Parameters:

  • name (String)
  • namespace (String)
  • version (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers



39
40
41
42
43
44
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
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_collections_versions_api.rb', line 39

def delete_with_http_info(name, namespace, version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PulpAnsibleDefaultApiV3CollectionsVersionsApi.delete ...'
  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 PulpAnsibleDefaultApiV3CollectionsVersionsApi.delete"
  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 PulpAnsibleDefaultApiV3CollectionsVersionsApi.delete"
  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 PulpAnsibleDefaultApiV3CollectionsVersionsApi.delete"
  end
  # resource path
  local_var_path = '/pulp_ansible/galaxy/default/api/v3/collections/{namespace}/{name}/versions/{version}/'.sub('{' + 'name' + '}', CGI.escape(name.to_s).gsub('%2F', '/')).sub('{' + 'namespace' + '}', CGI.escape(namespace.to_s).gsub('%2F', '/')).sub('{' + 'version' + '}', CGI.escape(version.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'])

  # form parameters
  form_params = opts[:form_params] || {}

  # 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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PulpAnsibleDefaultApiV3CollectionsVersionsApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(name, namespace, opts = {}) ⇒ PaginatedCollectionVersionListResponseList

Legacy v3 endpoint.

Parameters:

  • name (String)
  • namespace (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :is_highest (Boolean)
  • :limit (Integer) —

    Number of results to return per page.

  • :name2 (String)
  • :namespace2 (String)
  • :offset (Integer) —

    The initial index from which to return 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:



112
113
114
115
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_collections_versions_api.rb', line 112

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

#list_with_http_info(name, namespace, opts = {}) ⇒ Array<(PaginatedCollectionVersionListResponseList, Integer, Hash)>

Legacy v3 endpoint.

Parameters:

  • name (String)
  • namespace (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :is_highest (Boolean)
  • :limit (Integer) —

    Number of results to return per page.

  • :name2 (String)
  • :namespace2 (String)
  • :offset (Integer) —

    The initial index from which to return 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:



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
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
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_collections_versions_api.rb', line 135

def list_with_http_info(name, namespace, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PulpAnsibleDefaultApiV3CollectionsVersionsApi.list ...'
  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 PulpAnsibleDefaultApiV3CollectionsVersionsApi.list"
  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 PulpAnsibleDefaultApiV3CollectionsVersionsApi.list"
  end
  # resource path
  local_var_path = '/pulp_ansible/galaxy/default/api/v3/collections/{namespace}/{name}/versions/'.sub('{' + 'name' + '}', CGI.escape(name.to_s).gsub('%2F', '/')).sub('{' + 'namespace' + '}', CGI.escape(namespace.to_s).gsub('%2F', '/'))

  # 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[:'name2'] if !opts[:'name2'].nil?
  query_params[:'namespace'] = opts[:'namespace2'] if !opts[:'namespace2'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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] || 'PaginatedCollectionVersionListResponseList' 

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

#read(name, namespace, version, opts = {}) ⇒ CollectionVersionResponse

Legacy v3 endpoint.

Parameters:

  • name (String)
  • namespace (String)
  • version (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:



207
208
209
210
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_collections_versions_api.rb', line 207

def read(name, namespace, version, opts = {})
  data, _status_code, _headers = read_with_http_info(name, namespace, version, opts)
  data
end

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

Legacy v3 endpoint.

Parameters:

  • name (String)
  • namespace (String)
  • version (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:

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

    CollectionVersionResponse data, response status code and response headers



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
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
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_default_api_v3_collections_versions_api.rb', line 220

def read_with_http_info(name, namespace, version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PulpAnsibleDefaultApiV3CollectionsVersionsApi.read ...'
  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 PulpAnsibleDefaultApiV3CollectionsVersionsApi.read"
  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 PulpAnsibleDefaultApiV3CollectionsVersionsApi.read"
  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 PulpAnsibleDefaultApiV3CollectionsVersionsApi.read"
  end
  # resource path
  local_var_path = '/pulp_ansible/galaxy/default/api/v3/collections/{namespace}/{name}/versions/{version}/'.sub('{' + 'name' + '}', CGI.escape(name.to_s).gsub('%2F', '/')).sub('{' + 'namespace' + '}', CGI.escape(namespace.to_s).gsub('%2F', '/')).sub('{' + 'version' + '}', CGI.escape(version.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] || 'CollectionVersionResponse' 

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