Class: VSphereAutomation::Content::LocalLibraryApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LocalLibraryApi

Returns a new instance of LocalLibraryApi.



16
17
18
 
# File 'lib/vsphere-automation-content/api/local_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/local_library_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#create(request_body, opts = {}) ⇒ ContentLocalLibraryCreateResult|VapiStdErrorsUnsupportedError|

Creates a new local library.

Parameters:

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

    the optional parameters

Returns:



23
24
25
26
 
# File 'lib/vsphere-automation-content/api/local_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<(ContentLocalLibraryCreateResult|VapiStdErrorsUnsupportedError|, 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 local library.

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/local_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: LocalLibraryApi.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 LocalLibraryApi.create"
  end
  # resource path
  local_var_path = '/com/vmware/content/local-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::ContentLocalLibraryCreateResult',
	  '400' => 'Content::VapiStdErrorsUnsupportedError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LocalLibraryApi#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 local library. <p> Deleting a local 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 local library to delete.

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

    the optional parameters

Returns:



79
80
81
82
 
# File 'lib/vsphere-automation-content/api/local_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 local library. &lt;p&gt; Deleting a local 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 local 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/local_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: LocalLibraryApi.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 LocalLibraryApi.delete"
  end
  # resource path
  local_var_path = '/com/vmware/content/local-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: LocalLibraryApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Returns a given local library.

Parameters:

  • library_id —

    Identifier of the local library to return.

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

    the optional parameters

Returns:



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

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<(ContentLocalLibraryResult|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 local library.

Parameters:

  • library_id —

    Identifier of the local library to return.

  • 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
175
176
177
178
179
 
# File 'lib/vsphere-automation-content/api/local_library_api.rb', line 139

def get_with_http_info(library_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LocalLibraryApi.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 LocalLibraryApi.get"
  end
  # resource path
  local_var_path = '/com/vmware/content/local-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::ContentLocalLibraryResult',
	  '400' => 'Content::VapiStdErrorsInvalidElementTypeError',
	  '404' => 'Content::VapiStdErrorsNotFoundError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LocalLibraryApi#get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list(opts = {}) ⇒ ContentLocalLibraryListResult|

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

Parameters:

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

    the optional parameters

Returns:



183
184
185
186
 
# File 'lib/vsphere-automation-content/api/local_library_api.rb', line 183

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

#list_with_http_info(opts = {}) ⇒ Array<(ContentLocalLibraryListResult|, 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 local libraries in the Content Library.

Parameters:

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

    the optional parameters

Returns:



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

def list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LocalLibraryApi.list ...'
  end
  # resource path
  local_var_path = '/com/vmware/content/local-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::ContentLocalLibraryListResult',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LocalLibraryApi#list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#publish(library_id, opts = {}) ⇒ |VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|VapiStdErrorsNotFoundError|nil

Publishes the library to specified subscriptions. If no subscriptions are specified, then publishes the library to all its subscriptions.

Parameters:

  • library_id —

    Identifier of the published library.

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

    the optional parameters

Options Hash (opts):

Returns:



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

def publish(library_id, opts = {})
  publish_with_http_info(library_id, opts)
  nil
end

#publish_with_http_info(library_id, opts = {}) ⇒ Array<(|VapiStdErrorsNotAllowedInCurrentStateError|VapiStdErrorsUnauthenticatedError|VapiStdErrorsUnauthorizedError|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.

Publishes the library to specified subscriptions. If no subscriptions are specified, then publishes the library to all its subscriptions.

Parameters:

  • library_id —

    Identifier of the published library.

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

    the optional parameters

Options Hash (opts):

Returns:



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

def publish_with_http_info(library_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LocalLibraryApi.publish ...'
  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 LocalLibraryApi.publish"
  end
  # resource path
  local_var_path = '/com/vmware/content/local-library/id:{library_id}?~action=publish'.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(opts[:'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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LocalLibraryApi#publish\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 local library. <p> This is an incremental update to the local library. Fields that are unset in the update specification will be left unchanged.

Parameters:

  • library_id —

    Identifier of the local library to update.

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

    the optional parameters

Returns:



286
287
288
289
 
# File 'lib/vsphere-automation-content/api/local_library_api.rb', line 286

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 local library. &lt;p&gt; This is an incremental update to the local library. Fields that are unset in the update specification will be left unchanged.

Parameters:

  • library_id —

    Identifier of the local library to update.

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

    the optional parameters

Returns:



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
332
333
334
335
336
337
338
 
# File 'lib/vsphere-automation-content/api/local_library_api.rb', line 297

def update_with_http_info(library_id, request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LocalLibraryApi.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 LocalLibraryApi.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 LocalLibraryApi.update"
  end
  # resource path
  local_var_path = '/com/vmware/content/local-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: LocalLibraryApi#update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end