Class: PulpcoreClient::ContentOpenpgpUseridApi

Inherits:
Object
  • Object
show all
Defined in:
lib/pulpcore_client/api/content_openpgp_userid_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContentOpenpgpUseridApi

Returns a new instance of ContentOpenpgpUseridApi.



19
20
21
 
# File 'lib/pulpcore_client/api/content_openpgp_userid_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/pulpcore_client/api/content_openpgp_userid_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#list(opts = {}) ⇒ PaginatedOpenPGPUserIDResponseList

List open pgp user ids Content viewset that supports only GET by default.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :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;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;raw_data&#x60; - Raw data * &#x60;-raw_data&#x60; - Raw data (descending) * &#x60;user_id&#x60; - User id * &#x60;-user_id&#x60; - User id (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :orphaned_for (Float) —

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

  • :prn__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_label_select (String) —

    Filter labels by search string

  • :q (String) —

    Filter results by using NOT, AND and OR operations on other filters

  • :repository_version (String) —

    Repository Version referenced by HREF/PRN

  • :repository_version_added (String) —

    Repository Version referenced by HREF/PRN

  • :repository_version_removed (String) —

    Repository Version referenced by HREF/PRN

  • :user_id (String) —

    Filter results where user_id matches value

  • :user_id__contains (String) —

    Filter results where user_id contains value

  • :user_id__icontains (String) —

    Filter results where user_id contains value

  • :user_id__iexact (String) —

    Filter results where user_id matches value

  • :user_id__in (Array<String>) —

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

  • :user_id__iregex (String) —

    Filter results where user_id matches regex value

  • :user_id__istartswith (String) —

    Filter results where user_id starts with value

  • :user_id__regex (String) —

    Filter results where user_id matches regex value

  • :user_id__startswith (String) —

    Filter results where user_id starts with value

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



49
50
51
52
 
# File 'lib/pulpcore_client/api/content_openpgp_userid_api.rb', line 49

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

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

List open pgp user ids Content viewset that supports only GET by default.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of results to return per page.

  • :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;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;timestamp_of_interest&#x60; - Timestamp of interest * &#x60;-timestamp_of_interest&#x60; - Timestamp of interest (descending) * &#x60;raw_data&#x60; - Raw data * &#x60;-raw_data&#x60; - Raw data (descending) * &#x60;user_id&#x60; - User id * &#x60;-user_id&#x60; - User id (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

  • :orphaned_for (Float) —

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

  • :prn__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_href__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_id__in (Array<String>) —

    Multiple values may be separated by commas.

  • :pulp_label_select (String) —

    Filter labels by search string

  • :q (String) —

    Filter results by using NOT, AND and OR operations on other filters

  • :repository_version (String) —

    Repository Version referenced by HREF/PRN

  • :repository_version_added (String) —

    Repository Version referenced by HREF/PRN

  • :repository_version_removed (String) —

    Repository Version referenced by HREF/PRN

  • :user_id (String) —

    Filter results where user_id matches value

  • :user_id__contains (String) —

    Filter results where user_id contains value

  • :user_id__icontains (String) —

    Filter results where user_id contains value

  • :user_id__iexact (String) —

    Filter results where user_id matches value

  • :user_id__in (Array<String>) —

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

  • :user_id__iregex (String) —

    Filter results where user_id matches regex value

  • :user_id__istartswith (String) —

    Filter results where user_id starts with value

  • :user_id__regex (String) —

    Filter results where user_id matches regex value

  • :user_id__startswith (String) —

    Filter results where user_id starts with value

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



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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/pulpcore_client/api/content_openpgp_userid_api.rb', line 81

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentOpenpgpUseridApi.list ...'
  end
  allowable_values = ["-pk", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "-raw_data", "-timestamp_of_interest", "-upstream_id", "-user_id", "pk", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type", "raw_data", "timestamp_of_interest", "upstream_id", "user_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/core/openpgp_userid/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].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[:'prn__in'] = @api_client.build_collection_param(opts[:'prn__in'], :csv) if !opts[:'prn__in'].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[:'pulp_label_select'] = opts[:'pulp_label_select'] if !opts[:'pulp_label_select'].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[:'user_id'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'user_id__contains'] = opts[:'user_id__contains'] if !opts[:'user_id__contains'].nil?
  query_params[:'user_id__icontains'] = opts[:'user_id__icontains'] if !opts[:'user_id__icontains'].nil?
  query_params[:'user_id__iexact'] = opts[:'user_id__iexact'] if !opts[:'user_id__iexact'].nil?
  query_params[:'user_id__in'] = @api_client.build_collection_param(opts[:'user_id__in'], :csv) if !opts[:'user_id__in'].nil?
  query_params[:'user_id__iregex'] = opts[:'user_id__iregex'] if !opts[:'user_id__iregex'].nil?
  query_params[:'user_id__istartswith'] = opts[:'user_id__istartswith'] if !opts[:'user_id__istartswith'].nil?
  query_params[:'user_id__regex'] = opts[:'user_id__regex'] if !opts[:'user_id__regex'].nil?
  query_params[:'user_id__startswith'] = opts[:'user_id__startswith'] if !opts[:'user_id__startswith'].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']) unless header_params['Accept']

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'PaginatedOpenPGPUserIDResponseList'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ContentOpenpgpUseridApi.list",
    :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: ContentOpenpgpUseridApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#read(open_p_g_p_user_i_d_href, opts = {}) ⇒ OpenPGPUserIDResponse

Inspect an open pgp user id Content viewset that supports only GET by default.

Parameters:

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



159
160
161
162
 
# File 'lib/pulpcore_client/api/content_openpgp_userid_api.rb', line 159

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

