Class: VSphereAutomation::Content::LibraryApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LibraryApi

Returns a new instance of LibraryApi.



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

def api_client
  @api_client
end

Instance Method Details

#find(request_body, opts = {}) ⇒ ContentLibraryFindResult|VapiStdErrorsInvalidArgumentError|

Returns a list of all the visible (as determined by authorization policy) libraries matching the requested Library.FindSpec.

Parameters:

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

    the optional parameters

Returns:



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

def find(request_body, opts = {})
  data, _status_code, _headers = find_with_http_info(request_body, opts)
  data
end

#find_with_http_info(request_body, opts = {}) ⇒ Array<(ContentLibraryFindResult|VapiStdErrorsInvalidArgumentError|, 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 list of all the visible (as determined by authorization policy) libraries matching the requested Library.FindSpec.

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/library_api.rb', line 33

def find_with_http_info(request_body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LibraryApi.find ...'
  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 LibraryApi.find"
  end
  # resource path
  local_var_path = '/com/vmware/content/library?~action=find'

  # 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::ContentLibraryFindResult',
	  '400' => 'Content::VapiStdErrorsInvalidArgumentError',
	})
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LibraryApi#find\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Returns a given LibraryModel.

Parameters:

  • library_id —

    Identifier of the library to return.

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

    the optional parameters

Returns:



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

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<(ContentLibraryResult|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 LibraryModel.

Parameters:

  • library_id —

    Identifier of the library to return.

  • 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
125
126
127
128
 
# File 'lib/vsphere-automation-content/api/library_api.rb', line 89

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

#list(opts = {}) ⇒ ContentLibraryListResult|

Returns the identifiers of all libraries of any type in the Content Library.

Parameters:

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

    the optional parameters

Returns:



132
133
134
135
 
# File 'lib/vsphere-automation-content/api/library_api.rb', line 132

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

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

Parameters:

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

    the optional parameters

Returns:



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

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

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

Updates the properties of a library. <p> This is an incremental update to the library. Any field in the LibraryModel structure that is unset will not be modified. <p> This operation will only update the common properties for all library types. This will not, for example, update the LibraryModel#publishInfo of a local library, nor the LibraryModel#subscriptionInfo of a subscribed library. Specific properties are updated in LocalLibrary#update and SubscribedLibrary#update.

Parameters:

  • library_id —

    Identifier of the library to update.

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

    the optional parameters

Returns:



181
182
183
184
 
# File 'lib/vsphere-automation-content/api/library_api.rb', line 181

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<(|VapiStdErrorsInvalidArgumentError|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 library. &lt;p&gt; This is an incremental update to the library. Any field in the LibraryModel structure that is unset will not be modified. &lt;p&gt; This operation will only update the common properties for all library types. This will not, for example, update the LibraryModel#publishInfo of a local library, nor the LibraryModel#subscriptionInfo of a subscribed library. Specific properties are updated in LocalLibrary#update and SubscribedLibrary#update.

Parameters:

  • library_id —

    Identifier of the library to update.

  • request_body
  • 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
227
228
229
230
231
232
233
 
# File 'lib/vsphere-automation-content/api/library_api.rb', line 192

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