Class: VSphereAutomation::Content::SubscribedLibraryApi

Inherits:
Object
  • Object
show all
Defined in:
lib/vsphere-automation-content/api/subscribed_library_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SubscribedLibraryApi

Returns a new instance of SubscribedLibraryApi.



16
17
18
 
# File 'lib/vsphere-automation-content/api/subscribed_library_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/vsphere-automation-content/api/subscribed_library_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create(request_body, opts = {}) ⇒ ContentSubscribedLibraryCreateResult|VapiStdErrorsResourceInaccessibleError|

Creates a new subscribed library. <p> Once created, the subscribed library will be empty. If the LibraryModel#subscriptionInfo property is set, the Content Library Service will attempt to synchronize to the remote source. This is an asynchronous operation so the content of the published library may not immediately appear.

Parameters:

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

    the optional parameters

Returns:



23
24
25
26
 
# File 'lib/vsphere-automation-content/api/subscribed_library_api.rb', line 23

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

#create_with_http_info(request_body, opts = {}) ⇒ Array<(ContentSubscribedLibraryCreateResult|VapiStdErrorsResourceInaccessibleError|, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Creates a new subscribed library. &lt;p&gt; Once created, the subscribed library will be empty. If the LibraryModel#subscriptionInfo property is set, the Content Library Service will attempt to synchronize to the remote source. This is an asynchronous operation so the content of the published library may not immediately appear.

Parameters:

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

    the optional parameters

Returns:



33
34
35
36
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
 
# File 'lib/vsphere-automation-content/api/subscribed_library_api.rb', line 33

