Class: PulpAnsibleClient::ContentNamespacesApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentNamespacesApi

Returns a new instance of ContentNamespacesApi.



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

def api_client
  @api_client
end

Instance Method Details

#avatar(ansible_ansible_namespace_metadata_href, opts = {}) ⇒ nil

Get the logo for the this namespace.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

  • (nil) 


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

def avatar(ansible_ansible_namespace_metadata_href, opts = {})
  avatar_with_http_info(ansible_ansible_namespace_metadata_href, opts)
  nil
end

#avatar_with_http_info(ansible_ansible_namespace_metadata_href, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get the logo for the this namespace.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

    nil, 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
 
# File 'lib/pulp_ansible_client/api/content_namespaces_api.rb', line 39

def avatar_with_http_info(ansible_ansible_namespace_metadata_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentNamespacesApi.avatar ...'
  end
  # verify the required parameter 'ansible_ansible_namespace_metadata_href' is set
  if @api_client.config.client_side_validation && ansible_ansible_namespace_metadata_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_ansible_namespace_metadata_href' when calling ContentNamespacesApi.avatar"
  end
  # resource path
  local_var_path = '{ansible_ansible_namespace_metadata_href}avatar/'.sub('{' + 'ansible_ansible_namespace_metadata_href' + '}', CGI.escape(ansible_ansible_namespace_metadata_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  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] 

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

#list(opts = {}) ⇒ PaginatedansibleAnsibleNamespaceMetadataResponseList

List ansible namespace metadatas ViewSet for AnsibleNamespace.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :company (String) —

    Filter results where company matches value

  • :company__contains (String) —

    Filter results where company contains value

  • :company__icontains (String) —

    Filter results where company contains value

  • :company__iexact (String) —

    Filter results where company matches value

  • :company__in (Array<String>) —

    Filter results where company is in a comma-separated list of values

  • :company__iregex (String) —

    Filter results where company matches regex value

  • :company__istartswith (String) —

    Filter results where company starts with value

  • :company__regex (String) —

    Filter results where company matches regex value

  • :company__startswith (String) —

    Filter results where company starts with value

  • :limit (Integer) —

    Number of results to return per page.

  • :metadata_sha256 (String) —

    Filter results where metadata_sha256 matches value

  • :metadata_sha256__in (Array<String>) —

    Filter results where metadata_sha256 is in a comma-separated list of values

  • :name (String) —

    Filter results where name matches value

  • :name__contains (String) —

    Filter results where name contains value

  • :name__icontains (String) —

    Filter results where name contains value

  • :name__iexact (String) —

    Filter results where name matches value

  • :name__in (Array<String>) —

    Filter results where name is in a comma-separated list of values

  • :name__iregex (String) —

    Filter results where name matches regex value

  • :name__istartswith (String) —

    Filter results where name starts with value

  • :name__regex (String) —

    Filter results where name matches regex value

  • :name__startswith (String) —

    Filter results where name starts with value

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;company&#x60; - Company * &#x60;-company&#x60; - Company (descending) * &#x60;email&#x60; - Email * &#x60;-email&#x60; - Email (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;resources&#x60; - Resources * &#x60;-resources&#x60; - Resources (descending) * &#x60;links&#x60; - Links * &#x60;-links&#x60; - Links (descending) * &#x60;avatar_sha256&#x60; - Avatar sha256 * &#x60;-avatar_sha256&#x60; - Avatar sha256 (descending) * &#x60;metadata_sha256&#x60; - Metadata sha256 * &#x60;-metadata_sha256&#x60; - Metadata sha256 (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :orphaned_for (Float) —

    Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

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

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



124
125
126
127
 
# File 'lib/pulp_ansible_client/api/content_namespaces_api.rb', line 124

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

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

List ansible namespace metadatas ViewSet for AnsibleNamespace.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :company (String) —

    Filter results where company matches value

  • :company__contains (String) —

    Filter results where company contains value

  • :company__icontains (String) —

    Filter results where company contains value

  • :company__iexact (String) —

    Filter results where company matches value

  • :company__in (Array<String>) —

    Filter results where company is in a comma-separated list of values

  • :company__iregex (String) —

    Filter results where company matches regex value

  • :company__istartswith (String) —

    Filter results where company starts with value

  • :company__regex (String) —

    Filter results where company matches regex value

  • :company__startswith (String) —

    Filter results where company starts with value

  • :limit (Integer) —

    Number of results to return per page.

  • :metadata_sha256 (String) —

    Filter results where metadata_sha256 matches value

  • :metadata_sha256__in (Array<String>) —

    Filter results where metadata_sha256 is in a comma-separated list of values

  • :name (String) —

    Filter results where name matches value

  • :name__contains (String) —

    Filter results where name contains value

  • :name__icontains (String) —

    Filter results where name contains value

  • :name__iexact (String) —

    Filter results where name matches value

  • :name__in (Array<String>) —

    Filter results where name is in a comma-separated list of values

  • :name__iregex (String) —

    Filter results where name matches regex value

  • :name__istartswith (String) —

    Filter results where name starts with value

  • :name__regex (String) —

    Filter results where name matches regex value

  • :name__startswith (String) —

    Filter results where name starts with value

  • :offset (Integer) —

    The initial index from which to return the results.

  • :ordering (Array<String>) —

    Ordering * &#x60;pulp_id&#x60; - Pulp id * &#x60;-pulp_id&#x60; - Pulp id (descending) * &#x60;pulp_created&#x60; - Pulp created * &#x60;-pulp_created&#x60; - Pulp created (descending) * &#x60;pulp_last_updated&#x60; - Pulp last updated * &#x60;-pulp_last_updated&#x60; - Pulp last updated (descending) * &#x60;pulp_type&#x60; - Pulp type * &#x60;-pulp_type&#x60; - Pulp type (descending) * &#x60;upstream_id&#x60; - Upstream id * &#x60;-upstream_id&#x60; - Upstream id (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;company&#x60; - Company * &#x60;-company&#x60; - Company (descending) * &#x60;email&#x60; - Email * &#x60;-email&#x60; - Email (descending) * &#x60;description&#x60; - Description * &#x60;-description&#x60; - Description (descending) * &#x60;resources&#x60; - Resources * &#x60;-resources&#x60; - Resources (descending) * &#x60;links&#x60; - Links * &#x60;-links&#x60; - Links (descending) * &#x60;avatar_sha256&#x60; - Avatar sha256 * &#x60;-avatar_sha256&#x60; - Avatar sha256 (descending) * &#x60;metadata_sha256&#x60; - Metadata sha256 * &#x60;-metadata_sha256&#x60; - Metadata sha256 (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :orphaned_for (Float) —

    Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

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

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



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

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentNamespacesApi.list ...'
  end
  allowable_values = ["-avatar_sha256", "-company", "-description", "-email", "-links", "-metadata_sha256", "-name", "-pk", "-pulp_created", "-pulp_id", "-pulp_last_updated", "-pulp_type", "-resources", "-timestamp_of_interest", "-upstream_id", "avatar_sha256", "company", "description", "email", "links", "metadata_sha256", "name", "pk", "pulp_created", "pulp_id", "pulp_last_updated", "pulp_type", "resources", "timestamp_of_interest", "upstream_id"]
  if @api_client.config.client_side_validation && opts[:'ordering'] && !opts[:'ordering'].all? { |item| allowable_values.include?(item) }
    fail ArgumentError, "invalid value for \"ordering\", must include one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/pulp/api/v3/content/ansible/namespaces/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'company'] = opts[:'company'] if !opts[:'company'].nil?
  query_params[:'company__contains'] = opts[:'company__contains'] if !opts[:'company__contains'].nil?
  query_params[:'company__icontains'] = opts[:'company__icontains'] if !opts[:'company__icontains'].nil?
  query_params[:'company__iexact'] = opts[:'company__iexact'] if !opts[:'company__iexact'].nil?
  query_params[:'company__in'] = @api_client.build_collection_param(opts[:'company__in'], :csv) if !opts[:'company__in'].nil?
  query_params[:'company__iregex'] = opts[:'company__iregex'] if !opts[:'company__iregex'].nil?
  query_params[:'company__istartswith'] = opts[:'company__istartswith'] if !opts[:'company__istartswith'].nil?
  query_params[:'company__regex'] = opts[:'company__regex'] if !opts[:'company__regex'].nil?
  query_params[:'company__startswith'] = opts[:'company__startswith'] if !opts[:'company__startswith'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'metadata_sha256'] = opts[:'metadata_sha256'] if !opts[:'metadata_sha256'].nil?
  query_params[:'metadata_sha256__in'] = @api_client.build_collection_param(opts[:'metadata_sha256__in'], :csv) if !opts[:'metadata_sha256__in'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'name__contains'] = opts[:'name__contains'] if !opts[:'name__contains'].nil?
  query_params[:'name__icontains'] = opts[:'name__icontains'] if !opts[:'name__icontains'].nil?
  query_params[:'name__iexact'] = opts[:'name__iexact'] if !opts[:'name__iexact'].nil?
  query_params[:'name__in'] = @api_client.build_collection_param(opts[:'name__in'], :csv) if !opts[:'name__in'].nil?
  query_params[:'name__iregex'] = opts[:'name__iregex'] if !opts[:'name__iregex'].nil?
  query_params[:'name__istartswith'] = opts[:'name__istartswith'] if !opts[:'name__istartswith'].nil?
  query_params[:'name__regex'] = opts[:'name__regex'] if !opts[:'name__regex'].nil?
  query_params[:'name__startswith'] = opts[:'name__startswith'] if !opts[:'name__startswith'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'ordering'] = @api_client.build_collection_param(opts[:'ordering'], :csv) if !opts[:'ordering'].nil?
  query_params[:'orphaned_for'] = opts[:'orphaned_for'] if !opts[:'orphaned_for'].nil?
  query_params[:'pulp_href__in'] = @api_client.build_collection_param(opts[:'pulp_href__in'], :csv) if !opts[:'pulp_href__in'].nil?
  query_params[:'pulp_id__in'] = @api_client.build_collection_param(opts[:'pulp_id__in'], :csv) if !opts[:'pulp_id__in'].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[:'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] || 'PaginatedansibleAnsibleNamespaceMetadataResponseList' 

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

#read(ansible_ansible_namespace_metadata_href, opts = {}) ⇒ AnsibleAnsibleNamespaceMetadataResponse

Inspect an ansible namespace metadata ViewSet for AnsibleNamespace.

Parameters:

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

    the optional parameters

Options Hash (opts):

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



251
252
253
254
 
# File 'lib/pulp_ansible_client/api/content_namespaces_api.rb', line 251

def read(ansible_ansible_namespace_metadata_href, opts = {})
  data, _status_code, _headers = read_with_http_info(ansible_ansible_namespace_metadata_href, opts)
  data
end

#read_with_http_info(ansible_ansible_namespace_metadata_href, opts = {}) ⇒ Array<(AnsibleAnsibleNamespaceMetadataResponse, Integer, Hash)>

Inspect an ansible namespace metadata ViewSet for AnsibleNamespace.

Parameters:

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

    the optional parameters

Options Hash (opts):

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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/pulp_ansible_client/api/content_namespaces_api.rb', line 263

def read_with_http_info(ansible_ansible_namespace_metadata_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentNamespacesApi.read ...'
  end
  # verify the required parameter 'ansible_ansible_namespace_metadata_href' is set
  if @api_client.config.client_side_validation && ansible_ansible_namespace_metadata_href.nil?
    fail ArgumentError, "Missing the required parameter 'ansible_ansible_namespace_metadata_href' when calling ContentNamespacesApi.read"
  end
  # resource path
  local_var_path = '{ansible_ansible_namespace_metadata_href}'.sub('{' + 'ansible_ansible_namespace_metadata_href' + '}', CGI.escape(ansible_ansible_namespace_metadata_href.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  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] || 'AnsibleAnsibleNamespaceMetadataResponse' 

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