Class: PulpAnsibleClient::ApiPluginAnsibleSearchCollectionVersionsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ApiPluginAnsibleSearchCollectionVersionsApi

Returns a new instance of ApiPluginAnsibleSearchCollectionVersionsApi.



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

def api_client
  @api_client
end

Instance Method Details

#list(ansible_cross_repository_collection_version_index_href, opts = {}) ⇒ PaginatedCollectionVersionSearchListResponseList

List cross repository collection version indexs A viewset for cross-repo searches.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :dependency (String)
  • :deprecated (Boolean)
  • :distribution (Array<String>) —

    Filter collectionversions that are in these distrubtion ids.

  • :distribution_base_path (Array<String>) —

    Filter collectionversions that are in these base paths.

  • :highest (Boolean)
  • :is_deprecated (Boolean)
  • :is_highest (Boolean)
  • :is_signed (Boolean)
  • :keywords (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.

  • :order_by (Array<String>) —

    Ordering * &#x60;pulp_created&#x60; - by CV created * &#x60;-pulp_created&#x60; - by CV created (descending) * &#x60;namespace&#x60; - by CV namespace * &#x60;-namespace&#x60; - by CV namespace (descending) * &#x60;name&#x60; - by CV name * &#x60;-name&#x60; - by CV name (descending) * &#x60;version&#x60; - by CV version * &#x60;-version&#x60; - by CV version (descending)

  • :q (String)
  • :repository (Array<String>) —

    Filter collectionversions that are in these repository ids.

  • :repository_label (String) —

    Filter labels by search string

  • :repository_name (Array<String>) —

    Filter collectionversions that are in these repositories.

  • :repository_version (String)
  • :signed (Boolean)
  • :tags (String) —

    Filter by comma separate list of tags that must all be matched

  • :version (String)
  • :version_range (String)
  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



52
53
54
55
 
# File 'lib/pulp_ansible_client/api/api_plugin_ansible_search_collection_versions_api.rb', line 52

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

#list_with_http_info(ansible_cross_repository_collection_version_index_href, opts = {}) ⇒ Array<(PaginatedCollectionVersionSearchListResponseList, Integer, Hash)>

List cross repository collection version indexs A viewset for cross-repo searches.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :dependency (String)
  • :deprecated (Boolean)
  • :distribution (Array<String>) —

    Filter collectionversions that are in these distrubtion ids.

  • :distribution_base_path (Array<String>) —

    Filter collectionversions that are in these base paths.

  • :highest (Boolean)
  • :is_deprecated (Boolean)
  • :is_highest (Boolean)
  • :is_signed (Boolean)
  • :keywords (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.

  • :order_by (Array<String>) —

    Ordering * &#x60;pulp_created&#x60; - by CV created * &#x60;-pulp_created&#x60; - by CV created (descending) * &#x60;namespace&#x60; - by CV namespace * &#x60;-namespace&#x60; - by CV namespace (descending) * &#x60;name&#x60; - by CV name * &#x60;-name&#x60; - by CV name (descending) * &#x60;version&#x60; - by CV version * &#x60;-version&#x60; - by CV version (descending)

  • :q (String)
  • :repository (Array<String>) —

    Filter collectionversions that are in these repository ids.

  • :repository_label (String) —

    Filter labels by search string

  • :repository_name (Array<String>) —

    Filter collectionversions that are in these repositories.

  • :repository_version (String)
  • :signed (Boolean)
  • :tags (String) —

    Filter by comma separate list of tags that must all be matched

  • :version (String)
  • :version_range (String)
  • :fields (Array<String>) —

    A list of fields to include in the response.

  • :exclude_fields (Array<String>) —

    A list of fields to exclude from the response.

Returns:



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

def list_with_http_info(ansible_cross_repository_collection_version_index_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApiPluginAnsibleSearchCollectionVersionsApi.list ...'
  end
  # verify the required parameter 'ansible_cross_repository_collection_version_index_href' is set
  if @api_client.config.client_side_validation && ansible_cross_repository_collection_version_index_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_cross_repository_collection_version_index_href' when calling ApiPluginAnsibleSearchCollectionVersionsApi.list"
  end
  allowable_values = ["-name", "-namespace", "-pulp_created", "-version", "name", "namespace", "pulp_created", "version"]
  if @api_client.config.client_side_validation && opts[:'order_by'] && !opts[:'order_by'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"order_by\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '{ansible_cross_repository_collection_version_index_href}api/v3/plugin/ansible/search/collection-versions/'.sub('{' + 'ansible_cross_repository_collection_version_index_href' + '}', CGI.escape(ansible_cross_repository_collection_version_index_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'dependency'] = opts[:'dependency'] if !opts[:'dependency'].nil?
  query_params[:'deprecated'] = opts[:'deprecated'] if !opts[:'deprecated'].nil?
  query_params[:'distribution'] = @api_client.build_collection_param(opts[:'distribution'], :multi) if !opts[:'distribution'].nil?
  query_params[:'distribution_base_path'] = @api_client.build_collection_param(opts[:'distribution_base_path'], :multi) if !opts[:'distribution_base_path'].nil?
  query_params[:'highest'] = opts[:'highest'] if !opts[:'highest'].nil?
  query_params[:'is_deprecated'] = opts[:'is_deprecated'] if !opts[:'is_deprecated'].nil?
  query_params[:'is_highest'] = opts[:'is_highest'] if !opts[:'is_highest'].nil?
  query_params[:'is_signed'] = opts[:'is_signed'] if !opts[:'is_signed'].nil?
  query_params[:'keywords'] = opts[:'keywords'] if !opts[:'keywords'].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[:'order_by'] = @api_client.build_collection_param(opts[:'order_by'], :csv) if !opts[:'order_by'].nil?
  query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
  query_params[:'repository'] = @api_client.build_collection_param(opts[:'repository'], :multi) if !opts[:'repository'].nil?
  query_params[:'repository_label'] = opts[:'repository_label'] if !opts[:'repository_label'].nil?
  query_params[:'repository_name'] = @api_client.build_collection_param(opts[:'repository_name'], :multi) if !opts[:'repository_name'].nil?
  query_params[:'repository_version'] = opts[:'repository_version'] if !opts[:'repository_version'].nil?
  query_params[:'signed'] = opts[:'signed'] if !opts[:'signed'].nil?
  query_params[:'tags'] = opts[:'tags'] if !opts[:'tags'].nil?
  query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
  query_params[:'version_range'] = opts[:'version_range'] if !opts[:'version_range'].nil?
  query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :multi) if !opts[:'fields'].nil?
  query_params[:'exclude_fields'] = @api_client.build_collection_param(opts[:'exclude_fields'], :multi) 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] || 'PaginatedCollectionVersionSearchListResponseList' 

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

#rebuild(ansible_cross_repository_collection_version_index_href, collection_version_search_list, opts = {}) ⇒ CollectionVersionSearchListResponse

A viewset for cross-repo searches.

Parameters:

  • ansible_cross_repository_collection_version_index_href (String)
  • collection_version_search_list (CollectionVersionSearchList)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



168
169
170
171
 
# File 'lib/pulp_ansible_client/api/api_plugin_ansible_search_collection_versions_api.rb', line 168

def rebuild(ansible_cross_repository_collection_version_index_href, collection_version_search_list, opts = {})
  data, _status_code, _headers = rebuild_with_http_info(ansible_cross_repository_collection_version_index_href, collection_version_search_list, opts)
  data
end

#rebuild_with_http_info(ansible_cross_repository_collection_version_index_href, collection_version_search_list, opts = {}) ⇒ Array<(CollectionVersionSearchListResponse, Integer, Hash)>

A viewset for cross-repo searches.

Parameters:

  • ansible_cross_repository_collection_version_index_href (String)
  • collection_version_search_list (CollectionVersionSearchList)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/pulp_ansible_client/api/api_plugin_ansible_search_collection_versions_api.rb', line 178

def rebuild_with_http_info(ansible_cross_repository_collection_version_index_href, collection_version_search_list, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ApiPluginAnsibleSearchCollectionVersionsApi.rebuild ...'
  end
  # verify the required parameter 'ansible_cross_repository_collection_version_index_href' is set
  if @api_client.config.client_side_validation && ansible_cross_repository_collection_version_index_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_cross_repository_collection_version_index_href' when calling ApiPluginAnsibleSearchCollectionVersionsApi.rebuild"
  end
  # verify the required parameter 'collection_version_search_list' is set
  if @api_client.config.client_side_validation && collection_version_search_list.nil?
    fail ArgumentError, "Missing the required parameter 'collection_version_search_list' when calling ApiPluginAnsibleSearchCollectionVersionsApi.rebuild"
  end
  # resource path
  local_var_path = '{ansible_cross_repository_collection_version_index_href}api/v3/plugin/ansible/search/collection-versions/'.sub('{' + 'ansible_cross_repository_collection_version_index_href' + '}', CGI.escape(ansible_cross_repository_collection_version_index_href.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(collection_version_search_list) 

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

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