def create_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribedLibraryApi.create ...'
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling SubscribedLibraryApi.create"
  end
  # resource path
  local_var_path = '/com/vmware/content/subscribed-library'

  # query parameters
  query_params = {}

  # header parameters
  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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request_body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
	:return_type => {
	  '200' => 'Content::ContentSubscribedLibraryCreateResult',
	  '400' => 'Content::VapiStdErrorsResourceInaccessibleError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscribedLibraryApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete(library_id, opts = {}) ⇒ |VapiStdErrorsInvalidElementTypeError|VapiStdErrorsNotFoundError|nil

Deletes the specified subscribed library. <p> Deleting a subscribed library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

Parameters:

  • library_id —

    Identifier of the subscribed library to delete.

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

    the optional parameters

Returns:



79
80
81
82
 
# File 'lib/vsphere-automation-content/api/subscribed_library_api.rb', line 79

def delete(library_id, opts = {})
  delete_with_http_info(library_id, opts)
  nil
end

#delete_with_http_info(library_id, opts = {}) ⇒ Array<(|VapiStdErrorsInvalidElementTypeError|VapiStdErrorsNotFoundError|nil, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deletes the specified subscribed library. &lt;p&gt; Deleting a subscribed library will remove the entry immediately and begin an asynchronous task to remove all cached content for the library. If the asynchronous task fails, file content may remain on the storage backing. This content will require manual removal.

Parameters:

  • library_id —

    Identifier of the subscribed library to delete.

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

    the optional parameters

Returns:



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
 
# File 'lib/vsphere-automation-content/api/subscribed_library_api.rb', line 89

def delete_with_http_info(library_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribedLibraryApi.delete ...'
  end
  # verify the required parameter 'library_id' is set
  if @api_client.config.client_side_validation && library_id.nil?
    fail ArgumentError, "Missing the required parameter 'library_id' when calling SubscribedLibraryApi.delete"
  end
  # resource path
  local_var_path = '/com/vmware/content/subscribed-library/id:{library_id}'.sub('{' + 'library_id' + '}', library_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscribedLibraryApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#evict(library_id, opts = {}) ⇒ |VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsNotFoundError|nil

Evicts the cached content of an on-demand subscribed library. <p> This operation allows the cached content of a subscribed library to be removed to free up storage capacity. This operation will only work when a subscribed library is synchronized on-demand.

Parameters:

  • library_id —

    Identifier of the subscribed library whose content should be evicted.

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

    the optional parameters

Returns:



129
130
131
132
 
# File 'lib/vsphere-automation-content/api/subscribed_library_api.rb', line 129

def evict(library_id, opts = {})
  evict_with_http_info(library_id, opts)
  nil
end

#evict_with_http_info(library_id, opts = {}) ⇒ Array<(|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsNotFoundError|nil, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Evicts the cached content of an on-demand subscribed library. &lt;p&gt; This operation allows the cached content of a subscribed library to be removed to free up storage capacity. This operation will only work when a subscribed library is synchronized on-demand.

Parameters:

  • library_id —

    Identifier of the subscribed library whose content should be evicted.

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

    the optional parameters

Returns:



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/vsphere-automation-content/api/subscribed_library_api.rb', line 139

def evict_with_http_info(library_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribedLibraryApi.evict ...'
  end
  # verify the required parameter 'library_id' is set
  if @api_client.config.client_side_validation && library_id.nil?
    fail ArgumentError, "Missing the required parameter 'library_id' when calling SubscribedLibraryApi.evict"
  end
  # resource path
  local_var_path = '/com/vmware/content/subscribed-library/id:{library_id}?~action=evict'.sub('{' + 'library_id' + '}', library_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscribedLibraryApi#evict\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get(library_id, opts = {}) ⇒ ContentSubscribedLibraryResult|VapiStdErrorsInvalidElementTypeError|VapiStdErrorsNotFoundError|

Returns a given subscribed library.

Parameters:

  • library_id —

    Identifier of the subscribed library to return.

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

    the optional parameters

Returns:



179
180
181
182
 
# File 'lib/vsphere-automation-content/api/subscribed_library_api.rb', line 179

def get(library_id, opts = {})
  data, _status_code, _headers = get_with_http_info(library_id, opts)
  data
end

#get_with_http_info(library_id, opts = {}) ⇒ Array<(ContentSubscribedLibraryResult|VapiStdErrorsInvalidElementTypeError|VapiStdErrorsNotFoundError|, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a given subscribed library.

Parameters:

  • library_id —

    Identifier of the subscribed library to return.

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

    the optional parameters

Returns:



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/vsphere-automation-content/api/subscribed_library_api.rb', line 189

def get_with_http_info(library_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribedLibraryApi.get ...'
  end
  # verify the required parameter 'library_id' is set
  if @api_client.config.client_side_validation && library_id.nil?
    fail ArgumentError, "Missing the required parameter 'library_id' when calling SubscribedLibraryApi.get"
  end
  # resource path
  local_var_path = '/com/vmware/content/subscribed-library/id:{library_id}'.sub('{' + 'library_id' + '}', library_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
	:return_type => {
	  '200' => 'Content::ContentSubscribedLibraryResult',
	  '400' => 'Content::VapiStdErrorsInvalidElementTypeError',
	  '404' => 'Content::VapiStdErrorsNotFoundError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscribedLibraryApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ ContentSubscribedLibraryListResult|

Returns the identifiers of all subscribed libraries in the Content Library.

Parameters:

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

    the optional parameters

Returns:



233
234
235
236
 
# File 'lib/vsphere-automation-content/api/subscribed_library_api.rb', line 233

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

#list_with_http_info(opts = {}) ⇒ Array<(ContentSubscribedLibraryListResult|, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the identifiers of all subscribed libraries in the Content Library.

Parameters:

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

    the optional parameters

Returns:



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
 
# File 'lib/vsphere-automation-content/api/subscribed_library_api.rb', line 242

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribedLibraryApi.list ...'
  end
  # resource path
  local_var_path = '/com/vmware/content/subscribed-library'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
	:return_type => {
	  '200' => 'Content::ContentSubscribedLibraryListResult',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscribedLibraryApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#probe(request_body, opts = {}) ⇒ ContentSubscribedLibraryProbeResult|

Probes remote library subscription information, including URL, SSL certificate and password. The resulting ProbeResult structure describes whether or not the subscription configuration is successful.

Parameters:

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

    the optional parameters

Returns:



281
282
283
284
 
# File 'lib/vsphere-automation-content/api/subscribed_library_api.rb', line 281

def probe(request_body, opts = {})
  data, _status_code, _headers = probe_with_http_info(request_body, opts)
  data
end

#probe_with_http_info(request_body, opts = {}) ⇒ Array<(ContentSubscribedLibraryProbeResult|, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Probes remote library subscription information, including URL, SSL certificate and password. The resulting ProbeResult structure describes whether or not the subscription configuration is successful.

Parameters:

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

    the optional parameters

Returns:



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
323
324
325
326
327
328
329
330
331
 
# File 'lib/vsphere-automation-content/api/subscribed_library_api.rb', line 291

def probe_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribedLibraryApi.probe ...'
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling SubscribedLibraryApi.probe"
  end
  # resource path
  local_var_path = '/com/vmware/content/subscribed-library?~action=probe'

  # query parameters
  query_params = {}

  # header parameters
  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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request_body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
	:return_type => {
	  '200' => 'Content::ContentSubscribedLibraryProbeResult',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscribedLibraryApi#probe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#sync(library_id, opts = {}) ⇒ |VapiStdErrorsResourceInaccessibleError|VapiStdErrorsNotFoundError|nil

Forces the synchronization of the subscribed library. <p> Synchronizing a subscribed library forcefully with this operation will perform the same synchronization behavior as would run periodically for the library. The SubscriptionInfo#onDemand setting is respected. Calling this operation on a library that is already in the process of synchronizing will have no effect.

Parameters:

  • library_id —

    Identifier of the subscribed library to synchronize.

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

    the optional parameters

Returns:



336
337
338
339
 
# File 'lib/vsphere-automation-content/api/subscribed_library_api.rb', line 336

def sync(library_id, opts = {})
  sync_with_http_info(library_id, opts)
  nil
end

#sync_with_http_info(library_id, opts = {}) ⇒ Array<(|VapiStdErrorsResourceInaccessibleError|VapiStdErrorsNotFoundError|nil, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Forces the synchronization of the subscribed library. &lt;p&gt; Synchronizing a subscribed library forcefully with this operation will perform the same synchronization behavior as would run periodically for the library. The SubscriptionInfo#onDemand setting is respected. Calling this operation on a library that is already in the process of synchronizing will have no effect.

Parameters:

  • library_id —

    Identifier of the subscribed library to synchronize.

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

    the optional parameters

Returns:



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
 
# File 'lib/vsphere-automation-content/api/subscribed_library_api.rb', line 346

def sync_with_http_info(library_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribedLibraryApi.sync ...'
  end
  # verify the required parameter 'library_id' is set
  if @api_client.config.client_side_validation && library_id.nil?
    fail ArgumentError, "Missing the required parameter 'library_id' when calling SubscribedLibraryApi.sync"
  end
  # resource path
  local_var_path = '/com/vmware/content/subscribed-library/id:{library_id}?~action=sync'.sub('{' + 'library_id' + '}', library_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscribedLibraryApi#sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update(library_id, request_body, opts = {}) ⇒ |VapiStdErrorsConcurrentChangeError|VapiStdErrorsNotFoundError|nil

Updates the properties of a subscribed library. <p> This is an incremental update to the subscribed library. Fields that are unset in the update specification will be left unchanged.

Parameters:

  • library_id —

    Identifier of the subscribed library to update.

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

    the optional parameters

Returns:



387
388
389
390
 
# File 'lib/vsphere-automation-content/api/subscribed_library_api.rb', line 387

def update(library_id, request_body, opts = {})
  update_with_http_info(library_id, request_body, opts)
  nil
end

#update_with_http_info(library_id, request_body, opts = {}) ⇒ Array<(|VapiStdErrorsConcurrentChangeError|VapiStdErrorsNotFoundError|nil, Fixnum, Hash)>

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Updates the properties of a subscribed library. &lt;p&gt; This is an incremental update to the subscribed library. Fields that are unset in the update specification will be left unchanged.

Parameters:

  • library_id —

    Identifier of the subscribed library to update.

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

    the optional parameters

Returns:



398
399
400
401
402
403
404
405
406
407
408
409
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
 
# File 'lib/vsphere-automation-content/api/subscribed_library_api.rb', line 398

def update_with_http_info(library_id, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscribedLibraryApi.update ...'
  end
  # verify the required parameter 'library_id' is set
  if @api_client.config.client_side_validation && library_id.nil?
    fail ArgumentError, "Missing the required parameter 'library_id' when calling SubscribedLibraryApi.update"
  end
  # verify the required parameter 'request_body' is set
  if @api_client.config.client_side_validation && request_body.nil?
    fail ArgumentError, "Missing the required parameter 'request_body' when calling SubscribedLibraryApi.update"
  end
  # resource path
  local_var_path = '/com/vmware/content/subscribed-library/id:{library_id}'.sub('{' + 'library_id' + '}', library_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request_body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubscribedLibraryApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end