#read_with_http_info(open_p_g_p_user_i_d_href, opts = {}) ⇒ Array<(OpenPGPUserIDResponse, Integer, Hash)>

Inspect an open pgp user id Content viewset that supports only GET by default.

Parameters:

  • open_p_g_p_user_i_d_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<(OpenPGPUserIDResponse, Integer, Hash)>) —

    OpenPGPUserIDResponse data, response status code and response headers



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
 
# File 'lib/pulpcore_client/api/content_openpgp_userid_api.rb', line 171

def read_with_http_info(open_p_g_p_user_i_d_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentOpenpgpUseridApi.read ...'
  end
  # verify the required parameter 'open_p_g_p_user_i_d_href' is set
  if @api_client.config.client_side_validation && open_p_g_p_user_i_d_href.nil?
    fail ArgumentError, "Missing the required parameter 'open_p_g_p_user_i_d_href' when calling ContentOpenpgpUseridApi.read"
  end
  # resource path
  local_var_path = '{open_p_g_p_user_i_d_href}'.sub('{' + 'open_p_g_p_user_i_d_href' + '}', CGI.escape(open_p_g_p_user_i_d_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']) unless header_params['Accept']

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'OpenPGPUserIDResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ContentOpenpgpUseridApi.read",
    :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: ContentOpenpgpUseridApi#read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#set_label(open_p_g_p_user_i_d_href, set_label, opts = {}) ⇒ SetLabelResponse

Set a label Set a single pulp_label on the object to a specific value or null.

Parameters:

  • open_p_g_p_user_i_d_href (String)
  • set_label (SetLabel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



227
228
229
230
 
# File 'lib/pulpcore_client/api/content_openpgp_userid_api.rb', line 227

def set_label(open_p_g_p_user_i_d_href, set_label, opts = {})
  data, _status_code, _headers = set_label_with_http_info(open_p_g_p_user_i_d_href, set_label, opts)
  data
end

#set_label_with_http_info(open_p_g_p_user_i_d_href, set_label, opts = {}) ⇒ Array<(SetLabelResponse, Integer, Hash)>

Set a label Set a single pulp_label on the object to a specific value or null.

Parameters:

  • open_p_g_p_user_i_d_href (String)
  • set_label (SetLabel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    SetLabelResponse data, response status code and response headers



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
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/pulpcore_client/api/content_openpgp_userid_api.rb', line 238

def set_label_with_http_info(open_p_g_p_user_i_d_href, set_label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentOpenpgpUseridApi.set_label ...'
  end
  # verify the required parameter 'open_p_g_p_user_i_d_href' is set
  if @api_client.config.client_side_validation && open_p_g_p_user_i_d_href.nil?
    fail ArgumentError, "Missing the required parameter 'open_p_g_p_user_i_d_href' when calling ContentOpenpgpUseridApi.set_label"
  end
  # verify the required parameter 'set_label' is set
  if @api_client.config.client_side_validation && set_label.nil?
    fail ArgumentError, "Missing the required parameter 'set_label' when calling ContentOpenpgpUseridApi.set_label"
  end
  # resource path
  local_var_path = '{open_p_g_p_user_i_d_href}set_label/'.sub('{' + 'open_p_g_p_user_i_d_href' + '}', CGI.escape(open_p_g_p_user_i_d_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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'SetLabelResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ContentOpenpgpUseridApi.set_label",
    :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: ContentOpenpgpUseridApi#set_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unset_label(open_p_g_p_user_i_d_href, unset_label, opts = {}) ⇒ UnsetLabelResponse

Unset a label Unset a single pulp_label on the object.

Parameters:

  • open_p_g_p_user_i_d_href (String)
  • unset_label (UnsetLabel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



301
302
303
304
 
# File 'lib/pulpcore_client/api/content_openpgp_userid_api.rb', line 301

def unset_label(open_p_g_p_user_i_d_href, unset_label, opts = {})
  data, _status_code, _headers = unset_label_with_http_info(open_p_g_p_user_i_d_href, unset_label, opts)
  data
end

#unset_label_with_http_info(open_p_g_p_user_i_d_href, unset_label, opts = {}) ⇒ Array<(UnsetLabelResponse, Integer, Hash)>

Unset a label Unset a single pulp_label on the object.

Parameters:

  • open_p_g_p_user_i_d_href (String)
  • unset_label (UnsetLabel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    UnsetLabelResponse data, response status code and response headers



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/pulpcore_client/api/content_openpgp_userid_api.rb', line 312

def unset_label_with_http_info(open_p_g_p_user_i_d_href, unset_label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContentOpenpgpUseridApi.unset_label ...'
  end
  # verify the required parameter 'open_p_g_p_user_i_d_href' is set
  if @api_client.config.client_side_validation && open_p_g_p_user_i_d_href.nil?
    fail ArgumentError, "Missing the required parameter 'open_p_g_p_user_i_d_href' when calling ContentOpenpgpUseridApi.unset_label"
  end
  # verify the required parameter 'unset_label' is set
  if @api_client.config.client_side_validation && unset_label.nil?
    fail ArgumentError, "Missing the required parameter 'unset_label' when calling ContentOpenpgpUseridApi.unset_label"
  end
  # resource path
  local_var_path = '{open_p_g_p_user_i_d_href}unset_label/'.sub('{' + 'open_p_g_p_user_i_d_href' + '}', CGI.escape(open_p_g_p_user_i_d_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']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded', 'multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

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

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

  # return_type
  return_type = opts[:debug_return_type] || 'UnsetLabelResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['basicAuth']

  new_options = opts.merge(
    :operation => :"ContentOpenpgpUseridApi.unset_label",
    :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: ContentOpenpgpUseridApi#unset_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end