Class: PulpcoreClient::DistributionsOpenpgpApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DistributionsOpenpgpApi

Returns a new instance of DistributionsOpenpgpApi.

[View source]

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

def api_client
  @api_client
end

Instance Method Details

#create(open_pgp_distribution, opts = {}) ⇒ AsyncOperationResponse

Create an open pgp distribution Trigger an asynchronous create task

Parameters:

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

    the optional parameters

Returns:

[View source]

27
28
29
30
 
# File 'lib/pulpcore_client/api/distributions_openpgp_api.rb', line 27

def create(open_pgp_distribution, opts = {})
  data, _status_code, _headers = create_with_http_info(open_pgp_distribution, opts)
  data
end

#create_with_http_info(open_pgp_distribution, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Create an open pgp distribution Trigger an asynchronous create task

Parameters:

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

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers

[View source]

37
38
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
87
88
 
# File 'lib/pulpcore_client/api/distributions_openpgp_api.rb', line 37

def create_with_http_info(open_pgp_distribution, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsOpenpgpApi.create ...'
  end
  # verify the required parameter 'open_pgp_distribution' is set
  if @api_client.config.client_side_validation && open_pgp_distribution.nil?
    fail ArgumentError, "Missing the required parameter 'open_pgp_distribution' when calling DistributionsOpenpgpApi.create"
  end
  # resource path
  local_var_path = '/pulp/api/v3/distributions/core/openpgp/'

  # 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(open_pgp_distribution)

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

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

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

#delete(open_p_g_p_distribution_href, opts = {}) ⇒ AsyncOperationResponse

Delete an open pgp distribution Trigger an asynchronous delete task

Parameters:

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

    the optional parameters

Returns:

[View source]

95
96
97
98
 
# File 'lib/pulpcore_client/api/distributions_openpgp_api.rb', line 95

def delete(open_p_g_p_distribution_href, opts = {})
  data, _status_code, _headers = delete_with_http_info(open_p_g_p_distribution_href, opts)
  data
end

#delete_with_http_info(open_p_g_p_distribution_href, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Delete an open pgp distribution Trigger an asynchronous delete task

Parameters:

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

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers

[View source]

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

def delete_with_http_info(open_p_g_p_distribution_href, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsOpenpgpApi.delete ...'
  end
  # verify the required parameter 'open_p_g_p_distribution_href' is set
  if @api_client.config.client_side_validation && open_p_g_p_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'open_p_g_p_distribution_href' when calling DistributionsOpenpgpApi.delete"
  end
  # resource path
  local_var_path = '{open_p_g_p_distribution_href}'.sub('{' + 'open_p_g_p_distribution_href' + '}', CGI.escape(open_p_g_p_distribution_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']

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

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

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

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

  new_options = opts.merge(
    :operation => :"DistributionsOpenpgpApi.delete",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DistributionsOpenpgpApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ PaginatedOpenPGPDistributionResponseList

List open pgp distributions Provides read and list methods and also provides asynchronous CUD methods to dispatch tasks with reservation that lock all Distributions preventing race conditions during base_path checking.

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;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;base_path&#x60; - Base path * &#x60;-base_path&#x60; - Base path (descending) * &#x60;hidden&#x60; - Hidden * &#x60;-hidden&#x60; - Hidden (descending) * &#x60;checkpoint&#x60; - Checkpoint * &#x60;-checkpoint&#x60; - Checkpoint (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

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

    Filter results where repository_version matches value

  • :with_content (String) —

    Filter distributions based on the content served by them

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

[View source]

169
170
171
172
 
# File 'lib/pulpcore_client/api/distributions_openpgp_api.rb', line 169

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

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

List open pgp distributions Provides read and list methods and also provides asynchronous CUD methods to dispatch tasks with reservation that lock all Distributions preventing race conditions during base_path checking.

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;name&#x60; - Name * &#x60;-name&#x60; - Name (descending) * &#x60;pulp_labels&#x60; - Pulp labels * &#x60;-pulp_labels&#x60; - Pulp labels (descending) * &#x60;base_path&#x60; - Base path * &#x60;-base_path&#x60; - Base path (descending) * &#x60;hidden&#x60; - Hidden * &#x60;-hidden&#x60; - Hidden (descending) * &#x60;checkpoint&#x60; - Checkpoint * &#x60;-checkpoint&#x60; - Checkpoint (descending) * &#x60;pk&#x60; - Pk * &#x60;-pk&#x60; - Pk (descending)

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

    Filter results where repository_version matches value

  • :with_content (String) —

    Filter distributions based on the content served by them

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

[View source]

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
243
244
245
246
247
248
 
# File 'lib/pulpcore_client/api/distributions_openpgp_api.rb', line 190

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsOpenpgpApi.list ...'
  end
  allowable_values = ["-base_path", "-checkpoint", "-hidden", "-name", "-pk", "-pulp_created", "-pulp_id", "-pulp_labels", "-pulp_last_updated", "-pulp_type", "base_path", "checkpoint", "hidden", "name", "pk", "pulp_created", "pulp_id", "pulp_labels", "pulp_last_updated", "pulp_type"]
  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/distributions/core/openpgp/'

  # 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[:'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[:'with_content'] = opts[:'with_content'] if !opts[:'with_content'].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] || 'PaginatedOpenPGPDistributionResponseList'

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

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

#partial_update(open_p_g_p_distribution_href, patched_open_pgp_distribution, opts = {}) ⇒ AsyncOperationResponse

Update an open pgp distribution Trigger an asynchronous partial update task

Parameters:

  • open_p_g_p_distribution_href (String)
  • patched_open_pgp_distribution (PatchedOpenPGPDistribution)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

[View source]

256
257
258
259
 
# File 'lib/pulpcore_client/api/distributions_openpgp_api.rb', line 256

def partial_update(open_p_g_p_distribution_href, patched_open_pgp_distribution, opts = {})
  data, _status_code, _headers = partial_update_with_http_info(open_p_g_p_distribution_href, patched_open_pgp_distribution, opts)
  data
end

#partial_update_with_http_info(open_p_g_p_distribution_href, patched_open_pgp_distribution, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Update an open pgp distribution Trigger an asynchronous partial update task

Parameters:

  • open_p_g_p_distribution_href (String)
  • patched_open_pgp_distribution (PatchedOpenPGPDistribution)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers

[View source]

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
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/pulpcore_client/api/distributions_openpgp_api.rb', line 267

def partial_update_with_http_info(open_p_g_p_distribution_href, patched_open_pgp_distribution, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsOpenpgpApi.partial_update ...'
  end
  # verify the required parameter 'open_p_g_p_distribution_href' is set
  if @api_client.config.client_side_validation && open_p_g_p_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'open_p_g_p_distribution_href' when calling DistributionsOpenpgpApi.partial_update"
  end
  # verify the required parameter 'patched_open_pgp_distribution' is set
  if @api_client.config.client_side_validation && patched_open_pgp_distribution.nil?
    fail ArgumentError, "Missing the required parameter 'patched_open_pgp_distribution' when calling DistributionsOpenpgpApi.partial_update"
  end
  # resource path
  local_var_path = '{open_p_g_p_distribution_href}'.sub('{' + 'open_p_g_p_distribution_href' + '}', CGI.escape(open_p_g_p_distribution_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(patched_open_pgp_distribution)

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

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

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

#read(open_p_g_p_distribution_href, opts = {}) ⇒ OpenPGPDistributionResponse

Inspect an open pgp distribution Provides read and list methods and also provides asynchronous CUD methods to dispatch tasks with reservation that lock all Distributions preventing race conditions during base_path checking.

Parameters:

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

[View source]

331
332
333
334
 
# File 'lib/pulpcore_client/api/distributions_openpgp_api.rb', line 331

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

#read_with_http_info(open_p_g_p_distribution_href, opts = {}) ⇒ Array<(OpenPGPDistributionResponse, Integer, Hash)>

Inspect an open pgp distribution Provides read and list methods and also provides asynchronous CUD methods to dispatch tasks with reservation that lock all Distributions preventing race conditions during base_path checking.

Parameters:

  • open_p_g_p_distribution_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<(OpenPGPDistributionResponse, Integer, Hash)>) —

    OpenPGPDistributionResponse data, response status code and response headers

[View source]

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
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/pulpcore_client/api/distributions_openpgp_api.rb', line 343

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

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

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

#set_label(open_p_g_p_distribution_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_distribution_href (String)
  • set_label (SetLabel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

[View source]

399
400
401
402
 
# File 'lib/pulpcore_client/api/distributions_openpgp_api.rb', line 399

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

#set_label_with_http_info(open_p_g_p_distribution_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_distribution_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

[View source]

410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/pulpcore_client/api/distributions_openpgp_api.rb', line 410

def set_label_with_http_info(open_p_g_p_distribution_href, set_label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsOpenpgpApi.set_label ...'
  end
  # verify the required parameter 'open_p_g_p_distribution_href' is set
  if @api_client.config.client_side_validation && open_p_g_p_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'open_p_g_p_distribution_href' when calling DistributionsOpenpgpApi.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 DistributionsOpenpgpApi.set_label"
  end
  # resource path
  local_var_path = '{open_p_g_p_distribution_href}set_label/'.sub('{' + 'open_p_g_p_distribution_href' + '}', CGI.escape(open_p_g_p_distribution_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 => :"DistributionsOpenpgpApi.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: DistributionsOpenpgpApi#set_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Unset a label Unset a single pulp_label on the object.

Parameters:

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

    the optional parameters

Returns:

[View source]

473
474
475
476
 
# File 'lib/pulpcore_client/api/distributions_openpgp_api.rb', line 473

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

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

Unset a label Unset a single pulp_label on the object.

Parameters:

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

[View source]

484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
 
# File 'lib/pulpcore_client/api/distributions_openpgp_api.rb', line 484

def unset_label_with_http_info(open_p_g_p_distribution_href, unset_label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsOpenpgpApi.unset_label ...'
  end
  # verify the required parameter 'open_p_g_p_distribution_href' is set
  if @api_client.config.client_side_validation && open_p_g_p_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'open_p_g_p_distribution_href' when calling DistributionsOpenpgpApi.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 DistributionsOpenpgpApi.unset_label"
  end
  # resource path
  local_var_path = '{open_p_g_p_distribution_href}unset_label/'.sub('{' + 'open_p_g_p_distribution_href' + '}', CGI.escape(open_p_g_p_distribution_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 => :"DistributionsOpenpgpApi.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: DistributionsOpenpgpApi#unset_label\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(open_p_g_p_distribution_href, open_pgp_distribution, opts = {}) ⇒ AsyncOperationResponse

Update an open pgp distribution Trigger an asynchronous update task

Parameters:

  • open_p_g_p_distribution_href (String)
  • open_pgp_distribution (OpenPGPDistribution)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

[View source]

547
548
549
550
 
# File 'lib/pulpcore_client/api/distributions_openpgp_api.rb', line 547

def update(open_p_g_p_distribution_href, open_pgp_distribution, opts = {})
  data, _status_code, _headers = update_with_http_info(open_p_g_p_distribution_href, open_pgp_distribution, opts)
  data
end

#update_with_http_info(open_p_g_p_distribution_href, open_pgp_distribution, opts = {}) ⇒ Array<(AsyncOperationResponse, Integer, Hash)>

Update an open pgp distribution Trigger an asynchronous update task

Parameters:

  • open_p_g_p_distribution_href (String)
  • open_pgp_distribution (OpenPGPDistribution)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    AsyncOperationResponse data, response status code and response headers

[View source]

558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
 
# File 'lib/pulpcore_client/api/distributions_openpgp_api.rb', line 558

def update_with_http_info(open_p_g_p_distribution_href, open_pgp_distribution, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DistributionsOpenpgpApi.update ...'
  end
  # verify the required parameter 'open_p_g_p_distribution_href' is set
  if @api_client.config.client_side_validation && open_p_g_p_distribution_href.nil?
    fail ArgumentError, "Missing the required parameter 'open_p_g_p_distribution_href' when calling DistributionsOpenpgpApi.update"
  end
  # verify the required parameter 'open_pgp_distribution' is set
  if @api_client.config.client_side_validation && open_pgp_distribution.nil?
    fail ArgumentError, "Missing the required parameter 'open_pgp_distribution' when calling DistributionsOpenpgpApi.update"
  end
  # resource path
  local_var_path = '{open_p_g_p_distribution_href}'.sub('{' + 'open_p_g_p_distribution_href' + '}', CGI.escape(open_p_g_p_distribution_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(open_pgp_distribution)

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

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

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