Class: PulpAnsibleClient::PulpAnsibleApiV3CollectionsVersionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PulpAnsibleApiV3CollectionsVersionsApi

Returns a new instance of PulpAnsibleApiV3CollectionsVersionsApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Returns paginated CollectionVersions list.

Parameters:

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



41
42
43
44
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_api_v3_collections_versions_api.rb', line 41

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

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

Returns paginated CollectionVersions list.

Parameters:

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



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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_api_v3_collections_versions_api.rb', line 65

def list_with_http_info(name, namespace, path, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PulpAnsibleApiV3CollectionsVersionsApi.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 PulpAnsibleApiV3CollectionsVersionsApi.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 PulpAnsibleApiV3CollectionsVersionsApi.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 PulpAnsibleApiV3CollectionsVersionsApi.list"
  end
  # resource path
  local_var_path = '/pulp_ansible/galaxy/{path}/api/v3/collections/{namespace}/{name}/versions/'.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[:'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] || 'PaginatedCollectionVersionResponseList' 

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

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

Returns a CollectionVersion object.

Parameters:

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



142
143
144
145
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_api_v3_collections_versions_api.rb', line 142

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

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

Returns a CollectionVersion object.

Parameters:

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



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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/pulp_ansible_client/api/pulp_ansible_api_v3_collections_versions_api.rb', line 156

def read_with_http_info(name, namespace, path, version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: PulpAnsibleApiV3CollectionsVersionsApi.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 PulpAnsibleApiV3CollectionsVersionsApi.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 PulpAnsibleApiV3CollectionsVersionsApi.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 PulpAnsibleApiV3CollectionsVersionsApi.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 PulpAnsibleApiV3CollectionsVersionsApi.read"
  end
  # resource path
  local_var_path = '/pulp_ansible/galaxy/{path}/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('{' + 'path' + '}', CGI.escape(path.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] || []

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