Class: PulpAnsibleClient::PulpAnsibleGalaxyApiCollectionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PulpAnsibleGalaxyApiCollectionsApi

Returns a new instance of PulpAnsibleGalaxyApiCollectionsApi.



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

def api_client
  @api_client
end

Instance Method Details

#list(path, opts = {}) ⇒ PaginatedCollectionResponseList

ViewSet for Collections.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :deprecated (String)
  • :limit (Integer) —

    Number of results to return per page.

  • :name (String)
  • :namespace (String)
  • :offset (Integer) —

    The initial index from which to return the results.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



33
34
35
36
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_collections_api.rb', line 33

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

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

ViewSet for Collections.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :deprecated (String)
  • :limit (Integer) —

    Number of results to return per page.

  • :name (String)
  • :namespace (String)
  • :offset (Integer) —

    The initial index from which to return the results.

  • :fields (String) —

    A list of fields to include in the response.

  • :exclude_fields (String) —

    A list of fields to exclude from the response.

Returns:



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
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_collections_api.rb', line 49

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'deprecated'] = opts[:'deprecated'] if !opts[:'deprecated'].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[:'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] || 'PaginatedCollectionResponseList' 

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

#read(name, namespace, path, opts = {}) ⇒ CollectionResponse

ViewSet for Collections.

Parameters:

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



111
112
113
114
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_collections_api.rb', line 111

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

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

ViewSet for Collections.

Parameters:

  • name (String)
  • namespace (String)
  • path (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<(CollectionResponse, Integer, Hash)>) —

    CollectionResponse data, response status code and response headers



124
125
126
127
128
129
130
131
132
133
134
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
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_collections_api.rb', line 124

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

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

#update(name, namespace, path, body, opts = {}) ⇒ CollectionResponse

Update a Collection object.

Parameters:

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

    the optional parameters

Returns:



188
189
190
191
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_collections_api.rb', line 188

def update(name, namespace, path, body, opts = {})
  data, _status_code, _headers = update_with_http_info(name, namespace, path, body, opts)
  data
end

#update_with_http_info(name, namespace, path, body, opts = {}) ⇒ Array<(CollectionResponse, Integer, Hash)>

Update a Collection object.

Parameters:

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

    the optional parameters

Returns:

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

    CollectionResponse data, response status code and response headers



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
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
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_galaxy_api_collections_api.rb', line 200

def update_with_http_info(name, namespace, path, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PulpAnsibleGalaxyApiCollectionsApi.update ...'
  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 PulpAnsibleGalaxyApiCollectionsApi.update"
  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 PulpAnsibleGalaxyApiCollectionsApi.update"
  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 PulpAnsibleGalaxyApiCollectionsApi.update"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling PulpAnsibleGalaxyApiCollectionsApi.update"
  end
  # resource path
  local_var_path = '/pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/'.sub('{' + 'name' + '}', CGI.escape(name.to_s).gsub('%2F', '/')).sub('{' + 'namespace' + '}', CGI.escape(namespace.to_s).gsub('%2F', '/')).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(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  # return_type
  return_type = opts[:return_type] || 'CollectionResponse' 

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