4 cloudFPGA Resource Manager API
6 No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) # noqa: E501
8 OpenAPI spec version: 0.8
10 Generated by: https://github.com/swagger-api/swagger-codegen.git
13 from __future__
import absolute_import
20 from swagger_client.api_client
import ApiClient
24 """NOTE: This class is auto generated by the swagger code generator program.
26 Do not edit the class manually.
27 Ref: https://github.com/swagger-api/swagger-codegen
31 if api_client
is None:
36 """Delete an image # noqa: E501
38 This method makes a synchronous HTTP request by default. To make an
39 asynchronous HTTP request, please pass async_req=True
40 >>> thread = api.cf_manager_rest_api_delete_image(username, password, image_id, async_req=True)
41 >>> result = thread.get()
44 :param str username: OpenStack username (required)
45 :param str password: OpenStack password (required)
46 :param str image_id: Image unique identifier (required)
48 If the method is called asynchronously,
49 returns the request thread.
51 kwargs[
'_return_http_data_only'] =
True
52 if kwargs.get(
'async_req'):
59 """Delete an image # noqa: E501
61 This method makes a synchronous HTTP request by default. To make an
62 asynchronous HTTP request, please pass async_req=True
63 >>> thread = api.cf_manager_rest_api_delete_image_with_http_info(username, password, image_id, async_req=True)
64 >>> result = thread.get()
67 :param str username: OpenStack username (required)
68 :param str password: OpenStack password (required)
69 :param str image_id: Image unique identifier (required)
71 If the method is called asynchronously,
72 returns the request thread.
75 all_params = [
'username',
'password',
'image_id']
76 all_params.append(
'async_req')
77 all_params.append(
'_return_http_data_only')
78 all_params.append(
'_preload_content')
79 all_params.append(
'_request_timeout')
82 for key, val
in six.iteritems(params[
'kwargs']):
83 if key
not in all_params:
85 "Got an unexpected keyword argument '%s'"
86 " to method cf_manager_rest_api_delete_image" % key
91 if (
'username' not in params
or
92 params[
'username']
is None):
93 raise ValueError(
"Missing the required parameter `username` when calling `cf_manager_rest_api_delete_image`")
95 if (
'password' not in params
or
96 params[
'password']
is None):
97 raise ValueError(
"Missing the required parameter `password` when calling `cf_manager_rest_api_delete_image`")
99 if (
'image_id' not in params
or
100 params[
'image_id']
is None):
101 raise ValueError(
"Missing the required parameter `image_id` when calling `cf_manager_rest_api_delete_image`")
103 collection_formats = {}
106 if 'image_id' in params:
107 path_params[
'image_id'] = params[
'image_id']
110 if 'username' in params:
111 query_params.append((
'username', params[
'username']))
112 if 'password' in params:
113 query_params.append((
'password', params[
'password']))
125 '/images/{image_id}',
'DELETE',
130 post_params=form_params,
131 files=local_var_files,
133 auth_settings=auth_settings,
134 async_req=params.get(
'async_req'),
135 _return_http_data_only=params.get(
'_return_http_data_only'),
136 _preload_content=params.get(
'_preload_content',
True),
137 _request_timeout=params.get(
'_request_timeout'),
138 collection_formats=collection_formats)
141 """Get an image # noqa: E501
143 This method makes a synchronous HTTP request by default. To make an
144 asynchronous HTTP request, please pass async_req=True
145 >>> thread = api.cf_manager_rest_api_get_image_single(username, password, image_id, async_req=True)
146 >>> result = thread.get()
148 :param async_req bool
149 :param str username: OpenStack username (required)
150 :param str password: OpenStack password (required)
151 :param str image_id: Image unique identifier (required)
153 If the method is called asynchronously,
154 returns the request thread.
156 kwargs[
'_return_http_data_only'] =
True
157 if kwargs.get(
'async_req'):
164 """Get an image # noqa: E501
166 This method makes a synchronous HTTP request by default. To make an
167 asynchronous HTTP request, please pass async_req=True
168 >>> thread = api.cf_manager_rest_api_get_image_single_with_http_info(username, password, image_id, async_req=True)
169 >>> result = thread.get()
171 :param async_req bool
172 :param str username: OpenStack username (required)
173 :param str password: OpenStack password (required)
174 :param str image_id: Image unique identifier (required)
176 If the method is called asynchronously,
177 returns the request thread.
180 all_params = [
'username',
'password',
'image_id']
181 all_params.append(
'async_req')
182 all_params.append(
'_return_http_data_only')
183 all_params.append(
'_preload_content')
184 all_params.append(
'_request_timeout')
187 for key, val
in six.iteritems(params[
'kwargs']):
188 if key
not in all_params:
190 "Got an unexpected keyword argument '%s'"
191 " to method cf_manager_rest_api_get_image_single" % key
196 if (
'username' not in params
or
197 params[
'username']
is None):
198 raise ValueError(
"Missing the required parameter `username` when calling `cf_manager_rest_api_get_image_single`")
200 if (
'password' not in params
or
201 params[
'password']
is None):
202 raise ValueError(
"Missing the required parameter `password` when calling `cf_manager_rest_api_get_image_single`")
204 if (
'image_id' not in params
or
205 params[
'image_id']
is None):
206 raise ValueError(
"Missing the required parameter `image_id` when calling `cf_manager_rest_api_get_image_single`")
208 collection_formats = {}
211 if 'image_id' in params:
212 path_params[
'image_id'] = params[
'image_id']
215 if 'username' in params:
216 query_params.append((
'username', params[
'username']))
217 if 'password' in params:
218 query_params.append((
'password', params[
'password']))
227 header_params[
'Accept'] = self.
api_clientapi_client.select_header_accept(
228 [
'application/json'])
234 '/images/{image_id}',
'GET',
239 post_params=form_params,
240 files=local_var_files,
241 response_type=
'Image',
242 auth_settings=auth_settings,
243 async_req=params.get(
'async_req'),
244 _return_http_data_only=params.get(
'_return_http_data_only'),
245 _preload_content=params.get(
'_preload_content',
True),
246 _request_timeout=params.get(
'_request_timeout'),
247 collection_formats=collection_formats)
250 """Get all images of a user # noqa: E501
252 This method makes a synchronous HTTP request by default. To make an
253 asynchronous HTTP request, please pass async_req=True
254 >>> thread = api.cf_manager_rest_api_get_images(username, password, async_req=True)
255 >>> result = thread.get()
257 :param async_req bool
258 :param str username: OpenStack username (required)
259 :param str password: OpenStack password (required)
262 If the method is called asynchronously,
263 returns the request thread.
265 kwargs[
'_return_http_data_only'] =
True
266 if kwargs.get(
'async_req'):
273 """Get all images of a user # noqa: E501
275 This method makes a synchronous HTTP request by default. To make an
276 asynchronous HTTP request, please pass async_req=True
277 >>> thread = api.cf_manager_rest_api_get_images_with_http_info(username, password, async_req=True)
278 >>> result = thread.get()
280 :param async_req bool
281 :param str username: OpenStack username (required)
282 :param str password: OpenStack password (required)
285 If the method is called asynchronously,
286 returns the request thread.
289 all_params = [
'username',
'password',
'limit']
290 all_params.append(
'async_req')
291 all_params.append(
'_return_http_data_only')
292 all_params.append(
'_preload_content')
293 all_params.append(
'_request_timeout')
296 for key, val
in six.iteritems(params[
'kwargs']):
297 if key
not in all_params:
299 "Got an unexpected keyword argument '%s'"
300 " to method cf_manager_rest_api_get_images" % key
305 if (
'username' not in params
or
306 params[
'username']
is None):
307 raise ValueError(
"Missing the required parameter `username` when calling `cf_manager_rest_api_get_images`")
309 if (
'password' not in params
or
310 params[
'password']
is None):
311 raise ValueError(
"Missing the required parameter `password` when calling `cf_manager_rest_api_get_images`")
313 collection_formats = {}
318 if 'username' in params:
319 query_params.append((
'username', params[
'username']))
320 if 'password' in params:
321 query_params.append((
'password', params[
'password']))
322 if 'limit' in params:
323 query_params.append((
'limit', params[
'limit']))
332 header_params[
'Accept'] = self.
api_clientapi_client.select_header_accept(
333 [
'application/json'])
344 post_params=form_params,
345 files=local_var_files,
346 response_type=
'list[Image]',
347 auth_settings=auth_settings,
348 async_req=params.get(
'async_req'),
349 _return_http_data_only=params.get(
'_return_http_data_only'),
350 _preload_content=params.get(
'_preload_content',
True),
351 _request_timeout=params.get(
'_request_timeout'),
352 collection_formats=collection_formats)
355 """Upload an image of type `app logic` # noqa: E501
357 This uploads an new image (aka FPGA **bin**file). **This method is for the app logic in case of partial reconfiguration building on platform logics**. The `id` of the uploaded Image can then be used to create *Instances* or *Clusters*. It **must** contain the corresponding .sig file that was produced by the build. The resulting image can be viewed and deleted like other images. # noqa: E501
358 This method makes a synchronous HTTP request by default. To make an
359 asynchronous HTTP request, please pass async_req=True
360 >>> thread = api.cf_manager_rest_api_post_app_logic(image_details, image_file, sig_file, pr_verify_rpt, username, password, async_req=True)
361 >>> result = thread.get()
363 :param async_req bool
364 :param str image_details: (required)
365 :param str image_file: (required)
366 :param str sig_file: (required)
367 :param str pr_verify_rpt: (required)
368 :param str username: OpenStack username (required)
369 :param str password: OpenStack password (required)
371 If the method is called asynchronously,
372 returns the request thread.
374 kwargs[
'_return_http_data_only'] =
True
375 if kwargs.get(
'async_req'):
382 """Upload an image of type `app logic` # noqa: E501
384 This uploads an new image (aka FPGA **bin**file). **This method is for the app logic in case of partial reconfiguration building on platform logics**. The `id` of the uploaded Image can then be used to create *Instances* or *Clusters*. It **must** contain the corresponding .sig file that was produced by the build. The resulting image can be viewed and deleted like other images. # noqa: E501
385 This method makes a synchronous HTTP request by default. To make an
386 asynchronous HTTP request, please pass async_req=True
387 >>> thread = api.cf_manager_rest_api_post_app_logic_with_http_info(image_details, image_file, sig_file, pr_verify_rpt, username, password, async_req=True)
388 >>> result = thread.get()
390 :param async_req bool
391 :param str image_details: (required)
392 :param str image_file: (required)
393 :param str sig_file: (required)
394 :param str pr_verify_rpt: (required)
395 :param str username: OpenStack username (required)
396 :param str password: OpenStack password (required)
398 If the method is called asynchronously,
399 returns the request thread.
402 all_params = [
'image_details',
'image_file',
'sig_file',
'pr_verify_rpt',
'username',
'password']
403 all_params.append(
'async_req')
404 all_params.append(
'_return_http_data_only')
405 all_params.append(
'_preload_content')
406 all_params.append(
'_request_timeout')
409 for key, val
in six.iteritems(params[
'kwargs']):
410 if key
not in all_params:
412 "Got an unexpected keyword argument '%s'"
413 " to method cf_manager_rest_api_post_app_logic" % key
418 if (
'image_details' not in params
or
419 params[
'image_details']
is None):
420 raise ValueError(
"Missing the required parameter `image_details` when calling `cf_manager_rest_api_post_app_logic`")
422 if (
'image_file' not in params
or
423 params[
'image_file']
is None):
424 raise ValueError(
"Missing the required parameter `image_file` when calling `cf_manager_rest_api_post_app_logic`")
426 if (
'sig_file' not in params
or
427 params[
'sig_file']
is None):
428 raise ValueError(
"Missing the required parameter `sig_file` when calling `cf_manager_rest_api_post_app_logic`")
430 if (
'pr_verify_rpt' not in params
or
431 params[
'pr_verify_rpt']
is None):
432 raise ValueError(
"Missing the required parameter `pr_verify_rpt` when calling `cf_manager_rest_api_post_app_logic`")
434 if (
'username' not in params
or
435 params[
'username']
is None):
436 raise ValueError(
"Missing the required parameter `username` when calling `cf_manager_rest_api_post_app_logic`")
438 if (
'password' not in params
or
439 params[
'password']
is None):
440 raise ValueError(
"Missing the required parameter `password` when calling `cf_manager_rest_api_post_app_logic`")
442 collection_formats = {}
447 if 'username' in params:
448 query_params.append((
'username', params[
'username']))
449 if 'password' in params:
450 query_params.append((
'password', params[
'password']))
456 if 'image_details' in params:
457 form_params.append((
'image_details', params[
'image_details']))
458 if 'image_file' in params:
459 local_var_files[
'image_file'] = params[
'image_file']
460 if 'sig_file' in params:
461 local_var_files[
'sig_file'] = params[
'sig_file']
462 if 'pr_verify_rpt' in params:
463 local_var_files[
'pr_verify_rpt'] = params[
'pr_verify_rpt']
467 header_params[
'Accept'] = self.
api_clientapi_client.select_header_accept(
468 [
'application/json'])
471 header_params[
'Content-Type'] = self.
api_clientapi_client.select_header_content_type(
472 [
'multipart/form-data'])
478 '/images/app_logic',
'POST',
483 post_params=form_params,
484 files=local_var_files,
485 response_type=
'Image',
486 auth_settings=auth_settings,
487 async_req=params.get(
'async_req'),
488 _return_http_data_only=params.get(
'_return_http_data_only'),
489 _preload_content=params.get(
'_preload_content',
True),
490 _request_timeout=params.get(
'_request_timeout'),
491 collection_formats=collection_formats)
494 """Upload an image # noqa: E501
496 This uploads an new Image (aka FPGA bitfile). The `id` of the uploaded Image can then be used to create *Instances* or *Clusters*. If the bitfile **is not a partial bitfile**, the *image_detail* **property `breed` must be `\"SHELL\"`**. The *image_detail* property `shell_type` is only relevant for the partial reconfiguration flow, but cannot be empty (e.g. enter `\"NO_PR\"`). # noqa: E501
497 This method makes a synchronous HTTP request by default. To make an
498 asynchronous HTTP request, please pass async_req=True
499 >>> thread = api.cf_manager_rest_api_post_images(image_details, image_file, pr_verify_rpt, username, password, async_req=True)
500 >>> result = thread.get()
502 :param async_req bool
503 :param str image_details: (required)
504 :param str image_file: (required)
505 :param str pr_verify_rpt: (required)
506 :param str username: OpenStack username (required)
507 :param str password: OpenStack password (required)
509 If the method is called asynchronously,
510 returns the request thread.
512 kwargs[
'_return_http_data_only'] =
True
513 if kwargs.get(
'async_req'):
520 """Upload an image # noqa: E501
522 This uploads an new Image (aka FPGA bitfile). The `id` of the uploaded Image can then be used to create *Instances* or *Clusters*. If the bitfile **is not a partial bitfile**, the *image_detail* **property `breed` must be `\"SHELL\"`**. The *image_detail* property `shell_type` is only relevant for the partial reconfiguration flow, but cannot be empty (e.g. enter `\"NO_PR\"`). # noqa: E501
523 This method makes a synchronous HTTP request by default. To make an
524 asynchronous HTTP request, please pass async_req=True
525 >>> thread = api.cf_manager_rest_api_post_images_with_http_info(image_details, image_file, pr_verify_rpt, username, password, async_req=True)
526 >>> result = thread.get()
528 :param async_req bool
529 :param str image_details: (required)
530 :param str image_file: (required)
531 :param str pr_verify_rpt: (required)
532 :param str username: OpenStack username (required)
533 :param str password: OpenStack password (required)
535 If the method is called asynchronously,
536 returns the request thread.
539 all_params = [
'image_details',
'image_file',
'pr_verify_rpt',
'username',
'password']
540 all_params.append(
'async_req')
541 all_params.append(
'_return_http_data_only')
542 all_params.append(
'_preload_content')
543 all_params.append(
'_request_timeout')
546 for key, val
in six.iteritems(params[
'kwargs']):
547 if key
not in all_params:
549 "Got an unexpected keyword argument '%s'"
550 " to method cf_manager_rest_api_post_images" % key
555 if (
'image_details' not in params
or
556 params[
'image_details']
is None):
557 raise ValueError(
"Missing the required parameter `image_details` when calling `cf_manager_rest_api_post_images`")
559 if (
'image_file' not in params
or
560 params[
'image_file']
is None):
561 raise ValueError(
"Missing the required parameter `image_file` when calling `cf_manager_rest_api_post_images`")
563 if (
'pr_verify_rpt' not in params
or
564 params[
'pr_verify_rpt']
is None):
565 raise ValueError(
"Missing the required parameter `pr_verify_rpt` when calling `cf_manager_rest_api_post_images`")
567 if (
'username' not in params
or
568 params[
'username']
is None):
569 raise ValueError(
"Missing the required parameter `username` when calling `cf_manager_rest_api_post_images`")
571 if (
'password' not in params
or
572 params[
'password']
is None):
573 raise ValueError(
"Missing the required parameter `password` when calling `cf_manager_rest_api_post_images`")
575 collection_formats = {}
580 if 'username' in params:
581 query_params.append((
'username', params[
'username']))
582 if 'password' in params:
583 query_params.append((
'password', params[
'password']))
589 if 'image_details' in params:
590 form_params.append((
'image_details', params[
'image_details']))
591 if 'image_file' in params:
592 local_var_files[
'image_file'] = params[
'image_file']
593 if 'pr_verify_rpt' in params:
594 local_var_files[
'pr_verify_rpt'] = params[
'pr_verify_rpt']
598 header_params[
'Accept'] = self.
api_clientapi_client.select_header_accept(
599 [
'application/json'])
602 header_params[
'Content-Type'] = self.
api_clientapi_client.select_header_content_type(
603 [
'multipart/form-data'])
614 post_params=form_params,
615 files=local_var_files,
616 response_type=
'Image',
617 auth_settings=auth_settings,
618 async_req=params.get(
'async_req'),
619 _return_http_data_only=params.get(
'_return_http_data_only'),
620 _preload_content=params.get(
'_preload_content',
True),
621 _request_timeout=params.get(
'_request_timeout'),
622 collection_formats=collection_formats)
def cf_manager_rest_api_post_images_with_http_info(self, image_details, image_file, pr_verify_rpt, username, password, **kwargs)
def cf_manager_rest_api_delete_image(self, username, password, image_id, **kwargs)
def cf_manager_rest_api_post_app_logic_with_http_info(self, image_details, image_file, sig_file, pr_verify_rpt, username, password, **kwargs)
def cf_manager_rest_api_delete_image_with_http_info(self, username, password, image_id, **kwargs)
def __init__(self, api_client=None)
def cf_manager_rest_api_post_app_logic(self, image_details, image_file, sig_file, pr_verify_rpt, username, password, **kwargs)
def cf_manager_rest_api_get_images_with_http_info(self, username, password, **kwargs)
def cf_manager_rest_api_get_image_single_with_http_info(self, username, password, image_id, **kwargs)
def cf_manager_rest_api_get_image_single(self, username, password, image_id, **kwargs)
def cf_manager_rest_api_get_images(self, username, password, **kwargs)
def cf_manager_rest_api_post_images(self, image_details, image_file, pr_verify_rpt, username, password, **kwargs)