18094: Removes update_uuid from the R SDK.
[arvados.git] / sdk / R / R / Arvados.R
1 # Copyright (C) The Arvados Authors. All rights reserved.
2 #
3 # SPDX-License-Identifier: Apache-2.0
4
5 #' api_clients.get
6 #'
7 #' api_clients.get is a method defined in Arvados class.
8 #'
9 #' @usage arv$api_clients.get(uuid)
10 #' @param uuid The UUID of the ApiClient in question.
11 #' @return ApiClient object.
12 #' @name api_clients.get
13 NULL
14
15 #' api_clients.create
16 #'
17 #' api_clients.create is a method defined in Arvados class.
18 #'
19 #' @usage arv$api_clients.create(apiclient,
20 #'      ensure_unique_name = "false", cluster_id = NULL)
21 #' @param apiClient ApiClient object.
22 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
23 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
24 #' @return ApiClient object.
25 #' @name api_clients.create
26 NULL
27
28 #' api_clients.update
29 #'
30 #' api_clients.update is a method defined in Arvados class.
31 #'
32 #' @usage arv$api_clients.update(apiclient,
33 #'      uuid)
34 #' @param apiClient ApiClient object.
35 #' @param uuid The UUID of the ApiClient in question.
36 #' @return ApiClient object.
37 #' @name api_clients.update
38 NULL
39
40 #' api_clients.delete
41 #'
42 #' api_clients.delete is a method defined in Arvados class.
43 #'
44 #' @usage arv$api_clients.delete(uuid)
45 #' @param uuid The UUID of the ApiClient in question.
46 #' @return ApiClient object.
47 #' @name api_clients.delete
48 NULL
49
50 #' api_clients.list
51 #'
52 #' api_clients.list is a method defined in Arvados class.
53 #'
54 #' @usage arv$api_clients.list(filters = NULL,
55 #'      where = NULL, order = NULL, select = NULL,
56 #'      distinct = NULL, limit = "100", offset = "0",
57 #'      count = "exact", cluster_id = NULL, bypass_federation = NULL)
58 #' @param filters
59 #' @param where
60 #' @param order
61 #' @param select
62 #' @param distinct
63 #' @param limit
64 #' @param offset
65 #' @param count
66 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
67 #' @param bypass_federation bypass federation behavior, list items from local instance database only
68 #' @return ApiClientList object.
69 #' @name api_clients.list
70 NULL
71
72 #' api_client_authorizations.get
73 #'
74 #' api_client_authorizations.get is a method defined in Arvados class.
75 #'
76 #' @usage arv$api_client_authorizations.get(uuid)
77 #' @param uuid The UUID of the ApiClientAuthorization in question.
78 #' @return ApiClientAuthorization object.
79 #' @name api_client_authorizations.get
80 NULL
81
82 #' api_client_authorizations.create
83 #'
84 #' api_client_authorizations.create is a method defined in Arvados class.
85 #'
86 #' @usage arv$api_client_authorizations.create(apiclientauthorization,
87 #'      ensure_unique_name = "false", cluster_id = NULL)
88 #' @param apiClientAuthorization ApiClientAuthorization object.
89 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
90 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
91 #' @return ApiClientAuthorization object.
92 #' @name api_client_authorizations.create
93 NULL
94
95 #' api_client_authorizations.update
96 #'
97 #' api_client_authorizations.update is a method defined in Arvados class.
98 #'
99 #' @usage arv$api_client_authorizations.update(apiclientauthorization,
100 #'      uuid)
101 #' @param apiClientAuthorization ApiClientAuthorization object.
102 #' @param uuid The UUID of the ApiClientAuthorization in question.
103 #' @return ApiClientAuthorization object.
104 #' @name api_client_authorizations.update
105 NULL
106
107 #' api_client_authorizations.delete
108 #'
109 #' api_client_authorizations.delete is a method defined in Arvados class.
110 #'
111 #' @usage arv$api_client_authorizations.delete(uuid)
112 #' @param uuid The UUID of the ApiClientAuthorization in question.
113 #' @return ApiClientAuthorization object.
114 #' @name api_client_authorizations.delete
115 NULL
116
117 #' api_client_authorizations.create_system_auth
118 #'
119 #' api_client_authorizations.create_system_auth is a method defined in Arvados class.
120 #'
121 #' @usage arv$api_client_authorizations.create_system_auth(api_client_id = NULL,
122 #'      scopes = NULL)
123 #' @param api_client_id
124 #' @param scopes
125 #' @return ApiClientAuthorization object.
126 #' @name api_client_authorizations.create_system_auth
127 NULL
128
129 #' api_client_authorizations.current
130 #'
131 #' api_client_authorizations.current is a method defined in Arvados class.
132 #'
133 #' @usage arv$api_client_authorizations.current(NULL)
134 #' @return ApiClientAuthorization object.
135 #' @name api_client_authorizations.current
136 NULL
137
138 #' api_client_authorizations.list
139 #'
140 #' api_client_authorizations.list is a method defined in Arvados class.
141 #'
142 #' @usage arv$api_client_authorizations.list(filters = NULL,
143 #'      where = NULL, order = NULL, select = NULL,
144 #'      distinct = NULL, limit = "100", offset = "0",
145 #'      count = "exact", cluster_id = NULL, bypass_federation = NULL)
146 #' @param filters
147 #' @param where
148 #' @param order
149 #' @param select
150 #' @param distinct
151 #' @param limit
152 #' @param offset
153 #' @param count
154 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
155 #' @param bypass_federation bypass federation behavior, list items from local instance database only
156 #' @return ApiClientAuthorizationList object.
157 #' @name api_client_authorizations.list
158 NULL
159
160 #' authorized_keys.get
161 #'
162 #' authorized_keys.get is a method defined in Arvados class.
163 #'
164 #' @usage arv$authorized_keys.get(uuid)
165 #' @param uuid The UUID of the AuthorizedKey in question.
166 #' @return AuthorizedKey object.
167 #' @name authorized_keys.get
168 NULL
169
170 #' authorized_keys.create
171 #'
172 #' authorized_keys.create is a method defined in Arvados class.
173 #'
174 #' @usage arv$authorized_keys.create(authorizedkey,
175 #'      ensure_unique_name = "false", cluster_id = NULL)
176 #' @param authorizedKey AuthorizedKey object.
177 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
178 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
179 #' @return AuthorizedKey object.
180 #' @name authorized_keys.create
181 NULL
182
183 #' authorized_keys.update
184 #'
185 #' authorized_keys.update is a method defined in Arvados class.
186 #'
187 #' @usage arv$authorized_keys.update(authorizedkey,
188 #'      uuid)
189 #' @param authorizedKey AuthorizedKey object.
190 #' @param uuid The UUID of the AuthorizedKey in question.
191 #' @return AuthorizedKey object.
192 #' @name authorized_keys.update
193 NULL
194
195 #' authorized_keys.delete
196 #'
197 #' authorized_keys.delete is a method defined in Arvados class.
198 #'
199 #' @usage arv$authorized_keys.delete(uuid)
200 #' @param uuid The UUID of the AuthorizedKey in question.
201 #' @return AuthorizedKey object.
202 #' @name authorized_keys.delete
203 NULL
204
205 #' authorized_keys.list
206 #'
207 #' authorized_keys.list is a method defined in Arvados class.
208 #'
209 #' @usage arv$authorized_keys.list(filters = NULL,
210 #'      where = NULL, order = NULL, select = NULL,
211 #'      distinct = NULL, limit = "100", offset = "0",
212 #'      count = "exact", cluster_id = NULL, bypass_federation = NULL)
213 #' @param filters
214 #' @param where
215 #' @param order
216 #' @param select
217 #' @param distinct
218 #' @param limit
219 #' @param offset
220 #' @param count
221 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
222 #' @param bypass_federation bypass federation behavior, list items from local instance database only
223 #' @return AuthorizedKeyList object.
224 #' @name authorized_keys.list
225 NULL
226
227 #' collections.get
228 #'
229 #' collections.get is a method defined in Arvados class.
230 #'
231 #' @usage arv$collections.get(uuid)
232 #' @param uuid The UUID of the Collection in question.
233 #' @return Collection object.
234 #' @name collections.get
235 NULL
236
237 #' collections.create
238 #'
239 #' collections.create is a method defined in Arvados class.
240 #'
241 #' @usage arv$collections.create(collection,
242 #'      ensure_unique_name = "false", cluster_id = NULL)
243 #' @param collection Collection object.
244 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
245 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
246 #' @return Collection object.
247 #' @name collections.create
248 NULL
249
250 #' collections.update
251 #'
252 #' collections.update is a method defined in Arvados class.
253 #'
254 #' @usage arv$collections.update(collection,
255 #'      uuid)
256 #' @param collection Collection object.
257 #' @param uuid The UUID of the Collection in question.
258 #' @return Collection object.
259 #' @name collections.update
260 NULL
261
262 #' collections.delete
263 #'
264 #' collections.delete is a method defined in Arvados class.
265 #'
266 #' @usage arv$collections.delete(uuid)
267 #' @param uuid The UUID of the Collection in question.
268 #' @return Collection object.
269 #' @name collections.delete
270 NULL
271
272 #' collections.provenance
273 #'
274 #' collections.provenance is a method defined in Arvados class.
275 #'
276 #' @usage arv$collections.provenance(uuid)
277 #' @param uuid
278 #' @return Collection object.
279 #' @name collections.provenance
280 NULL
281
282 #' collections.used_by
283 #'
284 #' collections.used_by is a method defined in Arvados class.
285 #'
286 #' @usage arv$collections.used_by(uuid)
287 #' @param uuid
288 #' @return Collection object.
289 #' @name collections.used_by
290 NULL
291
292 #' collections.trash
293 #'
294 #' collections.trash is a method defined in Arvados class.
295 #'
296 #' @usage arv$collections.trash(uuid)
297 #' @param uuid
298 #' @return Collection object.
299 #' @name collections.trash
300 NULL
301
302 #' collections.untrash
303 #'
304 #' collections.untrash is a method defined in Arvados class.
305 #'
306 #' @usage arv$collections.untrash(uuid)
307 #' @param uuid
308 #' @return Collection object.
309 #' @name collections.untrash
310 NULL
311
312 #' collections.list
313 #'
314 #' collections.list is a method defined in Arvados class.
315 #'
316 #' @usage arv$collections.list(filters = NULL,
317 #'      where = NULL, order = NULL, select = NULL,
318 #'      distinct = NULL, limit = "100", offset = "0",
319 #'      count = "exact", cluster_id = NULL, bypass_federation = NULL,
320 #'      include_trash = NULL, include_old_versions = NULL)
321 #' @param filters
322 #' @param where
323 #' @param order
324 #' @param select
325 #' @param distinct
326 #' @param limit
327 #' @param offset
328 #' @param count
329 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
330 #' @param bypass_federation bypass federation behavior, list items from local instance database only
331 #' @param include_trash Include collections whose is_trashed attribute is true.
332 #' @param include_old_versions Include past collection versions.
333 #' @return CollectionList object.
334 #' @name collections.list
335 NULL
336
337 #' containers.get
338 #'
339 #' containers.get is a method defined in Arvados class.
340 #'
341 #' @usage arv$containers.get(uuid)
342 #' @param uuid The UUID of the Container in question.
343 #' @return Container object.
344 #' @name containers.get
345 NULL
346
347 #' containers.create
348 #'
349 #' containers.create is a method defined in Arvados class.
350 #'
351 #' @usage arv$containers.create(container,
352 #'      ensure_unique_name = "false", cluster_id = NULL)
353 #' @param container Container object.
354 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
355 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
356 #' @return Container object.
357 #' @name containers.create
358 NULL
359
360 #' containers.update
361 #'
362 #' containers.update is a method defined in Arvados class.
363 #'
364 #' @usage arv$containers.update(container,
365 #'      uuid)
366 #' @param container Container object.
367 #' @param uuid The UUID of the Container in question.
368 #' @return Container object.
369 #' @name containers.update
370 NULL
371
372 #' containers.delete
373 #'
374 #' containers.delete is a method defined in Arvados class.
375 #'
376 #' @usage arv$containers.delete(uuid)
377 #' @param uuid The UUID of the Container in question.
378 #' @return Container object.
379 #' @name containers.delete
380 NULL
381
382 #' containers.auth
383 #'
384 #' containers.auth is a method defined in Arvados class.
385 #'
386 #' @usage arv$containers.auth(uuid)
387 #' @param uuid
388 #' @return Container object.
389 #' @name containers.auth
390 NULL
391
392 #' containers.lock
393 #'
394 #' containers.lock is a method defined in Arvados class.
395 #'
396 #' @usage arv$containers.lock(uuid)
397 #' @param uuid
398 #' @return Container object.
399 #' @name containers.lock
400 NULL
401
402 #' containers.unlock
403 #'
404 #' containers.unlock is a method defined in Arvados class.
405 #'
406 #' @usage arv$containers.unlock(uuid)
407 #' @param uuid
408 #' @return Container object.
409 #' @name containers.unlock
410 NULL
411
412 #' containers.secret_mounts
413 #'
414 #' containers.secret_mounts is a method defined in Arvados class.
415 #'
416 #' @usage arv$containers.secret_mounts(uuid)
417 #' @param uuid
418 #' @return Container object.
419 #' @name containers.secret_mounts
420 NULL
421
422 #' containers.current
423 #'
424 #' containers.current is a method defined in Arvados class.
425 #'
426 #' @usage arv$containers.current(NULL)
427 #' @return Container object.
428 #' @name containers.current
429 NULL
430
431 #' containers.list
432 #'
433 #' containers.list is a method defined in Arvados class.
434 #'
435 #' @usage arv$containers.list(filters = NULL,
436 #'      where = NULL, order = NULL, select = NULL,
437 #'      distinct = NULL, limit = "100", offset = "0",
438 #'      count = "exact", cluster_id = NULL, bypass_federation = NULL)
439 #' @param filters
440 #' @param where
441 #' @param order
442 #' @param select
443 #' @param distinct
444 #' @param limit
445 #' @param offset
446 #' @param count
447 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
448 #' @param bypass_federation bypass federation behavior, list items from local instance database only
449 #' @return ContainerList object.
450 #' @name containers.list
451 NULL
452
453 #' container_requests.get
454 #'
455 #' container_requests.get is a method defined in Arvados class.
456 #'
457 #' @usage arv$container_requests.get(uuid)
458 #' @param uuid The UUID of the ContainerRequest in question.
459 #' @return ContainerRequest object.
460 #' @name container_requests.get
461 NULL
462
463 #' container_requests.create
464 #'
465 #' container_requests.create is a method defined in Arvados class.
466 #'
467 #' @usage arv$container_requests.create(containerrequest,
468 #'      ensure_unique_name = "false", cluster_id = NULL)
469 #' @param containerRequest ContainerRequest object.
470 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
471 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
472 #' @return ContainerRequest object.
473 #' @name container_requests.create
474 NULL
475
476 #' container_requests.update
477 #'
478 #' container_requests.update is a method defined in Arvados class.
479 #'
480 #' @usage arv$container_requests.update(containerrequest,
481 #'      uuid)
482 #' @param containerRequest ContainerRequest object.
483 #' @param uuid The UUID of the ContainerRequest in question.
484 #' @return ContainerRequest object.
485 #' @name container_requests.update
486 NULL
487
488 #' container_requests.delete
489 #'
490 #' container_requests.delete is a method defined in Arvados class.
491 #'
492 #' @usage arv$container_requests.delete(uuid)
493 #' @param uuid The UUID of the ContainerRequest in question.
494 #' @return ContainerRequest object.
495 #' @name container_requests.delete
496 NULL
497
498 #' container_requests.list
499 #'
500 #' container_requests.list is a method defined in Arvados class.
501 #'
502 #' @usage arv$container_requests.list(filters = NULL,
503 #'      where = NULL, order = NULL, select = NULL,
504 #'      distinct = NULL, limit = "100", offset = "0",
505 #'      count = "exact", cluster_id = NULL, bypass_federation = NULL,
506 #'      include_trash = NULL)
507 #' @param filters
508 #' @param where
509 #' @param order
510 #' @param select
511 #' @param distinct
512 #' @param limit
513 #' @param offset
514 #' @param count
515 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
516 #' @param bypass_federation bypass federation behavior, list items from local instance database only
517 #' @param include_trash Include container requests whose owner project is trashed.
518 #' @return ContainerRequestList object.
519 #' @name container_requests.list
520 NULL
521
522 #' groups.get
523 #'
524 #' groups.get is a method defined in Arvados class.
525 #'
526 #' @usage arv$groups.get(uuid)
527 #' @param uuid The UUID of the Group in question.
528 #' @return Group object.
529 #' @name groups.get
530 NULL
531
532 #' groups.create
533 #'
534 #' groups.create is a method defined in Arvados class.
535 #'
536 #' @usage arv$groups.create(group, ensure_unique_name = "false",
537 #'      cluster_id = NULL, async = "false")
538 #' @param group Group object.
539 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
540 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
541 #' @param async defer permissions update
542 #' @return Group object.
543 #' @name groups.create
544 NULL
545
546 #' groups.update
547 #'
548 #' groups.update is a method defined in Arvados class.
549 #'
550 #' @usage arv$groups.update(group, uuid,
551 #'      async = "false")
552 #' @param group Group object.
553 #' @param uuid The UUID of the Group in question.
554 #' @param async defer permissions update
555 #' @return Group object.
556 #' @name groups.update
557 NULL
558
559 #' groups.delete
560 #'
561 #' groups.delete is a method defined in Arvados class.
562 #'
563 #' @usage arv$groups.delete(uuid)
564 #' @param uuid The UUID of the Group in question.
565 #' @return Group object.
566 #' @name groups.delete
567 NULL
568
569 #' groups.contents
570 #'
571 #' groups.contents is a method defined in Arvados class.
572 #'
573 #' @usage arv$groups.contents(filters = NULL,
574 #'      where = NULL, order = NULL, distinct = NULL,
575 #'      limit = "100", offset = "0", count = "exact",
576 #'      cluster_id = NULL, bypass_federation = NULL,
577 #'      include_trash = NULL, uuid = NULL, recursive = NULL,
578 #'      include = NULL)
579 #' @param filters
580 #' @param where
581 #' @param order
582 #' @param distinct
583 #' @param limit
584 #' @param offset
585 #' @param count
586 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
587 #' @param bypass_federation bypass federation behavior, list items from local instance database only
588 #' @param include_trash Include items whose is_trashed attribute is true.
589 #' @param uuid
590 #' @param recursive Include contents from child groups recursively.
591 #' @param include Include objects referred to by listed field in "included" (only owner_uuid)
592 #' @return Group object.
593 #' @name groups.contents
594 NULL
595
596 #' groups.shared
597 #'
598 #' groups.shared is a method defined in Arvados class.
599 #'
600 #' @usage arv$groups.shared(filters = NULL,
601 #'      where = NULL, order = NULL, select = NULL,
602 #'      distinct = NULL, limit = "100", offset = "0",
603 #'      count = "exact", cluster_id = NULL, bypass_federation = NULL,
604 #'      include_trash = NULL, include = NULL)
605 #' @param filters
606 #' @param where
607 #' @param order
608 #' @param select
609 #' @param distinct
610 #' @param limit
611 #' @param offset
612 #' @param count
613 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
614 #' @param bypass_federation bypass federation behavior, list items from local instance database only
615 #' @param include_trash Include items whose is_trashed attribute is true.
616 #' @param include
617 #' @return Group object.
618 #' @name groups.shared
619 NULL
620
621 #' groups.trash
622 #'
623 #' groups.trash is a method defined in Arvados class.
624 #'
625 #' @usage arv$groups.trash(uuid)
626 #' @param uuid
627 #' @return Group object.
628 #' @name groups.trash
629 NULL
630
631 #' groups.untrash
632 #'
633 #' groups.untrash is a method defined in Arvados class.
634 #'
635 #' @usage arv$groups.untrash(uuid)
636 #' @param uuid
637 #' @return Group object.
638 #' @name groups.untrash
639 NULL
640
641 #' groups.list
642 #'
643 #' groups.list is a method defined in Arvados class.
644 #'
645 #' @usage arv$groups.list(filters = NULL,
646 #'      where = NULL, order = NULL, select = NULL,
647 #'      distinct = NULL, limit = "100", offset = "0",
648 #'      count = "exact", cluster_id = NULL, bypass_federation = NULL,
649 #'      include_trash = NULL)
650 #' @param filters
651 #' @param where
652 #' @param order
653 #' @param select
654 #' @param distinct
655 #' @param limit
656 #' @param offset
657 #' @param count
658 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
659 #' @param bypass_federation bypass federation behavior, list items from local instance database only
660 #' @param include_trash Include items whose is_trashed attribute is true.
661 #' @return GroupList object.
662 #' @name groups.list
663 NULL
664
665 #' keep_services.get
666 #'
667 #' keep_services.get is a method defined in Arvados class.
668 #'
669 #' @usage arv$keep_services.get(uuid)
670 #' @param uuid The UUID of the KeepService in question.
671 #' @return KeepService object.
672 #' @name keep_services.get
673 NULL
674
675 #' keep_services.create
676 #'
677 #' keep_services.create is a method defined in Arvados class.
678 #'
679 #' @usage arv$keep_services.create(keepservice,
680 #'      ensure_unique_name = "false", cluster_id = NULL)
681 #' @param keepService KeepService object.
682 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
683 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
684 #' @return KeepService object.
685 #' @name keep_services.create
686 NULL
687
688 #' keep_services.update
689 #'
690 #' keep_services.update is a method defined in Arvados class.
691 #'
692 #' @usage arv$keep_services.update(keepservice,
693 #'      uuid)
694 #' @param keepService KeepService object.
695 #' @param uuid The UUID of the KeepService in question.
696 #' @return KeepService object.
697 #' @name keep_services.update
698 NULL
699
700 #' keep_services.delete
701 #'
702 #' keep_services.delete is a method defined in Arvados class.
703 #'
704 #' @usage arv$keep_services.delete(uuid)
705 #' @param uuid The UUID of the KeepService in question.
706 #' @return KeepService object.
707 #' @name keep_services.delete
708 NULL
709
710 #' keep_services.accessible
711 #'
712 #' keep_services.accessible is a method defined in Arvados class.
713 #'
714 #' @usage arv$keep_services.accessible(NULL)
715 #' @return KeepService object.
716 #' @name keep_services.accessible
717 NULL
718
719 #' keep_services.list
720 #'
721 #' keep_services.list is a method defined in Arvados class.
722 #'
723 #' @usage arv$keep_services.list(filters = NULL,
724 #'      where = NULL, order = NULL, select = NULL,
725 #'      distinct = NULL, limit = "100", offset = "0",
726 #'      count = "exact", cluster_id = NULL, bypass_federation = NULL)
727 #' @param filters
728 #' @param where
729 #' @param order
730 #' @param select
731 #' @param distinct
732 #' @param limit
733 #' @param offset
734 #' @param count
735 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
736 #' @param bypass_federation bypass federation behavior, list items from local instance database only
737 #' @return KeepServiceList object.
738 #' @name keep_services.list
739 NULL
740
741 #' links.get
742 #'
743 #' links.get is a method defined in Arvados class.
744 #'
745 #' @usage arv$links.get(uuid)
746 #' @param uuid The UUID of the Link in question.
747 #' @return Link object.
748 #' @name links.get
749 NULL
750
751 #' links.create
752 #'
753 #' links.create is a method defined in Arvados class.
754 #'
755 #' @usage arv$links.create(link, ensure_unique_name = "false",
756 #'      cluster_id = NULL)
757 #' @param link Link object.
758 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
759 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
760 #' @return Link object.
761 #' @name links.create
762 NULL
763
764 #' links.update
765 #'
766 #' links.update is a method defined in Arvados class.
767 #'
768 #' @usage arv$links.update(link, uuid)
769 #' @param link Link object.
770 #' @param uuid The UUID of the Link in question.
771 #' @return Link object.
772 #' @name links.update
773 NULL
774
775 #' links.delete
776 #'
777 #' links.delete is a method defined in Arvados class.
778 #'
779 #' @usage arv$links.delete(uuid)
780 #' @param uuid The UUID of the Link in question.
781 #' @return Link object.
782 #' @name links.delete
783 NULL
784
785 #' links.list
786 #'
787 #' links.list is a method defined in Arvados class.
788 #'
789 #' @usage arv$links.list(filters = NULL,
790 #'      where = NULL, order = NULL, select = NULL,
791 #'      distinct = NULL, limit = "100", offset = "0",
792 #'      count = "exact", cluster_id = NULL, bypass_federation = NULL)
793 #' @param filters
794 #' @param where
795 #' @param order
796 #' @param select
797 #' @param distinct
798 #' @param limit
799 #' @param offset
800 #' @param count
801 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
802 #' @param bypass_federation bypass federation behavior, list items from local instance database only
803 #' @return LinkList object.
804 #' @name links.list
805 NULL
806
807 #' links.get_permissions
808 #'
809 #' links.get_permissions is a method defined in Arvados class.
810 #'
811 #' @usage arv$links.get_permissions(uuid)
812 #' @param uuid
813 #' @return Link object.
814 #' @name links.get_permissions
815 NULL
816
817 #' logs.get
818 #'
819 #' logs.get is a method defined in Arvados class.
820 #'
821 #' @usage arv$logs.get(uuid)
822 #' @param uuid The UUID of the Log in question.
823 #' @return Log object.
824 #' @name logs.get
825 NULL
826
827 #' logs.create
828 #'
829 #' logs.create is a method defined in Arvados class.
830 #'
831 #' @usage arv$logs.create(log, ensure_unique_name = "false",
832 #'      cluster_id = NULL)
833 #' @param log Log object.
834 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
835 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
836 #' @return Log object.
837 #' @name logs.create
838 NULL
839
840 #' logs.update
841 #'
842 #' logs.update is a method defined in Arvados class.
843 #'
844 #' @usage arv$logs.update(log, uuid)
845 #' @param log Log object.
846 #' @param uuid The UUID of the Log in question.
847 #' @return Log object.
848 #' @name logs.update
849 NULL
850
851 #' logs.delete
852 #'
853 #' logs.delete is a method defined in Arvados class.
854 #'
855 #' @usage arv$logs.delete(uuid)
856 #' @param uuid The UUID of the Log in question.
857 #' @return Log object.
858 #' @name logs.delete
859 NULL
860
861 #' logs.list
862 #'
863 #' logs.list is a method defined in Arvados class.
864 #'
865 #' @usage arv$logs.list(filters = NULL, where = NULL,
866 #'      order = NULL, select = NULL, distinct = NULL,
867 #'      limit = "100", offset = "0", count = "exact",
868 #'      cluster_id = NULL, bypass_federation = NULL)
869 #' @param filters
870 #' @param where
871 #' @param order
872 #' @param select
873 #' @param distinct
874 #' @param limit
875 #' @param offset
876 #' @param count
877 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
878 #' @param bypass_federation bypass federation behavior, list items from local instance database only
879 #' @return LogList object.
880 #' @name logs.list
881 NULL
882
883 #' users.get
884 #'
885 #' users.get is a method defined in Arvados class.
886 #'
887 #' @usage arv$users.get(uuid)
888 #' @param uuid The UUID of the User in question.
889 #' @return User object.
890 #' @name users.get
891 NULL
892
893 #' users.create
894 #'
895 #' users.create is a method defined in Arvados class.
896 #'
897 #' @usage arv$users.create(user, ensure_unique_name = "false",
898 #'      cluster_id = NULL)
899 #' @param user User object.
900 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
901 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
902 #' @return User object.
903 #' @name users.create
904 NULL
905
906 #' users.update
907 #'
908 #' users.update is a method defined in Arvados class.
909 #'
910 #' @usage arv$users.update(user, uuid, bypass_federation = NULL)
911 #' @param user User object.
912 #' @param uuid The UUID of the User in question.
913 #' @param bypass_federation
914 #' @return User object.
915 #' @name users.update
916 NULL
917
918 #' users.delete
919 #'
920 #' users.delete is a method defined in Arvados class.
921 #'
922 #' @usage arv$users.delete(uuid)
923 #' @param uuid The UUID of the User in question.
924 #' @return User object.
925 #' @name users.delete
926 NULL
927
928 #' users.current
929 #'
930 #' users.current is a method defined in Arvados class.
931 #'
932 #' @usage arv$users.current(NULL)
933 #' @return User object.
934 #' @name users.current
935 NULL
936
937 #' users.system
938 #'
939 #' users.system is a method defined in Arvados class.
940 #'
941 #' @usage arv$users.system(NULL)
942 #' @return User object.
943 #' @name users.system
944 NULL
945
946 #' users.activate
947 #'
948 #' users.activate is a method defined in Arvados class.
949 #'
950 #' @usage arv$users.activate(uuid)
951 #' @param uuid
952 #' @return User object.
953 #' @name users.activate
954 NULL
955
956 #' users.setup
957 #'
958 #' users.setup is a method defined in Arvados class.
959 #'
960 #' @usage arv$users.setup(uuid = NULL, user = NULL,
961 #'      repo_name = NULL, vm_uuid = NULL, send_notification_email = "false")
962 #' @param uuid
963 #' @param user
964 #' @param repo_name
965 #' @param vm_uuid
966 #' @param send_notification_email
967 #' @return User object.
968 #' @name users.setup
969 NULL
970
971 #' users.unsetup
972 #'
973 #' users.unsetup is a method defined in Arvados class.
974 #'
975 #' @usage arv$users.unsetup(uuid)
976 #' @param uuid
977 #' @return User object.
978 #' @name users.unsetup
979 NULL
980
981 #' users.merge
982 #'
983 #' users.merge is a method defined in Arvados class.
984 #'
985 #' @usage arv$users.merge(new_owner_uuid,
986 #'      new_user_token = NULL, redirect_to_new_user = NULL,
987 #'      old_user_uuid = NULL, new_user_uuid = NULL)
988 #' @param new_owner_uuid
989 #' @param new_user_token
990 #' @param redirect_to_new_user
991 #' @param old_user_uuid
992 #' @param new_user_uuid
993 #' @return User object.
994 #' @name users.merge
995 NULL
996
997 #' users.list
998 #'
999 #' users.list is a method defined in Arvados class.
1000 #'
1001 #' @usage arv$users.list(filters = NULL,
1002 #'      where = NULL, order = NULL, select = NULL,
1003 #'      distinct = NULL, limit = "100", offset = "0",
1004 #'      count = "exact", cluster_id = NULL, bypass_federation = NULL)
1005 #' @param filters
1006 #' @param where
1007 #' @param order
1008 #' @param select
1009 #' @param distinct
1010 #' @param limit
1011 #' @param offset
1012 #' @param count
1013 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
1014 #' @param bypass_federation bypass federation behavior, list items from local instance database only
1015 #' @return UserList object.
1016 #' @name users.list
1017 NULL
1018
1019 #' repositories.get
1020 #'
1021 #' repositories.get is a method defined in Arvados class.
1022 #'
1023 #' @usage arv$repositories.get(uuid)
1024 #' @param uuid The UUID of the Repository in question.
1025 #' @return Repository object.
1026 #' @name repositories.get
1027 NULL
1028
1029 #' repositories.create
1030 #'
1031 #' repositories.create is a method defined in Arvados class.
1032 #'
1033 #' @usage arv$repositories.create(repository,
1034 #'      ensure_unique_name = "false", cluster_id = NULL)
1035 #' @param repository Repository object.
1036 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
1037 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
1038 #' @return Repository object.
1039 #' @name repositories.create
1040 NULL
1041
1042 #' repositories.update
1043 #'
1044 #' repositories.update is a method defined in Arvados class.
1045 #'
1046 #' @usage arv$repositories.update(repository,
1047 #'      uuid)
1048 #' @param repository Repository object.
1049 #' @param uuid The UUID of the Repository in question.
1050 #' @return Repository object.
1051 #' @name repositories.update
1052 NULL
1053
1054 #' repositories.delete
1055 #'
1056 #' repositories.delete is a method defined in Arvados class.
1057 #'
1058 #' @usage arv$repositories.delete(uuid)
1059 #' @param uuid The UUID of the Repository in question.
1060 #' @return Repository object.
1061 #' @name repositories.delete
1062 NULL
1063
1064 #' repositories.get_all_permissions
1065 #'
1066 #' repositories.get_all_permissions is a method defined in Arvados class.
1067 #'
1068 #' @usage arv$repositories.get_all_permissions(NULL)
1069 #' @return Repository object.
1070 #' @name repositories.get_all_permissions
1071 NULL
1072
1073 #' repositories.list
1074 #'
1075 #' repositories.list is a method defined in Arvados class.
1076 #'
1077 #' @usage arv$repositories.list(filters = NULL,
1078 #'      where = NULL, order = NULL, select = NULL,
1079 #'      distinct = NULL, limit = "100", offset = "0",
1080 #'      count = "exact", cluster_id = NULL, bypass_federation = NULL)
1081 #' @param filters
1082 #' @param where
1083 #' @param order
1084 #' @param select
1085 #' @param distinct
1086 #' @param limit
1087 #' @param offset
1088 #' @param count
1089 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
1090 #' @param bypass_federation bypass federation behavior, list items from local instance database only
1091 #' @return RepositoryList object.
1092 #' @name repositories.list
1093 NULL
1094
1095 #' virtual_machines.get
1096 #'
1097 #' virtual_machines.get is a method defined in Arvados class.
1098 #'
1099 #' @usage arv$virtual_machines.get(uuid)
1100 #' @param uuid The UUID of the VirtualMachine in question.
1101 #' @return VirtualMachine object.
1102 #' @name virtual_machines.get
1103 NULL
1104
1105 #' virtual_machines.create
1106 #'
1107 #' virtual_machines.create is a method defined in Arvados class.
1108 #'
1109 #' @usage arv$virtual_machines.create(virtualmachine,
1110 #'      ensure_unique_name = "false", cluster_id = NULL)
1111 #' @param virtualMachine VirtualMachine object.
1112 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
1113 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
1114 #' @return VirtualMachine object.
1115 #' @name virtual_machines.create
1116 NULL
1117
1118 #' virtual_machines.update
1119 #'
1120 #' virtual_machines.update is a method defined in Arvados class.
1121 #'
1122 #' @usage arv$virtual_machines.update(virtualmachine,
1123 #'      uuid)
1124 #' @param virtualMachine VirtualMachine object.
1125 #' @param uuid The UUID of the VirtualMachine in question.
1126 #' @return VirtualMachine object.
1127 #' @name virtual_machines.update
1128 NULL
1129
1130 #' virtual_machines.delete
1131 #'
1132 #' virtual_machines.delete is a method defined in Arvados class.
1133 #'
1134 #' @usage arv$virtual_machines.delete(uuid)
1135 #' @param uuid The UUID of the VirtualMachine in question.
1136 #' @return VirtualMachine object.
1137 #' @name virtual_machines.delete
1138 NULL
1139
1140 #' virtual_machines.logins
1141 #'
1142 #' virtual_machines.logins is a method defined in Arvados class.
1143 #'
1144 #' @usage arv$virtual_machines.logins(uuid)
1145 #' @param uuid
1146 #' @return VirtualMachine object.
1147 #' @name virtual_machines.logins
1148 NULL
1149
1150 #' virtual_machines.get_all_logins
1151 #'
1152 #' virtual_machines.get_all_logins is a method defined in Arvados class.
1153 #'
1154 #' @usage arv$virtual_machines.get_all_logins(NULL)
1155 #' @return VirtualMachine object.
1156 #' @name virtual_machines.get_all_logins
1157 NULL
1158
1159 #' virtual_machines.list
1160 #'
1161 #' virtual_machines.list is a method defined in Arvados class.
1162 #'
1163 #' @usage arv$virtual_machines.list(filters = NULL,
1164 #'      where = NULL, order = NULL, select = NULL,
1165 #'      distinct = NULL, limit = "100", offset = "0",
1166 #'      count = "exact", cluster_id = NULL, bypass_federation = NULL)
1167 #' @param filters
1168 #' @param where
1169 #' @param order
1170 #' @param select
1171 #' @param distinct
1172 #' @param limit
1173 #' @param offset
1174 #' @param count
1175 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
1176 #' @param bypass_federation bypass federation behavior, list items from local instance database only
1177 #' @return VirtualMachineList object.
1178 #' @name virtual_machines.list
1179 NULL
1180
1181 #' workflows.get
1182 #'
1183 #' workflows.get is a method defined in Arvados class.
1184 #'
1185 #' @usage arv$workflows.get(uuid)
1186 #' @param uuid The UUID of the Workflow in question.
1187 #' @return Workflow object.
1188 #' @name workflows.get
1189 NULL
1190
1191 #' workflows.create
1192 #'
1193 #' workflows.create is a method defined in Arvados class.
1194 #'
1195 #' @usage arv$workflows.create(workflow,
1196 #'      ensure_unique_name = "false", cluster_id = NULL)
1197 #' @param workflow Workflow object.
1198 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
1199 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
1200 #' @return Workflow object.
1201 #' @name workflows.create
1202 NULL
1203
1204 #' workflows.update
1205 #'
1206 #' workflows.update is a method defined in Arvados class.
1207 #'
1208 #' @usage arv$workflows.update(workflow,
1209 #'      uuid)
1210 #' @param workflow Workflow object.
1211 #' @param uuid The UUID of the Workflow in question.
1212 #' @return Workflow object.
1213 #' @name workflows.update
1214 NULL
1215
1216 #' workflows.delete
1217 #'
1218 #' workflows.delete is a method defined in Arvados class.
1219 #'
1220 #' @usage arv$workflows.delete(uuid)
1221 #' @param uuid The UUID of the Workflow in question.
1222 #' @return Workflow object.
1223 #' @name workflows.delete
1224 NULL
1225
1226 #' workflows.list
1227 #'
1228 #' workflows.list is a method defined in Arvados class.
1229 #'
1230 #' @usage arv$workflows.list(filters = NULL,
1231 #'      where = NULL, order = NULL, select = NULL,
1232 #'      distinct = NULL, limit = "100", offset = "0",
1233 #'      count = "exact", cluster_id = NULL, bypass_federation = NULL)
1234 #' @param filters
1235 #' @param where
1236 #' @param order
1237 #' @param select
1238 #' @param distinct
1239 #' @param limit
1240 #' @param offset
1241 #' @param count
1242 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
1243 #' @param bypass_federation bypass federation behavior, list items from local instance database only
1244 #' @return WorkflowList object.
1245 #' @name workflows.list
1246 NULL
1247
1248 #' user_agreements.get
1249 #'
1250 #' user_agreements.get is a method defined in Arvados class.
1251 #'
1252 #' @usage arv$user_agreements.get(uuid)
1253 #' @param uuid The UUID of the UserAgreement in question.
1254 #' @return UserAgreement object.
1255 #' @name user_agreements.get
1256 NULL
1257
1258 #' user_agreements.create
1259 #'
1260 #' user_agreements.create is a method defined in Arvados class.
1261 #'
1262 #' @usage arv$user_agreements.create(useragreement,
1263 #'      ensure_unique_name = "false", cluster_id = NULL)
1264 #' @param userAgreement UserAgreement object.
1265 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
1266 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
1267 #' @return UserAgreement object.
1268 #' @name user_agreements.create
1269 NULL
1270
1271 #' user_agreements.update
1272 #'
1273 #' user_agreements.update is a method defined in Arvados class.
1274 #'
1275 #' @usage arv$user_agreements.update(useragreement,
1276 #'      uuid)
1277 #' @param userAgreement UserAgreement object.
1278 #' @param uuid The UUID of the UserAgreement in question.
1279 #' @return UserAgreement object.
1280 #' @name user_agreements.update
1281 NULL
1282
1283 #' user_agreements.delete
1284 #'
1285 #' user_agreements.delete is a method defined in Arvados class.
1286 #'
1287 #' @usage arv$user_agreements.delete(uuid)
1288 #' @param uuid The UUID of the UserAgreement in question.
1289 #' @return UserAgreement object.
1290 #' @name user_agreements.delete
1291 NULL
1292
1293 #' user_agreements.signatures
1294 #'
1295 #' user_agreements.signatures is a method defined in Arvados class.
1296 #'
1297 #' @usage arv$user_agreements.signatures(NULL)
1298 #' @return UserAgreement object.
1299 #' @name user_agreements.signatures
1300 NULL
1301
1302 #' user_agreements.sign
1303 #'
1304 #' user_agreements.sign is a method defined in Arvados class.
1305 #'
1306 #' @usage arv$user_agreements.sign(NULL)
1307 #' @return UserAgreement object.
1308 #' @name user_agreements.sign
1309 NULL
1310
1311 #' user_agreements.list
1312 #'
1313 #' user_agreements.list is a method defined in Arvados class.
1314 #'
1315 #' @usage arv$user_agreements.list(filters = NULL,
1316 #'      where = NULL, order = NULL, select = NULL,
1317 #'      distinct = NULL, limit = "100", offset = "0",
1318 #'      count = "exact", cluster_id = NULL, bypass_federation = NULL)
1319 #' @param filters
1320 #' @param where
1321 #' @param order
1322 #' @param select
1323 #' @param distinct
1324 #' @param limit
1325 #' @param offset
1326 #' @param count
1327 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
1328 #' @param bypass_federation bypass federation behavior, list items from local instance database only
1329 #' @return UserAgreementList object.
1330 #' @name user_agreements.list
1331 NULL
1332
1333 #' user_agreements.new
1334 #'
1335 #' user_agreements.new is a method defined in Arvados class.
1336 #'
1337 #' @usage arv$user_agreements.new(NULL)
1338 #' @return UserAgreement object.
1339 #' @name user_agreements.new
1340 NULL
1341
1342 #' configs.get
1343 #'
1344 #' configs.get is a method defined in Arvados class.
1345 #'
1346 #' @usage arv$configs.get(NULL)
1347 #' @return  object.
1348 #' @name configs.get
1349 NULL
1350
1351 #' project.get
1352 #'
1353 #' projects.get is equivalent to groups.get method.
1354 #'
1355 #' @usage arv$projects.get(uuid)
1356 #' @param uuid The UUID of the Group in question.
1357 #' @return Group object.
1358 #' @name projects.get
1359 NULL
1360
1361 #' project.create
1362 #'
1363 #' projects.create wrapps groups.create method by setting group_class attribute to "project".
1364 #'
1365 #' @usage arv$projects.create(group, ensure_unique_name = "false")
1366 #' @param group Group object.
1367 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
1368 #' @return Group object.
1369 #' @name projects.create
1370 NULL
1371
1372 #' project.update
1373 #'
1374 #' projects.update wrapps groups.update method by setting group_class attribute to "project".
1375 #'
1376 #' @usage arv$projects.update(group, uuid)
1377 #' @param group Group object.
1378 #' @param uuid The UUID of the Group in question.
1379 #' @return Group object.
1380 #' @name projects.update
1381 NULL
1382
1383 #' project.delete
1384 #'
1385 #' projects.delete is equivalent to groups.delete method.
1386 #'
1387 #' @usage arv$project.delete(uuid)
1388 #' @param uuid The UUID of the Group in question.
1389 #' @return Group object.
1390 #' @name projects.delete
1391 NULL
1392
1393 #' project.list
1394 #'
1395 #' projects.list wrapps groups.list method by setting group_class attribute to "project".
1396 #'
1397 #' @usage arv$projects.list(filters = NULL,
1398 #'      where = NULL, order = NULL, distinct = NULL,
1399 #'      limit = "100", offset = "0", count = "exact",
1400 #'      include_trash = NULL, uuid = NULL, recursive = NULL)
1401 #' @param filters
1402 #' @param where
1403 #' @param order
1404 #' @param distinct
1405 #' @param limit
1406 #' @param offset
1407 #' @param count
1408 #' @param include_trash Include items whose is_trashed attribute is true.
1409 #' @param uuid
1410 #' @param recursive Include contents from child groups recursively.
1411 #' @return Group object.
1412 #' @name projects.list
1413 NULL
1414
1415 #' Arvados
1416 #'
1417 #' Arvados class gives users ability to access Arvados REST API.
1418 #'
1419 #' @section Usage:
1420 #' \preformatted{arv = Arvados$new(authToken = NULL, hostName = NULL, numRetries = 0)}
1421 #'
1422 #' @section Arguments:
1423 #' \describe{
1424 #'      \item{authToken}{Authentification token. If not specified ARVADOS_API_TOKEN environment variable will be used.}
1425 #'      \item{hostName}{Host name. If not specified ARVADOS_API_HOST environment variable will be used.}
1426 #'      \item{numRetries}{Number which specifies how many times to retry failed service requests.}
1427 #' }
1428 #'
1429 #' @section Methods:
1430 #' \describe{
1431 #'      \item{}{\code{\link{api_client_authorizations.create}}}
1432 #'      \item{}{\code{\link{api_client_authorizations.create_system_auth}}}
1433 #'      \item{}{\code{\link{api_client_authorizations.current}}}
1434 #'      \item{}{\code{\link{api_client_authorizations.delete}}}
1435 #'      \item{}{\code{\link{api_client_authorizations.get}}}
1436 #'      \item{}{\code{\link{api_client_authorizations.list}}}
1437 #'      \item{}{\code{\link{api_client_authorizations.update}}}
1438 #'      \item{}{\code{\link{api_clients.create}}}
1439 #'      \item{}{\code{\link{api_clients.delete}}}
1440 #'      \item{}{\code{\link{api_clients.get}}}
1441 #'      \item{}{\code{\link{api_clients.list}}}
1442 #'      \item{}{\code{\link{api_clients.update}}}
1443 #'      \item{}{\code{\link{authorized_keys.create}}}
1444 #'      \item{}{\code{\link{authorized_keys.delete}}}
1445 #'      \item{}{\code{\link{authorized_keys.get}}}
1446 #'      \item{}{\code{\link{authorized_keys.list}}}
1447 #'      \item{}{\code{\link{authorized_keys.update}}}
1448 #'      \item{}{\code{\link{collections.create}}}
1449 #'      \item{}{\code{\link{collections.delete}}}
1450 #'      \item{}{\code{\link{collections.get}}}
1451 #'      \item{}{\code{\link{collections.list}}}
1452 #'      \item{}{\code{\link{collections.provenance}}}
1453 #'      \item{}{\code{\link{collections.trash}}}
1454 #'      \item{}{\code{\link{collections.untrash}}}
1455 #'      \item{}{\code{\link{collections.update}}}
1456 #'      \item{}{\code{\link{collections.used_by}}}
1457 #'      \item{}{\code{\link{configs.get}}}
1458 #'      \item{}{\code{\link{container_requests.create}}}
1459 #'      \item{}{\code{\link{container_requests.delete}}}
1460 #'      \item{}{\code{\link{container_requests.get}}}
1461 #'      \item{}{\code{\link{container_requests.list}}}
1462 #'      \item{}{\code{\link{container_requests.update}}}
1463 #'      \item{}{\code{\link{containers.auth}}}
1464 #'      \item{}{\code{\link{containers.create}}}
1465 #'      \item{}{\code{\link{containers.current}}}
1466 #'      \item{}{\code{\link{containers.delete}}}
1467 #'      \item{}{\code{\link{containers.get}}}
1468 #'      \item{}{\code{\link{containers.list}}}
1469 #'      \item{}{\code{\link{containers.lock}}}
1470 #'      \item{}{\code{\link{containers.secret_mounts}}}
1471 #'      \item{}{\code{\link{containers.unlock}}}
1472 #'      \item{}{\code{\link{containers.update}}}
1473 #'      \item{}{\code{\link{groups.contents}}}
1474 #'      \item{}{\code{\link{groups.create}}}
1475 #'      \item{}{\code{\link{groups.delete}}}
1476 #'      \item{}{\code{\link{groups.get}}}
1477 #'      \item{}{\code{\link{groups.list}}}
1478 #'      \item{}{\code{\link{groups.shared}}}
1479 #'      \item{}{\code{\link{groups.trash}}}
1480 #'      \item{}{\code{\link{groups.untrash}}}
1481 #'      \item{}{\code{\link{groups.update}}}
1482 #'      \item{}{\code{\link{keep_services.accessible}}}
1483 #'      \item{}{\code{\link{keep_services.create}}}
1484 #'      \item{}{\code{\link{keep_services.delete}}}
1485 #'      \item{}{\code{\link{keep_services.get}}}
1486 #'      \item{}{\code{\link{keep_services.list}}}
1487 #'      \item{}{\code{\link{keep_services.update}}}
1488 #'      \item{}{\code{\link{links.create}}}
1489 #'      \item{}{\code{\link{links.delete}}}
1490 #'      \item{}{\code{\link{links.get}}}
1491 #'      \item{}{\code{\link{links.get_permissions}}}
1492 #'      \item{}{\code{\link{links.list}}}
1493 #'      \item{}{\code{\link{links.update}}}
1494 #'      \item{}{\code{\link{logs.create}}}
1495 #'      \item{}{\code{\link{logs.delete}}}
1496 #'      \item{}{\code{\link{logs.get}}}
1497 #'      \item{}{\code{\link{logs.list}}}
1498 #'      \item{}{\code{\link{logs.update}}}
1499 #'      \item{}{\code{\link{projects.create}}}
1500 #'      \item{}{\code{\link{projects.delete}}}
1501 #'      \item{}{\code{\link{projects.get}}}
1502 #'      \item{}{\code{\link{projects.list}}}
1503 #'      \item{}{\code{\link{projects.update}}}
1504 #'      \item{}{\code{\link{repositories.create}}}
1505 #'      \item{}{\code{\link{repositories.delete}}}
1506 #'      \item{}{\code{\link{repositories.get}}}
1507 #'      \item{}{\code{\link{repositories.get_all_permissions}}}
1508 #'      \item{}{\code{\link{repositories.list}}}
1509 #'      \item{}{\code{\link{repositories.update}}}
1510 #'      \item{}{\code{\link{user_agreements.create}}}
1511 #'      \item{}{\code{\link{user_agreements.delete}}}
1512 #'      \item{}{\code{\link{user_agreements.get}}}
1513 #'      \item{}{\code{\link{user_agreements.list}}}
1514 #'      \item{}{\code{\link{user_agreements.new}}}
1515 #'      \item{}{\code{\link{user_agreements.sign}}}
1516 #'      \item{}{\code{\link{user_agreements.signatures}}}
1517 #'      \item{}{\code{\link{user_agreements.update}}}
1518 #'      \item{}{\code{\link{users.activate}}}
1519 #'      \item{}{\code{\link{users.create}}}
1520 #'      \item{}{\code{\link{users.current}}}
1521 #'      \item{}{\code{\link{users.delete}}}
1522 #'      \item{}{\code{\link{users.get}}}
1523 #'      \item{}{\code{\link{users.list}}}
1524 #'      \item{}{\code{\link{users.merge}}}
1525 #'      \item{}{\code{\link{users.setup}}}
1526 #'      \item{}{\code{\link{users.system}}}
1527 #'      \item{}{\code{\link{users.unsetup}}}
1528 #'      \item{}{\code{\link{users.update}}}
1529 #'      \item{}{\code{\link{virtual_machines.create}}}
1530 #'      \item{}{\code{\link{virtual_machines.delete}}}
1531 #'      \item{}{\code{\link{virtual_machines.get}}}
1532 #'      \item{}{\code{\link{virtual_machines.get_all_logins}}}
1533 #'      \item{}{\code{\link{virtual_machines.list}}}
1534 #'      \item{}{\code{\link{virtual_machines.logins}}}
1535 #'      \item{}{\code{\link{virtual_machines.update}}}
1536 #'      \item{}{\code{\link{workflows.create}}}
1537 #'      \item{}{\code{\link{workflows.delete}}}
1538 #'      \item{}{\code{\link{workflows.get}}}
1539 #'      \item{}{\code{\link{workflows.list}}}
1540 #'      \item{}{\code{\link{workflows.update}}}
1541 #' }
1542 #'
1543 #' @name Arvados
1544 #' @examples
1545 #' \dontrun{
1546 #' arv <- Arvados$new("your Arvados token", "example.arvadosapi.com")
1547 #'
1548 #' collection <- arv$collections.get("uuid")
1549 #'
1550 #' collectionList <- arv$collections.list(list(list("name", "like", "Test%")))
1551 #' collectionList <- listAll(arv$collections.list, list(list("name", "like", "Test%")))
1552 #'
1553 #' deletedCollection <- arv$collections.delete("uuid")
1554 #'
1555 #' updatedCollection <- arv$collections.update(list(name = "New name", description = "New description"),
1556 #'                                             "uuid")
1557 #'
1558 #' createdCollection <- arv$collections.create(list(name = "Example",
1559 #'                                                  description = "This is a test collection"))
1560 #' }
1561 NULL
1562
1563 #' @export
1564 Arvados <- R6::R6Class(
1565
1566         "Arvados",
1567
1568         public = list(
1569
1570                 initialize = function(authToken = NULL, hostName = NULL, numRetries = 0)
1571                 {
1572                         if(!is.null(hostName))
1573                                 Sys.setenv(ARVADOS_API_HOST = hostName)
1574
1575                         if(!is.null(authToken))
1576                                 Sys.setenv(ARVADOS_API_TOKEN = authToken)
1577
1578                         hostName <- Sys.getenv("ARVADOS_API_HOST")
1579                         token    <- Sys.getenv("ARVADOS_API_TOKEN")
1580
1581                         if(hostName == "" | token == "")
1582                                 stop(paste("Please provide host name and authentification token",
1583                                                    "or set ARVADOS_API_HOST and ARVADOS_API_TOKEN",
1584                                                    "environment variables."))
1585
1586                         private$token <- token
1587                         private$host  <- paste0("https://", hostName, "/arvados/v1/")
1588                         private$numRetries <- numRetries
1589                         private$REST <- RESTService$new(token, hostName,
1590                                                         HttpRequest$new(), HttpParser$new(),
1591                                                         numRetries)
1592
1593                 },
1594
1595                 projects.get = function(uuid)
1596                 {
1597                         self$groups.get(uuid)
1598                 },
1599
1600                 projects.create = function(group, ensure_unique_name = "false")
1601                 {
1602                         group <- c("group_class" = "project", group)
1603                         self$groups.create(group, ensure_unique_name)
1604                 },
1605
1606                 projects.update = function(group, uuid)
1607                 {
1608                         group <- c("group_class" = "project", group)
1609                         self$groups.update(group, uuid)
1610                 },
1611
1612                 projects.list = function(filters = NULL, where = NULL,
1613                         order = NULL, select = NULL, distinct = NULL,
1614                         limit = "100", offset = "0", count = "exact",
1615                         include_trash = NULL)
1616                 {
1617                         filters[[length(filters) + 1]] <- list("group_class", "=", "project")
1618                         self$groups.list(filters, where, order, select, distinct,
1619                                          limit, offset, count, include_trash)
1620                 },
1621
1622                 projects.delete = function(uuid)
1623                 {
1624                         self$groups.delete(uuid)
1625                 },
1626
1627                 api_clients.get = function(uuid)
1628                 {
1629                         endPoint <- stringr::str_interp("api_clients/${uuid}")
1630                         url <- paste0(private$host, endPoint)
1631                         headers <- list(Authorization = paste("Bearer", private$token),
1632                                         "Content-Type" = "application/json")
1633                         queryArgs <- NULL
1634
1635                         body <- NULL
1636
1637                         response <- private$REST$http$exec("GET", url, headers, body,
1638                                                            queryArgs, private$numRetries)
1639                         resource <- private$REST$httpParser$parseJSONResponse(response)
1640
1641                         if(!is.null(resource$errors))
1642                                 stop(resource$errors)
1643
1644                         resource
1645                 },
1646
1647                 api_clients.create = function(apiclient,
1648                         ensure_unique_name = "false", cluster_id = NULL)
1649                 {
1650                         endPoint <- stringr::str_interp("api_clients")
1651                         url <- paste0(private$host, endPoint)
1652                         headers <- list(Authorization = paste("Bearer", private$token),
1653                                         "Content-Type" = "application/json")
1654                         queryArgs <- list(ensure_unique_name = ensure_unique_name,
1655                                                           cluster_id = cluster_id)
1656
1657                         if(length(apiclient) > 0)
1658                                 body <- jsonlite::toJSON(list(apiclient = apiclient),
1659                                                          auto_unbox = TRUE)
1660                         else
1661                                 body <- NULL
1662
1663                         response <- private$REST$http$exec("POST", url, headers, body,
1664                                                            queryArgs, private$numRetries)
1665                         resource <- private$REST$httpParser$parseJSONResponse(response)
1666
1667                         if(!is.null(resource$errors))
1668                                 stop(resource$errors)
1669
1670                         resource
1671                 },
1672
1673                 api_clients.update = function(apiclient, uuid)
1674                 {
1675                         endPoint <- stringr::str_interp("api_clients/${uuid}")
1676                         url <- paste0(private$host, endPoint)
1677                         headers <- list(Authorization = paste("Bearer", private$token),
1678                                         "Content-Type" = "application/json")
1679                         queryArgs <- NULL
1680
1681                         if(length(apiclient) > 0)
1682                                 body <- jsonlite::toJSON(list(apiclient = apiclient),
1683                                                          auto_unbox = TRUE)
1684                         else
1685                                 body <- NULL
1686
1687                         response <- private$REST$http$exec("PUT", url, headers, body,
1688                                                            queryArgs, private$numRetries)
1689                         resource <- private$REST$httpParser$parseJSONResponse(response)
1690
1691                         if(!is.null(resource$errors))
1692                                 stop(resource$errors)
1693
1694                         resource
1695                 },
1696
1697                 api_clients.delete = function(uuid)
1698                 {
1699                         endPoint <- stringr::str_interp("api_clients/${uuid}")
1700                         url <- paste0(private$host, endPoint)
1701                         headers <- list(Authorization = paste("Bearer", private$token),
1702                                         "Content-Type" = "application/json")
1703                         queryArgs <- NULL
1704
1705                         body <- NULL
1706
1707                         response <- private$REST$http$exec("DELETE", url, headers, body,
1708                                                            queryArgs, private$numRetries)
1709                         resource <- private$REST$httpParser$parseJSONResponse(response)
1710
1711                         if(!is.null(resource$errors))
1712                                 stop(resource$errors)
1713
1714                         resource
1715                 },
1716
1717                 api_clients.list = function(filters = NULL,
1718                         where = NULL, order = NULL, select = NULL,
1719                         distinct = NULL, limit = "100", offset = "0",
1720                         count = "exact", cluster_id = NULL, bypass_federation = NULL)
1721                 {
1722                         endPoint <- stringr::str_interp("api_clients")
1723                         url <- paste0(private$host, endPoint)
1724                         headers <- list(Authorization = paste("Bearer", private$token),
1725                                         "Content-Type" = "application/json")
1726                         queryArgs <- list(filters = filters, where = where,
1727                                                           order = order, select = select, distinct = distinct,
1728                                                           limit = limit, offset = offset, count = count,
1729                                                           cluster_id = cluster_id, bypass_federation = bypass_federation)
1730
1731                         body <- NULL
1732
1733                         response <- private$REST$http$exec("GET", url, headers, body,
1734                                                            queryArgs, private$numRetries)
1735                         resource <- private$REST$httpParser$parseJSONResponse(response)
1736
1737                         if(!is.null(resource$errors))
1738                                 stop(resource$errors)
1739
1740                         resource
1741                 },
1742
1743                 api_client_authorizations.get = function(uuid)
1744                 {
1745                         endPoint <- stringr::str_interp("api_client_authorizations/${uuid}")
1746                         url <- paste0(private$host, endPoint)
1747                         headers <- list(Authorization = paste("Bearer", private$token),
1748                                         "Content-Type" = "application/json")
1749                         queryArgs <- NULL
1750
1751                         body <- NULL
1752
1753                         response <- private$REST$http$exec("GET", url, headers, body,
1754                                                            queryArgs, private$numRetries)
1755                         resource <- private$REST$httpParser$parseJSONResponse(response)
1756
1757                         if(!is.null(resource$errors))
1758                                 stop(resource$errors)
1759
1760                         resource
1761                 },
1762
1763                 api_client_authorizations.create = function(apiclientauthorization,
1764                         ensure_unique_name = "false", cluster_id = NULL)
1765                 {
1766                         endPoint <- stringr::str_interp("api_client_authorizations")
1767                         url <- paste0(private$host, endPoint)
1768                         headers <- list(Authorization = paste("Bearer", private$token),
1769                                         "Content-Type" = "application/json")
1770                         queryArgs <- list(ensure_unique_name = ensure_unique_name,
1771                                                           cluster_id = cluster_id)
1772
1773                         if(length(apiclientauthorization) > 0)
1774                                 body <- jsonlite::toJSON(list(apiclientauthorization = apiclientauthorization),
1775                                                          auto_unbox = TRUE)
1776                         else
1777                                 body <- NULL
1778
1779                         response <- private$REST$http$exec("POST", url, headers, body,
1780                                                            queryArgs, private$numRetries)
1781                         resource <- private$REST$httpParser$parseJSONResponse(response)
1782
1783                         if(!is.null(resource$errors))
1784                                 stop(resource$errors)
1785
1786                         resource
1787                 },
1788
1789                 api_client_authorizations.update = function(apiclientauthorization, uuid)
1790                 {
1791                         endPoint <- stringr::str_interp("api_client_authorizations/${uuid}")
1792                         url <- paste0(private$host, endPoint)
1793                         headers <- list(Authorization = paste("Bearer", private$token),
1794                                         "Content-Type" = "application/json")
1795                         queryArgs <- NULL
1796
1797                         if(length(apiclientauthorization) > 0)
1798                                 body <- jsonlite::toJSON(list(apiclientauthorization = apiclientauthorization),
1799                                                          auto_unbox = TRUE)
1800                         else
1801                                 body <- NULL
1802
1803                         response <- private$REST$http$exec("PUT", url, headers, body,
1804                                                            queryArgs, private$numRetries)
1805                         resource <- private$REST$httpParser$parseJSONResponse(response)
1806
1807                         if(!is.null(resource$errors))
1808                                 stop(resource$errors)
1809
1810                         resource
1811                 },
1812
1813                 api_client_authorizations.delete = function(uuid)
1814                 {
1815                         endPoint <- stringr::str_interp("api_client_authorizations/${uuid}")
1816                         url <- paste0(private$host, endPoint)
1817                         headers <- list(Authorization = paste("Bearer", private$token),
1818                                         "Content-Type" = "application/json")
1819                         queryArgs <- NULL
1820
1821                         body <- NULL
1822
1823                         response <- private$REST$http$exec("DELETE", url, headers, body,
1824                                                            queryArgs, private$numRetries)
1825                         resource <- private$REST$httpParser$parseJSONResponse(response)
1826
1827                         if(!is.null(resource$errors))
1828                                 stop(resource$errors)
1829
1830                         resource
1831                 },
1832
1833                 api_client_authorizations.create_system_auth = function(api_client_id = NULL, scopes = NULL)
1834                 {
1835                         endPoint <- stringr::str_interp("api_client_authorizations/create_system_auth")
1836                         url <- paste0(private$host, endPoint)
1837                         headers <- list(Authorization = paste("Bearer", private$token),
1838                                         "Content-Type" = "application/json")
1839                         queryArgs <- list(api_client_id = api_client_id,
1840                                                           scopes = scopes)
1841
1842                         body <- NULL
1843
1844                         response <- private$REST$http$exec("POST", url, headers, body,
1845                                                            queryArgs, private$numRetries)
1846                         resource <- private$REST$httpParser$parseJSONResponse(response)
1847
1848                         if(!is.null(resource$errors))
1849                                 stop(resource$errors)
1850
1851                         resource
1852                 },
1853
1854                 api_client_authorizations.current = function()
1855                 {
1856                         endPoint <- stringr::str_interp("api_client_authorizations/current")
1857                         url <- paste0(private$host, endPoint)
1858                         headers <- list(Authorization = paste("Bearer", private$token),
1859                                         "Content-Type" = "application/json")
1860                         queryArgs <- NULL
1861
1862                         body <- NULL
1863
1864                         response <- private$REST$http$exec("GET", url, headers, body,
1865                                                            queryArgs, private$numRetries)
1866                         resource <- private$REST$httpParser$parseJSONResponse(response)
1867
1868                         if(!is.null(resource$errors))
1869                                 stop(resource$errors)
1870
1871                         resource
1872                 },
1873
1874                 api_client_authorizations.list = function(filters = NULL,
1875                         where = NULL, order = NULL, select = NULL,
1876                         distinct = NULL, limit = "100", offset = "0",
1877                         count = "exact", cluster_id = NULL, bypass_federation = NULL)
1878                 {
1879                         endPoint <- stringr::str_interp("api_client_authorizations")
1880                         url <- paste0(private$host, endPoint)
1881                         headers <- list(Authorization = paste("Bearer", private$token),
1882                                         "Content-Type" = "application/json")
1883                         queryArgs <- list(filters = filters, where = where,
1884                                                           order = order, select = select, distinct = distinct,
1885                                                           limit = limit, offset = offset, count = count,
1886                                                           cluster_id = cluster_id, bypass_federation = bypass_federation)
1887
1888                         body <- NULL
1889
1890                         response <- private$REST$http$exec("GET", url, headers, body,
1891                                                            queryArgs, private$numRetries)
1892                         resource <- private$REST$httpParser$parseJSONResponse(response)
1893
1894                         if(!is.null(resource$errors))
1895                                 stop(resource$errors)
1896
1897                         resource
1898                 },
1899
1900                 authorized_keys.get = function(uuid)
1901                 {
1902                         endPoint <- stringr::str_interp("authorized_keys/${uuid}")
1903                         url <- paste0(private$host, endPoint)
1904                         headers <- list(Authorization = paste("Bearer", private$token),
1905                                         "Content-Type" = "application/json")
1906                         queryArgs <- NULL
1907
1908                         body <- NULL
1909
1910                         response <- private$REST$http$exec("GET", url, headers, body,
1911                                                            queryArgs, private$numRetries)
1912                         resource <- private$REST$httpParser$parseJSONResponse(response)
1913
1914                         if(!is.null(resource$errors))
1915                                 stop(resource$errors)
1916
1917                         resource
1918                 },
1919
1920                 authorized_keys.create = function(authorizedkey,
1921                         ensure_unique_name = "false", cluster_id = NULL)
1922                 {
1923                         endPoint <- stringr::str_interp("authorized_keys")
1924                         url <- paste0(private$host, endPoint)
1925                         headers <- list(Authorization = paste("Bearer", private$token),
1926                                         "Content-Type" = "application/json")
1927                         queryArgs <- list(ensure_unique_name = ensure_unique_name,
1928                                                           cluster_id = cluster_id)
1929
1930                         if(length(authorizedkey) > 0)
1931                                 body <- jsonlite::toJSON(list(authorizedkey = authorizedkey),
1932                                                          auto_unbox = TRUE)
1933                         else
1934                                 body <- NULL
1935
1936                         response <- private$REST$http$exec("POST", url, headers, body,
1937                                                            queryArgs, private$numRetries)
1938                         resource <- private$REST$httpParser$parseJSONResponse(response)
1939
1940                         if(!is.null(resource$errors))
1941                                 stop(resource$errors)
1942
1943                         resource
1944                 },
1945
1946                 authorized_keys.update = function(authorizedkey, uuid)
1947                 {
1948                         endPoint <- stringr::str_interp("authorized_keys/${uuid}")
1949                         url <- paste0(private$host, endPoint)
1950                         headers <- list(Authorization = paste("Bearer", private$token),
1951                                         "Content-Type" = "application/json")
1952                         queryArgs <- NULL
1953
1954                         if(length(authorizedkey) > 0)
1955                                 body <- jsonlite::toJSON(list(authorizedkey = authorizedkey),
1956                                                          auto_unbox = TRUE)
1957                         else
1958                                 body <- NULL
1959
1960                         response <- private$REST$http$exec("PUT", url, headers, body,
1961                                                            queryArgs, private$numRetries)
1962                         resource <- private$REST$httpParser$parseJSONResponse(response)
1963
1964                         if(!is.null(resource$errors))
1965                                 stop(resource$errors)
1966
1967                         resource
1968                 },
1969
1970                 authorized_keys.delete = function(uuid)
1971                 {
1972                         endPoint <- stringr::str_interp("authorized_keys/${uuid}")
1973                         url <- paste0(private$host, endPoint)
1974                         headers <- list(Authorization = paste("Bearer", private$token),
1975                                         "Content-Type" = "application/json")
1976                         queryArgs <- NULL
1977
1978                         body <- NULL
1979
1980                         response <- private$REST$http$exec("DELETE", url, headers, body,
1981                                                            queryArgs, private$numRetries)
1982                         resource <- private$REST$httpParser$parseJSONResponse(response)
1983
1984                         if(!is.null(resource$errors))
1985                                 stop(resource$errors)
1986
1987                         resource
1988                 },
1989
1990                 authorized_keys.list = function(filters = NULL,
1991                         where = NULL, order = NULL, select = NULL,
1992                         distinct = NULL, limit = "100", offset = "0",
1993                         count = "exact", cluster_id = NULL, bypass_federation = NULL)
1994                 {
1995                         endPoint <- stringr::str_interp("authorized_keys")
1996                         url <- paste0(private$host, endPoint)
1997                         headers <- list(Authorization = paste("Bearer", private$token),
1998                                         "Content-Type" = "application/json")
1999                         queryArgs <- list(filters = filters, where = where,
2000                                                           order = order, select = select, distinct = distinct,
2001                                                           limit = limit, offset = offset, count = count,
2002                                                           cluster_id = cluster_id, bypass_federation = bypass_federation)
2003
2004                         body <- NULL
2005
2006                         response <- private$REST$http$exec("GET", url, headers, body,
2007                                                            queryArgs, private$numRetries)
2008                         resource <- private$REST$httpParser$parseJSONResponse(response)
2009
2010                         if(!is.null(resource$errors))
2011                                 stop(resource$errors)
2012
2013                         resource
2014                 },
2015
2016                 collections.get = function(uuid)
2017                 {
2018                         endPoint <- stringr::str_interp("collections/${uuid}")
2019                         url <- paste0(private$host, endPoint)
2020                         headers <- list(Authorization = paste("Bearer", private$token),
2021                                         "Content-Type" = "application/json")
2022                         queryArgs <- NULL
2023
2024                         body <- NULL
2025
2026                         response <- private$REST$http$exec("GET", url, headers, body,
2027                                                            queryArgs, private$numRetries)
2028                         resource <- private$REST$httpParser$parseJSONResponse(response)
2029
2030                         if(!is.null(resource$errors))
2031                                 stop(resource$errors)
2032
2033                         resource
2034                 },
2035
2036                 collections.create = function(collection,
2037                         ensure_unique_name = "false", cluster_id = NULL)
2038                 {
2039                         endPoint <- stringr::str_interp("collections")
2040                         url <- paste0(private$host, endPoint)
2041                         headers <- list(Authorization = paste("Bearer", private$token),
2042                                         "Content-Type" = "application/json")
2043                         queryArgs <- list(ensure_unique_name = ensure_unique_name,
2044                                                           cluster_id = cluster_id)
2045
2046                         if(length(collection) > 0)
2047                                 body <- jsonlite::toJSON(list(collection = collection),
2048                                                          auto_unbox = TRUE)
2049                         else
2050                                 body <- NULL
2051
2052                         response <- private$REST$http$exec("POST", url, headers, body,
2053                                                            queryArgs, private$numRetries)
2054                         resource <- private$REST$httpParser$parseJSONResponse(response)
2055
2056                         if(!is.null(resource$errors))
2057                                 stop(resource$errors)
2058
2059                         resource
2060                 },
2061
2062                 collections.update = function(collection, uuid)
2063                 {
2064                         endPoint <- stringr::str_interp("collections/${uuid}")
2065                         url <- paste0(private$host, endPoint)
2066                         headers <- list(Authorization = paste("Bearer", private$token),
2067                                         "Content-Type" = "application/json")
2068                         queryArgs <- NULL
2069
2070                         if(length(collection) > 0)
2071                                 body <- jsonlite::toJSON(list(collection = collection),
2072                                                          auto_unbox = TRUE)
2073                         else
2074                                 body <- NULL
2075
2076                         response <- private$REST$http$exec("PUT", url, headers, body,
2077                                                            queryArgs, private$numRetries)
2078                         resource <- private$REST$httpParser$parseJSONResponse(response)
2079
2080                         if(!is.null(resource$errors))
2081                                 stop(resource$errors)
2082
2083                         resource
2084                 },
2085
2086                 collections.delete = function(uuid)
2087                 {
2088                         endPoint <- stringr::str_interp("collections/${uuid}")
2089                         url <- paste0(private$host, endPoint)
2090                         headers <- list(Authorization = paste("Bearer", private$token),
2091                                         "Content-Type" = "application/json")
2092                         queryArgs <- NULL
2093
2094                         body <- NULL
2095
2096                         response <- private$REST$http$exec("DELETE", url, headers, body,
2097                                                            queryArgs, private$numRetries)
2098                         resource <- private$REST$httpParser$parseJSONResponse(response)
2099
2100                         if(!is.null(resource$errors))
2101                                 stop(resource$errors)
2102
2103                         resource
2104                 },
2105
2106                 collections.provenance = function(uuid)
2107                 {
2108                         endPoint <- stringr::str_interp("collections/${uuid}/provenance")
2109                         url <- paste0(private$host, endPoint)
2110                         headers <- list(Authorization = paste("Bearer", private$token),
2111                                         "Content-Type" = "application/json")
2112                         queryArgs <- NULL
2113
2114                         body <- NULL
2115
2116                         response <- private$REST$http$exec("GET", url, headers, body,
2117                                                            queryArgs, private$numRetries)
2118                         resource <- private$REST$httpParser$parseJSONResponse(response)
2119
2120                         if(!is.null(resource$errors))
2121                                 stop(resource$errors)
2122
2123                         resource
2124                 },
2125
2126                 collections.used_by = function(uuid)
2127                 {
2128                         endPoint <- stringr::str_interp("collections/${uuid}/used_by")
2129                         url <- paste0(private$host, endPoint)
2130                         headers <- list(Authorization = paste("Bearer", private$token),
2131                                         "Content-Type" = "application/json")
2132                         queryArgs <- NULL
2133
2134                         body <- NULL
2135
2136                         response <- private$REST$http$exec("GET", url, headers, body,
2137                                                            queryArgs, private$numRetries)
2138                         resource <- private$REST$httpParser$parseJSONResponse(response)
2139
2140                         if(!is.null(resource$errors))
2141                                 stop(resource$errors)
2142
2143                         resource
2144                 },
2145
2146                 collections.trash = function(uuid)
2147                 {
2148                         endPoint <- stringr::str_interp("collections/${uuid}/trash")
2149                         url <- paste0(private$host, endPoint)
2150                         headers <- list(Authorization = paste("Bearer", private$token),
2151                                         "Content-Type" = "application/json")
2152                         queryArgs <- NULL
2153
2154                         body <- NULL
2155
2156                         response <- private$REST$http$exec("POST", url, headers, body,
2157                                                            queryArgs, private$numRetries)
2158                         resource <- private$REST$httpParser$parseJSONResponse(response)
2159
2160                         if(!is.null(resource$errors))
2161                                 stop(resource$errors)
2162
2163                         resource
2164                 },
2165
2166                 collections.untrash = function(uuid)
2167                 {
2168                         endPoint <- stringr::str_interp("collections/${uuid}/untrash")
2169                         url <- paste0(private$host, endPoint)
2170                         headers <- list(Authorization = paste("Bearer", private$token),
2171                                         "Content-Type" = "application/json")
2172                         queryArgs <- NULL
2173
2174                         body <- NULL
2175
2176                         response <- private$REST$http$exec("POST", url, headers, body,
2177                                                            queryArgs, private$numRetries)
2178                         resource <- private$REST$httpParser$parseJSONResponse(response)
2179
2180                         if(!is.null(resource$errors))
2181                                 stop(resource$errors)
2182
2183                         resource
2184                 },
2185
2186                 collections.list = function(filters = NULL,
2187                         where = NULL, order = NULL, select = NULL,
2188                         distinct = NULL, limit = "100", offset = "0",
2189                         count = "exact", cluster_id = NULL, bypass_federation = NULL,
2190                         include_trash = NULL, include_old_versions = NULL)
2191                 {
2192                         endPoint <- stringr::str_interp("collections")
2193                         url <- paste0(private$host, endPoint)
2194                         headers <- list(Authorization = paste("Bearer", private$token),
2195                                         "Content-Type" = "application/json")
2196                         queryArgs <- list(filters = filters, where = where,
2197                                                           order = order, select = select, distinct = distinct,
2198                                                           limit = limit, offset = offset, count = count,
2199                                                           cluster_id = cluster_id, bypass_federation = bypass_federation,
2200                                                           include_trash = include_trash, include_old_versions = include_old_versions)
2201
2202                         body <- NULL
2203
2204                         response <- private$REST$http$exec("GET", url, headers, body,
2205                                                            queryArgs, private$numRetries)
2206                         resource <- private$REST$httpParser$parseJSONResponse(response)
2207
2208                         if(!is.null(resource$errors))
2209                                 stop(resource$errors)
2210
2211                         resource
2212                 },
2213
2214                 containers.get = function(uuid)
2215                 {
2216                         endPoint <- stringr::str_interp("containers/${uuid}")
2217                         url <- paste0(private$host, endPoint)
2218                         headers <- list(Authorization = paste("Bearer", private$token),
2219                                         "Content-Type" = "application/json")
2220                         queryArgs <- NULL
2221
2222                         body <- NULL
2223
2224                         response <- private$REST$http$exec("GET", url, headers, body,
2225                                                            queryArgs, private$numRetries)
2226                         resource <- private$REST$httpParser$parseJSONResponse(response)
2227
2228                         if(!is.null(resource$errors))
2229                                 stop(resource$errors)
2230
2231                         resource
2232                 },
2233
2234                 containers.create = function(container, ensure_unique_name = "false",
2235                         cluster_id = NULL)
2236                 {
2237                         endPoint <- stringr::str_interp("containers")
2238                         url <- paste0(private$host, endPoint)
2239                         headers <- list(Authorization = paste("Bearer", private$token),
2240                                         "Content-Type" = "application/json")
2241                         queryArgs <- list(ensure_unique_name = ensure_unique_name,
2242                                                           cluster_id = cluster_id)
2243
2244                         if(length(container) > 0)
2245                                 body <- jsonlite::toJSON(list(container = container),
2246                                                          auto_unbox = TRUE)
2247                         else
2248                                 body <- NULL
2249
2250                         response <- private$REST$http$exec("POST", url, headers, body,
2251                                                            queryArgs, private$numRetries)
2252                         resource <- private$REST$httpParser$parseJSONResponse(response)
2253
2254                         if(!is.null(resource$errors))
2255                                 stop(resource$errors)
2256
2257                         resource
2258                 },
2259
2260                 containers.update = function(container, uuid)
2261                 {
2262                         endPoint <- stringr::str_interp("containers/${uuid}")
2263                         url <- paste0(private$host, endPoint)
2264                         headers <- list(Authorization = paste("Bearer", private$token),
2265                                         "Content-Type" = "application/json")
2266                         queryArgs <- NULL
2267
2268                         if(length(container) > 0)
2269                                 body <- jsonlite::toJSON(list(container = container),
2270                                                          auto_unbox = TRUE)
2271                         else
2272                                 body <- NULL
2273
2274                         response <- private$REST$http$exec("PUT", url, headers, body,
2275                                                            queryArgs, private$numRetries)
2276                         resource <- private$REST$httpParser$parseJSONResponse(response)
2277
2278                         if(!is.null(resource$errors))
2279                                 stop(resource$errors)
2280
2281                         resource
2282                 },
2283
2284                 containers.delete = function(uuid)
2285                 {
2286                         endPoint <- stringr::str_interp("containers/${uuid}")
2287                         url <- paste0(private$host, endPoint)
2288                         headers <- list(Authorization = paste("Bearer", private$token),
2289                                         "Content-Type" = "application/json")
2290                         queryArgs <- NULL
2291
2292                         body <- NULL
2293
2294                         response <- private$REST$http$exec("DELETE", url, headers, body,
2295                                                            queryArgs, private$numRetries)
2296                         resource <- private$REST$httpParser$parseJSONResponse(response)
2297
2298                         if(!is.null(resource$errors))
2299                                 stop(resource$errors)
2300
2301                         resource
2302                 },
2303
2304                 containers.auth = function(uuid)
2305                 {
2306                         endPoint <- stringr::str_interp("containers/${uuid}/auth")
2307                         url <- paste0(private$host, endPoint)
2308                         headers <- list(Authorization = paste("Bearer", private$token),
2309                                         "Content-Type" = "application/json")
2310                         queryArgs <- NULL
2311
2312                         body <- NULL
2313
2314                         response <- private$REST$http$exec("GET", url, headers, body,
2315                                                            queryArgs, private$numRetries)
2316                         resource <- private$REST$httpParser$parseJSONResponse(response)
2317
2318                         if(!is.null(resource$errors))
2319                                 stop(resource$errors)
2320
2321                         resource
2322                 },
2323
2324                 containers.lock = function(uuid)
2325                 {
2326                         endPoint <- stringr::str_interp("containers/${uuid}/lock")
2327                         url <- paste0(private$host, endPoint)
2328                         headers <- list(Authorization = paste("Bearer", private$token),
2329                                         "Content-Type" = "application/json")
2330                         queryArgs <- NULL
2331
2332                         body <- NULL
2333
2334                         response <- private$REST$http$exec("POST", url, headers, body,
2335                                                            queryArgs, private$numRetries)
2336                         resource <- private$REST$httpParser$parseJSONResponse(response)
2337
2338                         if(!is.null(resource$errors))
2339                                 stop(resource$errors)
2340
2341                         resource
2342                 },
2343
2344                 containers.unlock = function(uuid)
2345                 {
2346                         endPoint <- stringr::str_interp("containers/${uuid}/unlock")
2347                         url <- paste0(private$host, endPoint)
2348                         headers <- list(Authorization = paste("Bearer", private$token),
2349                                         "Content-Type" = "application/json")
2350                         queryArgs <- NULL
2351
2352                         body <- NULL
2353
2354                         response <- private$REST$http$exec("POST", url, headers, body,
2355                                                            queryArgs, private$numRetries)
2356                         resource <- private$REST$httpParser$parseJSONResponse(response)
2357
2358                         if(!is.null(resource$errors))
2359                                 stop(resource$errors)
2360
2361                         resource
2362                 },
2363
2364                 containers.secret_mounts = function(uuid)
2365                 {
2366                         endPoint <- stringr::str_interp("containers/${uuid}/secret_mounts")
2367                         url <- paste0(private$host, endPoint)
2368                         headers <- list(Authorization = paste("Bearer", private$token),
2369                                         "Content-Type" = "application/json")
2370                         queryArgs <- NULL
2371
2372                         body <- NULL
2373
2374                         response <- private$REST$http$exec("GET", url, headers, body,
2375                                                            queryArgs, private$numRetries)
2376                         resource <- private$REST$httpParser$parseJSONResponse(response)
2377
2378                         if(!is.null(resource$errors))
2379                                 stop(resource$errors)
2380
2381                         resource
2382                 },
2383
2384                 containers.current = function()
2385                 {
2386                         endPoint <- stringr::str_interp("containers/current")
2387                         url <- paste0(private$host, endPoint)
2388                         headers <- list(Authorization = paste("Bearer", private$token),
2389                                         "Content-Type" = "application/json")
2390                         queryArgs <- NULL
2391
2392                         body <- NULL
2393
2394                         response <- private$REST$http$exec("GET", url, headers, body,
2395                                                            queryArgs, private$numRetries)
2396                         resource <- private$REST$httpParser$parseJSONResponse(response)
2397
2398                         if(!is.null(resource$errors))
2399                                 stop(resource$errors)
2400
2401                         resource
2402                 },
2403
2404                 containers.list = function(filters = NULL,
2405                         where = NULL, order = NULL, select = NULL,
2406                         distinct = NULL, limit = "100", offset = "0",
2407                         count = "exact", cluster_id = NULL, bypass_federation = NULL)
2408                 {
2409                         endPoint <- stringr::str_interp("containers")
2410                         url <- paste0(private$host, endPoint)
2411                         headers <- list(Authorization = paste("Bearer", private$token),
2412                                         "Content-Type" = "application/json")
2413                         queryArgs <- list(filters = filters, where = where,
2414                                                           order = order, select = select, distinct = distinct,
2415                                                           limit = limit, offset = offset, count = count,
2416                                                           cluster_id = cluster_id, bypass_federation = bypass_federation)
2417
2418                         body <- NULL
2419
2420                         response <- private$REST$http$exec("GET", url, headers, body,
2421                                                            queryArgs, private$numRetries)
2422                         resource <- private$REST$httpParser$parseJSONResponse(response)
2423
2424                         if(!is.null(resource$errors))
2425                                 stop(resource$errors)
2426
2427                         resource
2428                 },
2429
2430                 container_requests.get = function(uuid)
2431                 {
2432                         endPoint <- stringr::str_interp("container_requests/${uuid}")
2433                         url <- paste0(private$host, endPoint)
2434                         headers <- list(Authorization = paste("Bearer", private$token),
2435                                         "Content-Type" = "application/json")
2436                         queryArgs <- NULL
2437
2438                         body <- NULL
2439
2440                         response <- private$REST$http$exec("GET", url, headers, body,
2441                                                            queryArgs, private$numRetries)
2442                         resource <- private$REST$httpParser$parseJSONResponse(response)
2443
2444                         if(!is.null(resource$errors))
2445                                 stop(resource$errors)
2446
2447                         resource
2448                 },
2449
2450                 container_requests.create = function(containerrequest,
2451                         ensure_unique_name = "false", cluster_id = NULL)
2452                 {
2453                         endPoint <- stringr::str_interp("container_requests")
2454                         url <- paste0(private$host, endPoint)
2455                         headers <- list(Authorization = paste("Bearer", private$token),
2456                                         "Content-Type" = "application/json")
2457                         queryArgs <- list(ensure_unique_name = ensure_unique_name,
2458                                                           cluster_id = cluster_id)
2459
2460                         if(length(containerrequest) > 0)
2461                                 body <- jsonlite::toJSON(list(containerrequest = containerrequest),
2462                                                          auto_unbox = TRUE)
2463                         else
2464                                 body <- NULL
2465
2466                         response <- private$REST$http$exec("POST", url, headers, body,
2467                                                            queryArgs, private$numRetries)
2468                         resource <- private$REST$httpParser$parseJSONResponse(response)
2469
2470                         if(!is.null(resource$errors))
2471                                 stop(resource$errors)
2472
2473                         resource
2474                 },
2475
2476                 container_requests.update = function(containerrequest, uuid)
2477                 {
2478                         endPoint <- stringr::str_interp("container_requests/${uuid}")
2479                         url <- paste0(private$host, endPoint)
2480                         headers <- list(Authorization = paste("Bearer", private$token),
2481                                         "Content-Type" = "application/json")
2482                         queryArgs <- NULL
2483
2484                         if(length(containerrequest) > 0)
2485                                 body <- jsonlite::toJSON(list(containerrequest = containerrequest),
2486                                                          auto_unbox = TRUE)
2487                         else
2488                                 body <- NULL
2489
2490                         response <- private$REST$http$exec("PUT", url, headers, body,
2491                                                            queryArgs, private$numRetries)
2492                         resource <- private$REST$httpParser$parseJSONResponse(response)
2493
2494                         if(!is.null(resource$errors))
2495                                 stop(resource$errors)
2496
2497                         resource
2498                 },
2499
2500                 container_requests.delete = function(uuid)
2501                 {
2502                         endPoint <- stringr::str_interp("container_requests/${uuid}")
2503                         url <- paste0(private$host, endPoint)
2504                         headers <- list(Authorization = paste("Bearer", private$token),
2505                                         "Content-Type" = "application/json")
2506                         queryArgs <- NULL
2507
2508                         body <- NULL
2509
2510                         response <- private$REST$http$exec("DELETE", url, headers, body,
2511                                                            queryArgs, private$numRetries)
2512                         resource <- private$REST$httpParser$parseJSONResponse(response)
2513
2514                         if(!is.null(resource$errors))
2515                                 stop(resource$errors)
2516
2517                         resource
2518                 },
2519
2520                 container_requests.list = function(filters = NULL,
2521                         where = NULL, order = NULL, select = NULL,
2522                         distinct = NULL, limit = "100", offset = "0",
2523                         count = "exact", cluster_id = NULL, bypass_federation = NULL,
2524                         include_trash = NULL)
2525                 {
2526                         endPoint <- stringr::str_interp("container_requests")
2527                         url <- paste0(private$host, endPoint)
2528                         headers <- list(Authorization = paste("Bearer", private$token),
2529                                         "Content-Type" = "application/json")
2530                         queryArgs <- list(filters = filters, where = where,
2531                                                           order = order, select = select, distinct = distinct,
2532                                                           limit = limit, offset = offset, count = count,
2533                                                           cluster_id = cluster_id, bypass_federation = bypass_federation,
2534                                                           include_trash = include_trash)
2535
2536                         body <- NULL
2537
2538                         response <- private$REST$http$exec("GET", url, headers, body,
2539                                                            queryArgs, private$numRetries)
2540                         resource <- private$REST$httpParser$parseJSONResponse(response)
2541
2542                         if(!is.null(resource$errors))
2543                                 stop(resource$errors)
2544
2545                         resource
2546                 },
2547
2548                 groups.get = function(uuid)
2549                 {
2550                         endPoint <- stringr::str_interp("groups/${uuid}")
2551                         url <- paste0(private$host, endPoint)
2552                         headers <- list(Authorization = paste("Bearer", private$token),
2553                                         "Content-Type" = "application/json")
2554                         queryArgs <- NULL
2555
2556                         body <- NULL
2557
2558                         response <- private$REST$http$exec("GET", url, headers, body,
2559                                                            queryArgs, private$numRetries)
2560                         resource <- private$REST$httpParser$parseJSONResponse(response)
2561
2562                         if(!is.null(resource$errors))
2563                                 stop(resource$errors)
2564
2565                         resource
2566                 },
2567
2568                 groups.create = function(group, ensure_unique_name = "false",
2569                         cluster_id = NULL, async = "false")
2570                 {
2571                         endPoint <- stringr::str_interp("groups")
2572                         url <- paste0(private$host, endPoint)
2573                         headers <- list(Authorization = paste("Bearer", private$token),
2574                                         "Content-Type" = "application/json")
2575                         queryArgs <- list(ensure_unique_name = ensure_unique_name,
2576                                                           cluster_id = cluster_id, async = async)
2577
2578                         if(length(group) > 0)
2579                                 body <- jsonlite::toJSON(list(group = group),
2580                                                          auto_unbox = TRUE)
2581                         else
2582                                 body <- NULL
2583
2584                         response <- private$REST$http$exec("POST", url, headers, body,
2585                                                            queryArgs, private$numRetries)
2586                         resource <- private$REST$httpParser$parseJSONResponse(response)
2587
2588                         if(!is.null(resource$errors))
2589                                 stop(resource$errors)
2590
2591                         resource
2592                 },
2593
2594                 groups.update = function(group, uuid, async = "false")
2595                 {
2596                         endPoint <- stringr::str_interp("groups/${uuid}")
2597                         url <- paste0(private$host, endPoint)
2598                         headers <- list(Authorization = paste("Bearer", private$token),
2599                                         "Content-Type" = "application/json")
2600                         queryArgs <- list(async = async)
2601
2602                         if(length(group) > 0)
2603                                 body <- jsonlite::toJSON(list(group = group),
2604                                                          auto_unbox = TRUE)
2605                         else
2606                                 body <- NULL
2607
2608                         response <- private$REST$http$exec("PUT", url, headers, body,
2609                                                            queryArgs, private$numRetries)
2610                         resource <- private$REST$httpParser$parseJSONResponse(response)
2611
2612                         if(!is.null(resource$errors))
2613                                 stop(resource$errors)
2614
2615                         resource
2616                 },
2617
2618                 groups.delete = function(uuid)
2619                 {
2620                         endPoint <- stringr::str_interp("groups/${uuid}")
2621                         url <- paste0(private$host, endPoint)
2622                         headers <- list(Authorization = paste("Bearer", private$token),
2623                                         "Content-Type" = "application/json")
2624                         queryArgs <- NULL
2625
2626                         body <- NULL
2627
2628                         response <- private$REST$http$exec("DELETE", url, headers, body,
2629                                                            queryArgs, private$numRetries)
2630                         resource <- private$REST$httpParser$parseJSONResponse(response)
2631
2632                         if(!is.null(resource$errors))
2633                                 stop(resource$errors)
2634
2635                         resource
2636                 },
2637
2638                 groups.contents = function(filters = NULL,
2639                         where = NULL, order = NULL, distinct = NULL,
2640                         limit = "100", offset = "0", count = "exact",
2641                         cluster_id = NULL, bypass_federation = NULL,
2642                         include_trash = NULL, uuid = NULL, recursive = NULL,
2643                         include = NULL)
2644                 {
2645                         endPoint <- stringr::str_interp("groups/contents")
2646                         url <- paste0(private$host, endPoint)
2647                         headers <- list(Authorization = paste("Bearer", private$token),
2648                                         "Content-Type" = "application/json")
2649                         queryArgs <- list(filters = filters, where = where,
2650                                                           order = order, distinct = distinct, limit = limit,
2651                                                           offset = offset, count = count, cluster_id = cluster_id,
2652                                                           bypass_federation = bypass_federation, include_trash = include_trash,
2653                                                           uuid = uuid, recursive = recursive, include = include)
2654
2655                         body <- NULL
2656
2657                         response <- private$REST$http$exec("GET", url, headers, body,
2658                                                            queryArgs, private$numRetries)
2659                         resource <- private$REST$httpParser$parseJSONResponse(response)
2660
2661                         if(!is.null(resource$errors))
2662                                 stop(resource$errors)
2663
2664                         resource
2665                 },
2666
2667                 groups.shared = function(filters = NULL,
2668                         where = NULL, order = NULL, select = NULL,
2669                         distinct = NULL, limit = "100", offset = "0",
2670                         count = "exact", cluster_id = NULL, bypass_federation = NULL,
2671                         include_trash = NULL, include = NULL)
2672                 {
2673                         endPoint <- stringr::str_interp("groups/shared")
2674                         url <- paste0(private$host, endPoint)
2675                         headers <- list(Authorization = paste("Bearer", private$token),
2676                                         "Content-Type" = "application/json")
2677                         queryArgs <- list(filters = filters, where = where,
2678                                                           order = order, select = select, distinct = distinct,
2679                                                           limit = limit, offset = offset, count = count,
2680                                                           cluster_id = cluster_id, bypass_federation = bypass_federation,
2681                                                           include_trash = include_trash, include = include)
2682
2683                         body <- NULL
2684
2685                         response <- private$REST$http$exec("GET", url, headers, body,
2686                                                            queryArgs, private$numRetries)
2687                         resource <- private$REST$httpParser$parseJSONResponse(response)
2688
2689                         if(!is.null(resource$errors))
2690                                 stop(resource$errors)
2691
2692                         resource
2693                 },
2694
2695                 groups.trash = function(uuid)
2696                 {
2697                         endPoint <- stringr::str_interp("groups/${uuid}/trash")
2698                         url <- paste0(private$host, endPoint)
2699                         headers <- list(Authorization = paste("Bearer", private$token),
2700                                         "Content-Type" = "application/json")
2701                         queryArgs <- NULL
2702
2703                         body <- NULL
2704
2705                         response <- private$REST$http$exec("POST", url, headers, body,
2706                                                            queryArgs, private$numRetries)
2707                         resource <- private$REST$httpParser$parseJSONResponse(response)
2708
2709                         if(!is.null(resource$errors))
2710                                 stop(resource$errors)
2711
2712                         resource
2713                 },
2714
2715                 groups.untrash = function(uuid)
2716                 {
2717                         endPoint <- stringr::str_interp("groups/${uuid}/untrash")
2718                         url <- paste0(private$host, endPoint)
2719                         headers <- list(Authorization = paste("Bearer", private$token),
2720                                         "Content-Type" = "application/json")
2721                         queryArgs <- NULL
2722
2723                         body <- NULL
2724
2725                         response <- private$REST$http$exec("POST", url, headers, body,
2726                                                            queryArgs, private$numRetries)
2727                         resource <- private$REST$httpParser$parseJSONResponse(response)
2728
2729                         if(!is.null(resource$errors))
2730                                 stop(resource$errors)
2731
2732                         resource
2733                 },
2734
2735                 groups.list = function(filters = NULL, where = NULL,
2736                         order = NULL, select = NULL, distinct = NULL,
2737                         limit = "100", offset = "0", count = "exact",
2738                         cluster_id = NULL, bypass_federation = NULL,
2739                         include_trash = NULL)
2740                 {
2741                         endPoint <- stringr::str_interp("groups")
2742                         url <- paste0(private$host, endPoint)
2743                         headers <- list(Authorization = paste("Bearer", private$token),
2744                                         "Content-Type" = "application/json")
2745                         queryArgs <- list(filters = filters, where = where,
2746                                                           order = order, select = select, distinct = distinct,
2747                                                           limit = limit, offset = offset, count = count,
2748                                                           cluster_id = cluster_id, bypass_federation = bypass_federation,
2749                                                           include_trash = include_trash)
2750
2751                         body <- NULL
2752
2753                         response <- private$REST$http$exec("GET", url, headers, body,
2754                                                            queryArgs, private$numRetries)
2755                         resource <- private$REST$httpParser$parseJSONResponse(response)
2756
2757                         if(!is.null(resource$errors))
2758                                 stop(resource$errors)
2759
2760                         resource
2761                 },
2762
2763                 keep_services.get = function(uuid)
2764                 {
2765                         endPoint <- stringr::str_interp("keep_services/${uuid}")
2766                         url <- paste0(private$host, endPoint)
2767                         headers <- list(Authorization = paste("Bearer", private$token),
2768                                         "Content-Type" = "application/json")
2769                         queryArgs <- NULL
2770
2771                         body <- NULL
2772
2773                         response <- private$REST$http$exec("GET", url, headers, body,
2774                                                            queryArgs, private$numRetries)
2775                         resource <- private$REST$httpParser$parseJSONResponse(response)
2776
2777                         if(!is.null(resource$errors))
2778                                 stop(resource$errors)
2779
2780                         resource
2781                 },
2782
2783                 keep_services.create = function(keepservice,
2784                         ensure_unique_name = "false", cluster_id = NULL)
2785                 {
2786                         endPoint <- stringr::str_interp("keep_services")
2787                         url <- paste0(private$host, endPoint)
2788                         headers <- list(Authorization = paste("Bearer", private$token),
2789                                         "Content-Type" = "application/json")
2790                         queryArgs <- list(ensure_unique_name = ensure_unique_name,
2791                                                           cluster_id = cluster_id)
2792
2793                         if(length(keepservice) > 0)
2794                                 body <- jsonlite::toJSON(list(keepservice = keepservice),
2795                                                          auto_unbox = TRUE)
2796                         else
2797                                 body <- NULL
2798
2799                         response <- private$REST$http$exec("POST", url, headers, body,
2800                                                            queryArgs, private$numRetries)
2801                         resource <- private$REST$httpParser$parseJSONResponse(response)
2802
2803                         if(!is.null(resource$errors))
2804                                 stop(resource$errors)
2805
2806                         resource
2807                 },
2808
2809                 keep_services.update = function(keepservice, uuid)
2810                 {
2811                         endPoint <- stringr::str_interp("keep_services/${uuid}")
2812                         url <- paste0(private$host, endPoint)
2813                         headers <- list(Authorization = paste("Bearer", private$token),
2814                                         "Content-Type" = "application/json")
2815                         queryArgs <- NULL
2816
2817                         if(length(keepservice) > 0)
2818                                 body <- jsonlite::toJSON(list(keepservice = keepservice),
2819                                                          auto_unbox = TRUE)
2820                         else
2821                                 body <- NULL
2822
2823                         response <- private$REST$http$exec("PUT", url, headers, body,
2824                                                            queryArgs, private$numRetries)
2825                         resource <- private$REST$httpParser$parseJSONResponse(response)
2826
2827                         if(!is.null(resource$errors))
2828                                 stop(resource$errors)
2829
2830                         resource
2831                 },
2832
2833                 keep_services.delete = function(uuid)
2834                 {
2835                         endPoint <- stringr::str_interp("keep_services/${uuid}")
2836                         url <- paste0(private$host, endPoint)
2837                         headers <- list(Authorization = paste("Bearer", private$token),
2838                                         "Content-Type" = "application/json")
2839                         queryArgs <- NULL
2840
2841                         body <- NULL
2842
2843                         response <- private$REST$http$exec("DELETE", url, headers, body,
2844                                                            queryArgs, private$numRetries)
2845                         resource <- private$REST$httpParser$parseJSONResponse(response)
2846
2847                         if(!is.null(resource$errors))
2848                                 stop(resource$errors)
2849
2850                         resource
2851                 },
2852
2853                 keep_services.accessible = function()
2854                 {
2855                         endPoint <- stringr::str_interp("keep_services/accessible")
2856                         url <- paste0(private$host, endPoint)
2857                         headers <- list(Authorization = paste("Bearer", private$token),
2858                                         "Content-Type" = "application/json")
2859                         queryArgs <- NULL
2860
2861                         body <- NULL
2862
2863                         response <- private$REST$http$exec("GET", url, headers, body,
2864                                                            queryArgs, private$numRetries)
2865                         resource <- private$REST$httpParser$parseJSONResponse(response)
2866
2867                         if(!is.null(resource$errors))
2868                                 stop(resource$errors)
2869
2870                         resource
2871                 },
2872
2873                 keep_services.list = function(filters = NULL,
2874                         where = NULL, order = NULL, select = NULL,
2875                         distinct = NULL, limit = "100", offset = "0",
2876                         count = "exact", cluster_id = NULL, bypass_federation = NULL)
2877                 {
2878                         endPoint <- stringr::str_interp("keep_services")
2879                         url <- paste0(private$host, endPoint)
2880                         headers <- list(Authorization = paste("Bearer", private$token),
2881                                         "Content-Type" = "application/json")
2882                         queryArgs <- list(filters = filters, where = where,
2883                                                           order = order, select = select, distinct = distinct,
2884                                                           limit = limit, offset = offset, count = count,
2885                                                           cluster_id = cluster_id, bypass_federation = bypass_federation)
2886
2887                         body <- NULL
2888
2889                         response <- private$REST$http$exec("GET", url, headers, body,
2890                                                            queryArgs, private$numRetries)
2891                         resource <- private$REST$httpParser$parseJSONResponse(response)
2892
2893                         if(!is.null(resource$errors))
2894                                 stop(resource$errors)
2895
2896                         resource
2897                 },
2898
2899                 links.get = function(uuid)
2900                 {
2901                         endPoint <- stringr::str_interp("links/${uuid}")
2902                         url <- paste0(private$host, endPoint)
2903                         headers <- list(Authorization = paste("Bearer", private$token),
2904                                         "Content-Type" = "application/json")
2905                         queryArgs <- NULL
2906
2907                         body <- NULL
2908
2909                         response <- private$REST$http$exec("GET", url, headers, body,
2910                                                            queryArgs, private$numRetries)
2911                         resource <- private$REST$httpParser$parseJSONResponse(response)
2912
2913                         if(!is.null(resource$errors))
2914                                 stop(resource$errors)
2915
2916                         resource
2917                 },
2918
2919                 links.create = function(link, ensure_unique_name = "false",
2920                         cluster_id = NULL)
2921                 {
2922                         endPoint <- stringr::str_interp("links")
2923                         url <- paste0(private$host, endPoint)
2924                         headers <- list(Authorization = paste("Bearer", private$token),
2925                                         "Content-Type" = "application/json")
2926                         queryArgs <- list(ensure_unique_name = ensure_unique_name,
2927                                                           cluster_id = cluster_id)
2928
2929                         if(length(link) > 0)
2930                                 body <- jsonlite::toJSON(list(link = link),
2931                                                          auto_unbox = TRUE)
2932                         else
2933                                 body <- NULL
2934
2935                         response <- private$REST$http$exec("POST", url, headers, body,
2936                                                            queryArgs, private$numRetries)
2937                         resource <- private$REST$httpParser$parseJSONResponse(response)
2938
2939                         if(!is.null(resource$errors))
2940                                 stop(resource$errors)
2941
2942                         resource
2943                 },
2944
2945                 links.update = function(link, uuid)
2946                 {
2947                         endPoint <- stringr::str_interp("links/${uuid}")
2948                         url <- paste0(private$host, endPoint)
2949                         headers <- list(Authorization = paste("Bearer", private$token),
2950                                         "Content-Type" = "application/json")
2951                         queryArgs <- NULL
2952
2953                         if(length(link) > 0)
2954                                 body <- jsonlite::toJSON(list(link = link),
2955                                                          auto_unbox = TRUE)
2956                         else
2957                                 body <- NULL
2958
2959                         response <- private$REST$http$exec("PUT", url, headers, body,
2960                                                            queryArgs, private$numRetries)
2961                         resource <- private$REST$httpParser$parseJSONResponse(response)
2962
2963                         if(!is.null(resource$errors))
2964                                 stop(resource$errors)
2965
2966                         resource
2967                 },
2968
2969                 links.delete = function(uuid)
2970                 {
2971                         endPoint <- stringr::str_interp("links/${uuid}")
2972                         url <- paste0(private$host, endPoint)
2973                         headers <- list(Authorization = paste("Bearer", private$token),
2974                                         "Content-Type" = "application/json")
2975                         queryArgs <- NULL
2976
2977                         body <- NULL
2978
2979                         response <- private$REST$http$exec("DELETE", url, headers, body,
2980                                                            queryArgs, private$numRetries)
2981                         resource <- private$REST$httpParser$parseJSONResponse(response)
2982
2983                         if(!is.null(resource$errors))
2984                                 stop(resource$errors)
2985
2986                         resource
2987                 },
2988
2989                 links.list = function(filters = NULL, where = NULL,
2990                         order = NULL, select = NULL, distinct = NULL,
2991                         limit = "100", offset = "0", count = "exact",
2992                         cluster_id = NULL, bypass_federation = NULL)
2993                 {
2994                         endPoint <- stringr::str_interp("links")
2995                         url <- paste0(private$host, endPoint)
2996                         headers <- list(Authorization = paste("Bearer", private$token),
2997                                         "Content-Type" = "application/json")
2998                         queryArgs <- list(filters = filters, where = where,
2999                                                           order = order, select = select, distinct = distinct,
3000                                                           limit = limit, offset = offset, count = count,
3001                                                           cluster_id = cluster_id, bypass_federation = bypass_federation)
3002
3003                         body <- NULL
3004
3005                         response <- private$REST$http$exec("GET", url, headers, body,
3006                                                            queryArgs, private$numRetries)
3007                         resource <- private$REST$httpParser$parseJSONResponse(response)
3008
3009                         if(!is.null(resource$errors))
3010                                 stop(resource$errors)
3011
3012                         resource
3013                 },
3014
3015                 links.get_permissions = function(uuid)
3016                 {
3017                         endPoint <- stringr::str_interp("permissions/${uuid}")
3018                         url <- paste0(private$host, endPoint)
3019                         headers <- list(Authorization = paste("Bearer", private$token),
3020                                         "Content-Type" = "application/json")
3021                         queryArgs <- NULL
3022
3023                         body <- NULL
3024
3025                         response <- private$REST$http$exec("GET", url, headers, body,
3026                                                            queryArgs, private$numRetries)
3027                         resource <- private$REST$httpParser$parseJSONResponse(response)
3028
3029                         if(!is.null(resource$errors))
3030                                 stop(resource$errors)
3031
3032                         resource
3033                 },
3034
3035                 logs.get = function(uuid)
3036                 {
3037                         endPoint <- stringr::str_interp("logs/${uuid}")
3038                         url <- paste0(private$host, endPoint)
3039                         headers <- list(Authorization = paste("Bearer", private$token),
3040                                         "Content-Type" = "application/json")
3041                         queryArgs <- NULL
3042
3043                         body <- NULL
3044
3045                         response <- private$REST$http$exec("GET", url, headers, body,
3046                                                            queryArgs, private$numRetries)
3047                         resource <- private$REST$httpParser$parseJSONResponse(response)
3048
3049                         if(!is.null(resource$errors))
3050                                 stop(resource$errors)
3051
3052                         resource
3053                 },
3054
3055                 logs.create = function(log, ensure_unique_name = "false",
3056                         cluster_id = NULL)
3057                 {
3058                         endPoint <- stringr::str_interp("logs")
3059                         url <- paste0(private$host, endPoint)
3060                         headers <- list(Authorization = paste("Bearer", private$token),
3061                                         "Content-Type" = "application/json")
3062                         queryArgs <- list(ensure_unique_name = ensure_unique_name,
3063                                                           cluster_id = cluster_id)
3064
3065                         if(length(log) > 0)
3066                                 body <- jsonlite::toJSON(list(log = log),
3067                                                          auto_unbox = TRUE)
3068                         else
3069                                 body <- NULL
3070
3071                         response <- private$REST$http$exec("POST", url, headers, body,
3072                                                            queryArgs, private$numRetries)
3073                         resource <- private$REST$httpParser$parseJSONResponse(response)
3074
3075                         if(!is.null(resource$errors))
3076                                 stop(resource$errors)
3077
3078                         resource
3079                 },
3080
3081                 logs.update = function(log, uuid)
3082                 {
3083                         endPoint <- stringr::str_interp("logs/${uuid}")
3084                         url <- paste0(private$host, endPoint)
3085                         headers <- list(Authorization = paste("Bearer", private$token),
3086                                         "Content-Type" = "application/json")
3087                         queryArgs <- NULL
3088
3089                         if(length(log) > 0)
3090                                 body <- jsonlite::toJSON(list(log = log),
3091                                                          auto_unbox = TRUE)
3092                         else
3093                                 body <- NULL
3094
3095                         response <- private$REST$http$exec("PUT", url, headers, body,
3096                                                            queryArgs, private$numRetries)
3097                         resource <- private$REST$httpParser$parseJSONResponse(response)
3098
3099                         if(!is.null(resource$errors))
3100                                 stop(resource$errors)
3101
3102                         resource
3103                 },
3104
3105                 logs.delete = function(uuid)
3106                 {
3107                         endPoint <- stringr::str_interp("logs/${uuid}")
3108                         url <- paste0(private$host, endPoint)
3109                         headers <- list(Authorization = paste("Bearer", private$token),
3110                                         "Content-Type" = "application/json")
3111                         queryArgs <- NULL
3112
3113                         body <- NULL
3114
3115                         response <- private$REST$http$exec("DELETE", url, headers, body,
3116                                                            queryArgs, private$numRetries)
3117                         resource <- private$REST$httpParser$parseJSONResponse(response)
3118
3119                         if(!is.null(resource$errors))
3120                                 stop(resource$errors)
3121
3122                         resource
3123                 },
3124
3125                 logs.list = function(filters = NULL, where = NULL,
3126                         order = NULL, select = NULL, distinct = NULL,
3127                         limit = "100", offset = "0", count = "exact",
3128                         cluster_id = NULL, bypass_federation = NULL)
3129                 {
3130                         endPoint <- stringr::str_interp("logs")
3131                         url <- paste0(private$host, endPoint)
3132                         headers <- list(Authorization = paste("Bearer", private$token),
3133                                         "Content-Type" = "application/json")
3134                         queryArgs <- list(filters = filters, where = where,
3135                                                           order = order, select = select, distinct = distinct,
3136                                                           limit = limit, offset = offset, count = count,
3137                                                           cluster_id = cluster_id, bypass_federation = bypass_federation)
3138
3139                         body <- NULL
3140
3141                         response <- private$REST$http$exec("GET", url, headers, body,
3142                                                            queryArgs, private$numRetries)
3143                         resource <- private$REST$httpParser$parseJSONResponse(response)
3144
3145                         if(!is.null(resource$errors))
3146                                 stop(resource$errors)
3147
3148                         resource
3149                 },
3150
3151                 users.get = function(uuid)
3152                 {
3153                         endPoint <- stringr::str_interp("users/${uuid}")
3154                         url <- paste0(private$host, endPoint)
3155                         headers <- list(Authorization = paste("Bearer", private$token),
3156                                         "Content-Type" = "application/json")
3157                         queryArgs <- NULL
3158
3159                         body <- NULL
3160
3161                         response <- private$REST$http$exec("GET", url, headers, body,
3162                                                            queryArgs, private$numRetries)
3163                         resource <- private$REST$httpParser$parseJSONResponse(response)
3164
3165                         if(!is.null(resource$errors))
3166                                 stop(resource$errors)
3167
3168                         resource
3169                 },
3170
3171                 users.create = function(user, ensure_unique_name = "false",
3172                         cluster_id = NULL)
3173                 {
3174                         endPoint <- stringr::str_interp("users")
3175                         url <- paste0(private$host, endPoint)
3176                         headers <- list(Authorization = paste("Bearer", private$token),
3177                                         "Content-Type" = "application/json")
3178                         queryArgs <- list(ensure_unique_name = ensure_unique_name,
3179                                                           cluster_id = cluster_id)
3180
3181                         if(length(user) > 0)
3182                                 body <- jsonlite::toJSON(list(user = user),
3183                                                          auto_unbox = TRUE)
3184                         else
3185                                 body <- NULL
3186
3187                         response <- private$REST$http$exec("POST", url, headers, body,
3188                                                            queryArgs, private$numRetries)
3189                         resource <- private$REST$httpParser$parseJSONResponse(response)
3190
3191                         if(!is.null(resource$errors))
3192                                 stop(resource$errors)
3193
3194                         resource
3195                 },
3196
3197                 users.update = function(user, uuid, bypass_federation = NULL)
3198                 {
3199                         endPoint <- stringr::str_interp("users/${uuid}")
3200                         url <- paste0(private$host, endPoint)
3201                         headers <- list(Authorization = paste("Bearer", private$token),
3202                                         "Content-Type" = "application/json")
3203                         queryArgs <- list(bypass_federation = bypass_federation)
3204
3205                         if(length(user) > 0)
3206                                 body <- jsonlite::toJSON(list(user = user),
3207                                                          auto_unbox = TRUE)
3208                         else
3209                                 body <- NULL
3210
3211                         response <- private$REST$http$exec("PUT", url, headers, body,
3212                                                            queryArgs, private$numRetries)
3213                         resource <- private$REST$httpParser$parseJSONResponse(response)
3214
3215                         if(!is.null(resource$errors))
3216                                 stop(resource$errors)
3217
3218                         resource
3219                 },
3220
3221                 users.delete = function(uuid)
3222                 {
3223                         endPoint <- stringr::str_interp("users/${uuid}")
3224                         url <- paste0(private$host, endPoint)
3225                         headers <- list(Authorization = paste("Bearer", private$token),
3226                                         "Content-Type" = "application/json")
3227                         queryArgs <- NULL
3228
3229                         body <- NULL
3230
3231                         response <- private$REST$http$exec("DELETE", url, headers, body,
3232                                                            queryArgs, private$numRetries)
3233                         resource <- private$REST$httpParser$parseJSONResponse(response)
3234
3235                         if(!is.null(resource$errors))
3236                                 stop(resource$errors)
3237
3238                         resource
3239                 },
3240
3241                 users.current = function()
3242                 {
3243                         endPoint <- stringr::str_interp("users/current")
3244                         url <- paste0(private$host, endPoint)
3245                         headers <- list(Authorization = paste("Bearer", private$token),
3246                                         "Content-Type" = "application/json")
3247                         queryArgs <- NULL
3248
3249                         body <- NULL
3250
3251                         response <- private$REST$http$exec("GET", url, headers, body,
3252                                                            queryArgs, private$numRetries)
3253                         resource <- private$REST$httpParser$parseJSONResponse(response)
3254
3255                         if(!is.null(resource$errors))
3256                                 stop(resource$errors)
3257
3258                         resource
3259                 },
3260
3261                 users.system = function()
3262                 {
3263                         endPoint <- stringr::str_interp("users/system")
3264                         url <- paste0(private$host, endPoint)
3265                         headers <- list(Authorization = paste("Bearer", private$token),
3266                                         "Content-Type" = "application/json")
3267                         queryArgs <- NULL
3268
3269                         body <- NULL
3270
3271                         response <- private$REST$http$exec("GET", url, headers, body,
3272                                                            queryArgs, private$numRetries)
3273                         resource <- private$REST$httpParser$parseJSONResponse(response)
3274
3275                         if(!is.null(resource$errors))
3276                                 stop(resource$errors)
3277
3278                         resource
3279                 },
3280
3281                 users.activate = function(uuid)
3282                 {
3283                         endPoint <- stringr::str_interp("users/${uuid}/activate")
3284                         url <- paste0(private$host, endPoint)
3285                         headers <- list(Authorization = paste("Bearer", private$token),
3286                                         "Content-Type" = "application/json")
3287                         queryArgs <- NULL
3288
3289                         body <- NULL
3290
3291                         response <- private$REST$http$exec("POST", url, headers, body,
3292                                                            queryArgs, private$numRetries)
3293                         resource <- private$REST$httpParser$parseJSONResponse(response)
3294
3295                         if(!is.null(resource$errors))
3296                                 stop(resource$errors)
3297
3298                         resource
3299                 },
3300
3301                 users.setup = function(uuid = NULL, user = NULL,
3302                         repo_name = NULL, vm_uuid = NULL, send_notification_email = "false")
3303                 {
3304                         endPoint <- stringr::str_interp("users/setup")
3305                         url <- paste0(private$host, endPoint)
3306                         headers <- list(Authorization = paste("Bearer", private$token),
3307                                         "Content-Type" = "application/json")
3308                         queryArgs <- list(uuid = uuid, user = user,
3309                                                           repo_name = repo_name, vm_uuid = vm_uuid,
3310                                                           send_notification_email = send_notification_email)
3311
3312                         body <- NULL
3313
3314                         response <- private$REST$http$exec("POST", url, headers, body,
3315                                                            queryArgs, private$numRetries)
3316                         resource <- private$REST$httpParser$parseJSONResponse(response)
3317
3318                         if(!is.null(resource$errors))
3319                                 stop(resource$errors)
3320
3321                         resource
3322                 },
3323
3324                 users.unsetup = function(uuid)
3325                 {
3326                         endPoint <- stringr::str_interp("users/${uuid}/unsetup")
3327                         url <- paste0(private$host, endPoint)
3328                         headers <- list(Authorization = paste("Bearer", private$token),
3329                                         "Content-Type" = "application/json")
3330                         queryArgs <- NULL
3331
3332                         body <- NULL
3333
3334                         response <- private$REST$http$exec("POST", url, headers, body,
3335                                                            queryArgs, private$numRetries)
3336                         resource <- private$REST$httpParser$parseJSONResponse(response)
3337
3338                         if(!is.null(resource$errors))
3339                                 stop(resource$errors)
3340
3341                         resource
3342                 },
3343
3344                 users.merge = function(new_owner_uuid, new_user_token = NULL,
3345                         redirect_to_new_user = NULL, old_user_uuid = NULL,
3346                         new_user_uuid = NULL)
3347                 {
3348                         endPoint <- stringr::str_interp("users/merge")
3349                         url <- paste0(private$host, endPoint)
3350                         headers <- list(Authorization = paste("Bearer", private$token),
3351                                         "Content-Type" = "application/json")
3352                         queryArgs <- list(new_owner_uuid = new_owner_uuid,
3353                                                           new_user_token = new_user_token, redirect_to_new_user = redirect_to_new_user,
3354                                                           old_user_uuid = old_user_uuid, new_user_uuid = new_user_uuid)
3355
3356                         body <- NULL
3357
3358                         response <- private$REST$http$exec("POST", url, headers, body,
3359                                                            queryArgs, private$numRetries)
3360                         resource <- private$REST$httpParser$parseJSONResponse(response)
3361
3362                         if(!is.null(resource$errors))
3363                                 stop(resource$errors)
3364
3365                         resource
3366                 },
3367
3368                 users.list = function(filters = NULL, where = NULL,
3369                         order = NULL, select = NULL, distinct = NULL,
3370                         limit = "100", offset = "0", count = "exact",
3371                         cluster_id = NULL, bypass_federation = NULL)
3372                 {
3373                         endPoint <- stringr::str_interp("users")
3374                         url <- paste0(private$host, endPoint)
3375                         headers <- list(Authorization = paste("Bearer", private$token),
3376                                         "Content-Type" = "application/json")
3377                         queryArgs <- list(filters = filters, where = where,
3378                                                           order = order, select = select, distinct = distinct,
3379                                                           limit = limit, offset = offset, count = count,
3380                                                           cluster_id = cluster_id, bypass_federation = bypass_federation)
3381
3382                         body <- NULL
3383
3384                         response <- private$REST$http$exec("GET", url, headers, body,
3385                                                            queryArgs, private$numRetries)
3386                         resource <- private$REST$httpParser$parseJSONResponse(response)
3387
3388                         if(!is.null(resource$errors))
3389                                 stop(resource$errors)
3390
3391                         resource
3392                 },
3393
3394                 repositories.get = function(uuid)
3395                 {
3396                         endPoint <- stringr::str_interp("repositories/${uuid}")
3397                         url <- paste0(private$host, endPoint)
3398                         headers <- list(Authorization = paste("Bearer", private$token),
3399                                         "Content-Type" = "application/json")
3400                         queryArgs <- NULL
3401
3402                         body <- NULL
3403
3404                         response <- private$REST$http$exec("GET", url, headers, body,
3405                                                            queryArgs, private$numRetries)
3406                         resource <- private$REST$httpParser$parseJSONResponse(response)
3407
3408                         if(!is.null(resource$errors))
3409                                 stop(resource$errors)
3410
3411                         resource
3412                 },
3413
3414                 repositories.create = function(repository,
3415                         ensure_unique_name = "false", cluster_id = NULL)
3416                 {
3417                         endPoint <- stringr::str_interp("repositories")
3418                         url <- paste0(private$host, endPoint)
3419                         headers <- list(Authorization = paste("Bearer", private$token),
3420                                         "Content-Type" = "application/json")
3421                         queryArgs <- list(ensure_unique_name = ensure_unique_name,
3422                                                           cluster_id = cluster_id)
3423
3424                         if(length(repository) > 0)
3425                                 body <- jsonlite::toJSON(list(repository = repository),
3426                                                          auto_unbox = TRUE)
3427                         else
3428                                 body <- NULL
3429
3430                         response <- private$REST$http$exec("POST", url, headers, body,
3431                                                            queryArgs, private$numRetries)
3432                         resource <- private$REST$httpParser$parseJSONResponse(response)
3433
3434                         if(!is.null(resource$errors))
3435                                 stop(resource$errors)
3436
3437                         resource
3438                 },
3439
3440                 repositories.update = function(repository, uuid)
3441                 {
3442                         endPoint <- stringr::str_interp("repositories/${uuid}")
3443                         url <- paste0(private$host, endPoint)
3444                         headers <- list(Authorization = paste("Bearer", private$token),
3445                                         "Content-Type" = "application/json")
3446                         queryArgs <- NULL
3447
3448                         if(length(repository) > 0)
3449                                 body <- jsonlite::toJSON(list(repository = repository),
3450                                                          auto_unbox = TRUE)
3451                         else
3452                                 body <- NULL
3453
3454                         response <- private$REST$http$exec("PUT", url, headers, body,
3455                                                            queryArgs, private$numRetries)
3456                         resource <- private$REST$httpParser$parseJSONResponse(response)
3457
3458                         if(!is.null(resource$errors))
3459                                 stop(resource$errors)
3460
3461                         resource
3462                 },
3463
3464                 repositories.delete = function(uuid)
3465                 {
3466                         endPoint <- stringr::str_interp("repositories/${uuid}")
3467                         url <- paste0(private$host, endPoint)
3468                         headers <- list(Authorization = paste("Bearer", private$token),
3469                                         "Content-Type" = "application/json")
3470                         queryArgs <- NULL
3471
3472                         body <- NULL
3473
3474                         response <- private$REST$http$exec("DELETE", url, headers, body,
3475                                                            queryArgs, private$numRetries)
3476                         resource <- private$REST$httpParser$parseJSONResponse(response)
3477
3478                         if(!is.null(resource$errors))
3479                                 stop(resource$errors)
3480
3481                         resource
3482                 },
3483
3484                 repositories.get_all_permissions = function()
3485                 {
3486                         endPoint <- stringr::str_interp("repositories/get_all_permissions")
3487                         url <- paste0(private$host, endPoint)
3488                         headers <- list(Authorization = paste("Bearer", private$token),
3489                                         "Content-Type" = "application/json")
3490                         queryArgs <- NULL
3491
3492                         body <- NULL
3493
3494                         response <- private$REST$http$exec("GET", url, headers, body,
3495                                                            queryArgs, private$numRetries)
3496                         resource <- private$REST$httpParser$parseJSONResponse(response)
3497
3498                         if(!is.null(resource$errors))
3499                                 stop(resource$errors)
3500
3501                         resource
3502                 },
3503
3504                 repositories.list = function(filters = NULL,
3505                         where = NULL, order = NULL, select = NULL,
3506                         distinct = NULL, limit = "100", offset = "0",
3507                         count = "exact", cluster_id = NULL, bypass_federation = NULL)
3508                 {
3509                         endPoint <- stringr::str_interp("repositories")
3510                         url <- paste0(private$host, endPoint)
3511                         headers <- list(Authorization = paste("Bearer", private$token),
3512                                         "Content-Type" = "application/json")
3513                         queryArgs <- list(filters = filters, where = where,
3514                                                           order = order, select = select, distinct = distinct,
3515                                                           limit = limit, offset = offset, count = count,
3516                                                           cluster_id = cluster_id, bypass_federation = bypass_federation)
3517
3518                         body <- NULL
3519
3520                         response <- private$REST$http$exec("GET", url, headers, body,
3521                                                            queryArgs, private$numRetries)
3522                         resource <- private$REST$httpParser$parseJSONResponse(response)
3523
3524                         if(!is.null(resource$errors))
3525                                 stop(resource$errors)
3526
3527                         resource
3528                 },
3529
3530                 virtual_machines.get = function(uuid)
3531                 {
3532                         endPoint <- stringr::str_interp("virtual_machines/${uuid}")
3533                         url <- paste0(private$host, endPoint)
3534                         headers <- list(Authorization = paste("Bearer", private$token),
3535                                         "Content-Type" = "application/json")
3536                         queryArgs <- NULL
3537
3538                         body <- NULL
3539
3540                         response <- private$REST$http$exec("GET", url, headers, body,
3541                                                            queryArgs, private$numRetries)
3542                         resource <- private$REST$httpParser$parseJSONResponse(response)
3543
3544                         if(!is.null(resource$errors))
3545                                 stop(resource$errors)
3546
3547                         resource
3548                 },
3549
3550                 virtual_machines.create = function(virtualmachine,
3551                         ensure_unique_name = "false", cluster_id = NULL)
3552                 {
3553                         endPoint <- stringr::str_interp("virtual_machines")
3554                         url <- paste0(private$host, endPoint)
3555                         headers <- list(Authorization = paste("Bearer", private$token),
3556                                         "Content-Type" = "application/json")
3557                         queryArgs <- list(ensure_unique_name = ensure_unique_name,
3558                                                           cluster_id = cluster_id)
3559
3560                         if(length(virtualmachine) > 0)
3561                                 body <- jsonlite::toJSON(list(virtualmachine = virtualmachine),
3562                                                          auto_unbox = TRUE)
3563                         else
3564                                 body <- NULL
3565
3566                         response <- private$REST$http$exec("POST", url, headers, body,
3567                                                            queryArgs, private$numRetries)
3568                         resource <- private$REST$httpParser$parseJSONResponse(response)
3569
3570                         if(!is.null(resource$errors))
3571                                 stop(resource$errors)
3572
3573                         resource
3574                 },
3575
3576                 virtual_machines.update = function(virtualmachine, uuid)
3577                 {
3578                         endPoint <- stringr::str_interp("virtual_machines/${uuid}")
3579                         url <- paste0(private$host, endPoint)
3580                         headers <- list(Authorization = paste("Bearer", private$token),
3581                                         "Content-Type" = "application/json")
3582                         queryArgs <- NULL
3583
3584                         if(length(virtualmachine) > 0)
3585                                 body <- jsonlite::toJSON(list(virtualmachine = virtualmachine),
3586                                                          auto_unbox = TRUE)
3587                         else
3588                                 body <- NULL
3589
3590                         response <- private$REST$http$exec("PUT", url, headers, body,
3591                                                            queryArgs, private$numRetries)
3592                         resource <- private$REST$httpParser$parseJSONResponse(response)
3593
3594                         if(!is.null(resource$errors))
3595                                 stop(resource$errors)
3596
3597                         resource
3598                 },
3599
3600                 virtual_machines.delete = function(uuid)
3601                 {
3602                         endPoint <- stringr::str_interp("virtual_machines/${uuid}")
3603                         url <- paste0(private$host, endPoint)
3604                         headers <- list(Authorization = paste("Bearer", private$token),
3605                                         "Content-Type" = "application/json")
3606                         queryArgs <- NULL
3607
3608                         body <- NULL
3609
3610                         response <- private$REST$http$exec("DELETE", url, headers, body,
3611                                                            queryArgs, private$numRetries)
3612                         resource <- private$REST$httpParser$parseJSONResponse(response)
3613
3614                         if(!is.null(resource$errors))
3615                                 stop(resource$errors)
3616
3617                         resource
3618                 },
3619
3620                 virtual_machines.logins = function(uuid)
3621                 {
3622                         endPoint <- stringr::str_interp("virtual_machines/${uuid}/logins")
3623                         url <- paste0(private$host, endPoint)
3624                         headers <- list(Authorization = paste("Bearer", private$token),
3625                                         "Content-Type" = "application/json")
3626                         queryArgs <- NULL
3627
3628                         body <- NULL
3629
3630                         response <- private$REST$http$exec("GET", url, headers, body,
3631                                                            queryArgs, private$numRetries)
3632                         resource <- private$REST$httpParser$parseJSONResponse(response)
3633
3634                         if(!is.null(resource$errors))
3635                                 stop(resource$errors)
3636
3637                         resource
3638                 },
3639
3640                 virtual_machines.get_all_logins = function()
3641                 {
3642                         endPoint <- stringr::str_interp("virtual_machines/get_all_logins")
3643                         url <- paste0(private$host, endPoint)
3644                         headers <- list(Authorization = paste("Bearer", private$token),
3645                                         "Content-Type" = "application/json")
3646                         queryArgs <- NULL
3647
3648                         body <- NULL
3649
3650                         response <- private$REST$http$exec("GET", url, headers, body,
3651                                                            queryArgs, private$numRetries)
3652                         resource <- private$REST$httpParser$parseJSONResponse(response)
3653
3654                         if(!is.null(resource$errors))
3655                                 stop(resource$errors)
3656
3657                         resource
3658                 },
3659
3660                 virtual_machines.list = function(filters = NULL,
3661                         where = NULL, order = NULL, select = NULL,
3662                         distinct = NULL, limit = "100", offset = "0",
3663                         count = "exact", cluster_id = NULL, bypass_federation = NULL)
3664                 {
3665                         endPoint <- stringr::str_interp("virtual_machines")
3666                         url <- paste0(private$host, endPoint)
3667                         headers <- list(Authorization = paste("Bearer", private$token),
3668                                         "Content-Type" = "application/json")
3669                         queryArgs <- list(filters = filters, where = where,
3670                                                           order = order, select = select, distinct = distinct,
3671                                                           limit = limit, offset = offset, count = count,
3672                                                           cluster_id = cluster_id, bypass_federation = bypass_federation)
3673
3674                         body <- NULL
3675
3676                         response <- private$REST$http$exec("GET", url, headers, body,
3677                                                            queryArgs, private$numRetries)
3678                         resource <- private$REST$httpParser$parseJSONResponse(response)
3679
3680                         if(!is.null(resource$errors))
3681                                 stop(resource$errors)
3682
3683                         resource
3684                 },
3685
3686                 workflows.get = function(uuid)
3687                 {
3688                         endPoint <- stringr::str_interp("workflows/${uuid}")
3689                         url <- paste0(private$host, endPoint)
3690                         headers <- list(Authorization = paste("Bearer", private$token),
3691                                         "Content-Type" = "application/json")
3692                         queryArgs <- NULL
3693
3694                         body <- NULL
3695
3696                         response <- private$REST$http$exec("GET", url, headers, body,
3697                                                            queryArgs, private$numRetries)
3698                         resource <- private$REST$httpParser$parseJSONResponse(response)
3699
3700                         if(!is.null(resource$errors))
3701                                 stop(resource$errors)
3702
3703                         resource
3704                 },
3705
3706                 workflows.create = function(workflow, ensure_unique_name = "false",
3707                         cluster_id = NULL)
3708                 {
3709                         endPoint <- stringr::str_interp("workflows")
3710                         url <- paste0(private$host, endPoint)
3711                         headers <- list(Authorization = paste("Bearer", private$token),
3712                                         "Content-Type" = "application/json")
3713                         queryArgs <- list(ensure_unique_name = ensure_unique_name,
3714                                                           cluster_id = cluster_id)
3715
3716                         if(length(workflow) > 0)
3717                                 body <- jsonlite::toJSON(list(workflow = workflow),
3718                                                          auto_unbox = TRUE)
3719                         else
3720                                 body <- NULL
3721
3722                         response <- private$REST$http$exec("POST", url, headers, body,
3723                                                            queryArgs, private$numRetries)
3724                         resource <- private$REST$httpParser$parseJSONResponse(response)
3725
3726                         if(!is.null(resource$errors))
3727                                 stop(resource$errors)
3728
3729                         resource
3730                 },
3731
3732                 workflows.update = function(workflow, uuid)
3733                 {
3734                         endPoint <- stringr::str_interp("workflows/${uuid}")
3735                         url <- paste0(private$host, endPoint)
3736                         headers <- list(Authorization = paste("Bearer", private$token),
3737                                         "Content-Type" = "application/json")
3738                         queryArgs <- NULL
3739
3740                         if(length(workflow) > 0)
3741                                 body <- jsonlite::toJSON(list(workflow = workflow),
3742                                                          auto_unbox = TRUE)
3743                         else
3744                                 body <- NULL
3745
3746                         response <- private$REST$http$exec("PUT", url, headers, body,
3747                                                            queryArgs, private$numRetries)
3748                         resource <- private$REST$httpParser$parseJSONResponse(response)
3749
3750                         if(!is.null(resource$errors))
3751                                 stop(resource$errors)
3752
3753                         resource
3754                 },
3755
3756                 workflows.delete = function(uuid)
3757                 {
3758                         endPoint <- stringr::str_interp("workflows/${uuid}")
3759                         url <- paste0(private$host, endPoint)
3760                         headers <- list(Authorization = paste("Bearer", private$token),
3761                                         "Content-Type" = "application/json")
3762                         queryArgs <- NULL
3763
3764                         body <- NULL
3765
3766                         response <- private$REST$http$exec("DELETE", url, headers, body,
3767                                                            queryArgs, private$numRetries)
3768                         resource <- private$REST$httpParser$parseJSONResponse(response)
3769
3770                         if(!is.null(resource$errors))
3771                                 stop(resource$errors)
3772
3773                         resource
3774                 },
3775
3776                 workflows.list = function(filters = NULL,
3777                         where = NULL, order = NULL, select = NULL,
3778                         distinct = NULL, limit = "100", offset = "0",
3779                         count = "exact", cluster_id = NULL, bypass_federation = NULL)
3780                 {
3781                         endPoint <- stringr::str_interp("workflows")
3782                         url <- paste0(private$host, endPoint)
3783                         headers <- list(Authorization = paste("Bearer", private$token),
3784                                         "Content-Type" = "application/json")
3785                         queryArgs <- list(filters = filters, where = where,
3786                                                           order = order, select = select, distinct = distinct,
3787                                                           limit = limit, offset = offset, count = count,
3788                                                           cluster_id = cluster_id, bypass_federation = bypass_federation)
3789
3790                         body <- NULL
3791
3792                         response <- private$REST$http$exec("GET", url, headers, body,
3793                                                            queryArgs, private$numRetries)
3794                         resource <- private$REST$httpParser$parseJSONResponse(response)
3795
3796                         if(!is.null(resource$errors))
3797                                 stop(resource$errors)
3798
3799                         resource
3800                 },
3801
3802                 user_agreements.get = function(uuid)
3803                 {
3804                         endPoint <- stringr::str_interp("user_agreements/${uuid}")
3805                         url <- paste0(private$host, endPoint)
3806                         headers <- list(Authorization = paste("Bearer", private$token),
3807                                         "Content-Type" = "application/json")
3808                         queryArgs <- NULL
3809
3810                         body <- NULL
3811
3812                         response <- private$REST$http$exec("GET", url, headers, body,
3813                                                            queryArgs, private$numRetries)
3814                         resource <- private$REST$httpParser$parseJSONResponse(response)
3815
3816                         if(!is.null(resource$errors))
3817                                 stop(resource$errors)
3818
3819                         resource
3820                 },
3821
3822                 user_agreements.create = function(useragreement,
3823                         ensure_unique_name = "false", cluster_id = NULL)
3824                 {
3825                         endPoint <- stringr::str_interp("user_agreements")
3826                         url <- paste0(private$host, endPoint)
3827                         headers <- list(Authorization = paste("Bearer", private$token),
3828                                         "Content-Type" = "application/json")
3829                         queryArgs <- list(ensure_unique_name = ensure_unique_name,
3830                                                           cluster_id = cluster_id)
3831
3832                         if(length(useragreement) > 0)
3833                                 body <- jsonlite::toJSON(list(useragreement = useragreement),
3834                                                          auto_unbox = TRUE)
3835                         else
3836                                 body <- NULL
3837
3838                         response <- private$REST$http$exec("POST", url, headers, body,
3839                                                            queryArgs, private$numRetries)
3840                         resource <- private$REST$httpParser$parseJSONResponse(response)
3841
3842                         if(!is.null(resource$errors))
3843                                 stop(resource$errors)
3844
3845                         resource
3846                 },
3847
3848                 user_agreements.update = function(useragreement, uuid)
3849                 {
3850                         endPoint <- stringr::str_interp("user_agreements/${uuid}")
3851                         url <- paste0(private$host, endPoint)
3852                         headers <- list(Authorization = paste("Bearer", private$token),
3853                                         "Content-Type" = "application/json")
3854                         queryArgs <- NULL
3855
3856                         if(length(useragreement) > 0)
3857                                 body <- jsonlite::toJSON(list(useragreement = useragreement),
3858                                                          auto_unbox = TRUE)
3859                         else
3860                                 body <- NULL
3861
3862                         response <- private$REST$http$exec("PUT", url, headers, body,
3863                                                            queryArgs, private$numRetries)
3864                         resource <- private$REST$httpParser$parseJSONResponse(response)
3865
3866                         if(!is.null(resource$errors))
3867                                 stop(resource$errors)
3868
3869                         resource
3870                 },
3871
3872                 user_agreements.delete = function(uuid)
3873                 {
3874                         endPoint <- stringr::str_interp("user_agreements/${uuid}")
3875                         url <- paste0(private$host, endPoint)
3876                         headers <- list(Authorization = paste("Bearer", private$token),
3877                                         "Content-Type" = "application/json")
3878                         queryArgs <- NULL
3879
3880                         body <- NULL
3881
3882                         response <- private$REST$http$exec("DELETE", url, headers, body,
3883                                                            queryArgs, private$numRetries)
3884                         resource <- private$REST$httpParser$parseJSONResponse(response)
3885
3886                         if(!is.null(resource$errors))
3887                                 stop(resource$errors)
3888
3889                         resource
3890                 },
3891
3892                 user_agreements.signatures = function()
3893                 {
3894                         endPoint <- stringr::str_interp("user_agreements/signatures")
3895                         url <- paste0(private$host, endPoint)
3896                         headers <- list(Authorization = paste("Bearer", private$token),
3897                                         "Content-Type" = "application/json")
3898                         queryArgs <- NULL
3899
3900                         body <- NULL
3901
3902                         response <- private$REST$http$exec("GET", url, headers, body,
3903                                                            queryArgs, private$numRetries)
3904                         resource <- private$REST$httpParser$parseJSONResponse(response)
3905
3906                         if(!is.null(resource$errors))
3907                                 stop(resource$errors)
3908
3909                         resource
3910                 },
3911
3912                 user_agreements.sign = function()
3913                 {
3914                         endPoint <- stringr::str_interp("user_agreements/sign")
3915                         url <- paste0(private$host, endPoint)
3916                         headers <- list(Authorization = paste("Bearer", private$token),
3917                                         "Content-Type" = "application/json")
3918                         queryArgs <- NULL
3919
3920                         body <- NULL
3921
3922                         response <- private$REST$http$exec("POST", url, headers, body,
3923                                                            queryArgs, private$numRetries)
3924                         resource <- private$REST$httpParser$parseJSONResponse(response)
3925
3926                         if(!is.null(resource$errors))
3927                                 stop(resource$errors)
3928
3929                         resource
3930                 },
3931
3932                 user_agreements.list = function(filters = NULL,
3933                         where = NULL, order = NULL, select = NULL,
3934                         distinct = NULL, limit = "100", offset = "0",
3935                         count = "exact", cluster_id = NULL, bypass_federation = NULL)
3936                 {
3937                         endPoint <- stringr::str_interp("user_agreements")
3938                         url <- paste0(private$host, endPoint)
3939                         headers <- list(Authorization = paste("Bearer", private$token),
3940                                         "Content-Type" = "application/json")
3941                         queryArgs <- list(filters = filters, where = where,
3942                                                           order = order, select = select, distinct = distinct,
3943                                                           limit = limit, offset = offset, count = count,
3944                                                           cluster_id = cluster_id, bypass_federation = bypass_federation)
3945
3946                         body <- NULL
3947
3948                         response <- private$REST$http$exec("GET", url, headers, body,
3949                                                            queryArgs, private$numRetries)
3950                         resource <- private$REST$httpParser$parseJSONResponse(response)
3951
3952                         if(!is.null(resource$errors))
3953                                 stop(resource$errors)
3954
3955                         resource
3956                 },
3957
3958                 user_agreements.new = function()
3959                 {
3960                         endPoint <- stringr::str_interp("user_agreements/new")
3961                         url <- paste0(private$host, endPoint)
3962                         headers <- list(Authorization = paste("Bearer", private$token),
3963                                         "Content-Type" = "application/json")
3964                         queryArgs <- NULL
3965
3966                         body <- NULL
3967
3968                         response <- private$REST$http$exec("GET", url, headers, body,
3969                                                            queryArgs, private$numRetries)
3970                         resource <- private$REST$httpParser$parseJSONResponse(response)
3971
3972                         if(!is.null(resource$errors))
3973                                 stop(resource$errors)
3974
3975                         resource
3976                 },
3977
3978                 configs.get = function()
3979                 {
3980                         endPoint <- stringr::str_interp("config")
3981                         url <- paste0(private$host, endPoint)
3982                         headers <- list(Authorization = paste("Bearer", private$token),
3983                                         "Content-Type" = "application/json")
3984                         queryArgs <- NULL
3985
3986                         body <- NULL
3987
3988                         response <- private$REST$http$exec("GET", url, headers, body,
3989                                                            queryArgs, private$numRetries)
3990                         resource <- private$REST$httpParser$parseJSONResponse(response)
3991
3992                         if(!is.null(resource$errors))
3993                                 stop(resource$errors)
3994
3995                         resource
3996                 },
3997
3998                 getHostName = function() private$host,
3999                 getToken = function() private$token,
4000                 setRESTService = function(newREST) private$REST <- newREST,
4001                 getRESTService = function() private$REST
4002         ),
4003
4004         private = list(
4005
4006                 token = NULL,
4007                 host = NULL,
4008                 REST = NULL,
4009                 numRetries = NULL
4010         ),
4011
4012         cloneable = FALSE
4013 )