1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: Apache-2.0
7 #' api_clients.get is a method defined in Arvados class.
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
17 #' api_clients.create is a method defined in Arvados class.
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
30 #' api_clients.update is a method defined in Arvados class.
32 #' @usage arv$api_clients.update(apiclient,
34 #' @param apiClient ApiClient object.
35 #' @param uuid The UUID of the ApiClient in question.
36 #' @return ApiClient object.
37 #' @name api_clients.update
42 #' api_clients.delete is a method defined in Arvados class.
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
52 #' api_clients.list is a method defined in Arvados class.
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)
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
72 #' api_client_authorizations.get
74 #' api_client_authorizations.get is a method defined in Arvados class.
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
82 #' api_client_authorizations.create
84 #' api_client_authorizations.create is a method defined in Arvados class.
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
95 #' api_client_authorizations.update
97 #' api_client_authorizations.update is a method defined in Arvados class.
99 #' @usage arv$api_client_authorizations.update(apiclientauthorization,
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
107 #' api_client_authorizations.delete
109 #' api_client_authorizations.delete is a method defined in Arvados class.
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
117 #' api_client_authorizations.create_system_auth
119 #' api_client_authorizations.create_system_auth is a method defined in Arvados class.
121 #' @usage arv$api_client_authorizations.create_system_auth(api_client_id = NULL,
123 #' @param api_client_id
125 #' @return ApiClientAuthorization object.
126 #' @name api_client_authorizations.create_system_auth
129 #' api_client_authorizations.current
131 #' api_client_authorizations.current is a method defined in Arvados class.
133 #' @usage arv$api_client_authorizations.current(NULL)
134 #' @return ApiClientAuthorization object.
135 #' @name api_client_authorizations.current
138 #' api_client_authorizations.list
140 #' api_client_authorizations.list is a method defined in Arvados class.
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)
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
160 #' authorized_keys.get
162 #' authorized_keys.get is a method defined in Arvados class.
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
170 #' authorized_keys.create
172 #' authorized_keys.create is a method defined in Arvados class.
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
183 #' authorized_keys.update
185 #' authorized_keys.update is a method defined in Arvados class.
187 #' @usage arv$authorized_keys.update(authorizedkey,
189 #' @param authorizedKey AuthorizedKey object.
190 #' @param uuid The UUID of the AuthorizedKey in question.
191 #' @return AuthorizedKey object.
192 #' @name authorized_keys.update
195 #' authorized_keys.delete
197 #' authorized_keys.delete is a method defined in Arvados class.
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
205 #' authorized_keys.list
207 #' authorized_keys.list is a method defined in Arvados class.
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)
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
229 #' collections.get is a method defined in Arvados class.
231 #' @usage arv$collections.get(uuid)
232 #' @param uuid The UUID of the Collection in question.
233 #' @return Collection object.
234 #' @name collections.get
237 #' collections.create
239 #' collections.create is a method defined in Arvados class.
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
250 #' collections.update
252 #' collections.update is a method defined in Arvados class.
254 #' @usage arv$collections.update(collection,
256 #' @param collection Collection object.
257 #' @param uuid The UUID of the Collection in question.
258 #' @return Collection object.
259 #' @name collections.update
262 #' collections.delete
264 #' collections.delete is a method defined in Arvados class.
266 #' @usage arv$collections.delete(uuid)
267 #' @param uuid The UUID of the Collection in question.
268 #' @return Collection object.
269 #' @name collections.delete
272 #' collections.provenance
274 #' collections.provenance is a method defined in Arvados class.
276 #' @usage arv$collections.provenance(uuid)
278 #' @return Collection object.
279 #' @name collections.provenance
282 #' collections.used_by
284 #' collections.used_by is a method defined in Arvados class.
286 #' @usage arv$collections.used_by(uuid)
288 #' @return Collection object.
289 #' @name collections.used_by
294 #' collections.trash is a method defined in Arvados class.
296 #' @usage arv$collections.trash(uuid)
298 #' @return Collection object.
299 #' @name collections.trash
302 #' collections.untrash
304 #' collections.untrash is a method defined in Arvados class.
306 #' @usage arv$collections.untrash(uuid)
308 #' @return Collection object.
309 #' @name collections.untrash
314 #' collections.list is a method defined in Arvados class.
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)
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
339 #' containers.get is a method defined in Arvados class.
341 #' @usage arv$containers.get(uuid)
342 #' @param uuid The UUID of the Container in question.
343 #' @return Container object.
344 #' @name containers.get
349 #' containers.create is a method defined in Arvados class.
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
362 #' containers.update is a method defined in Arvados class.
364 #' @usage arv$containers.update(container,
366 #' @param container Container object.
367 #' @param uuid The UUID of the Container in question.
368 #' @return Container object.
369 #' @name containers.update
374 #' containers.delete is a method defined in Arvados class.
376 #' @usage arv$containers.delete(uuid)
377 #' @param uuid The UUID of the Container in question.
378 #' @return Container object.
379 #' @name containers.delete
384 #' containers.auth is a method defined in Arvados class.
386 #' @usage arv$containers.auth(uuid)
388 #' @return Container object.
389 #' @name containers.auth
394 #' containers.lock is a method defined in Arvados class.
396 #' @usage arv$containers.lock(uuid)
398 #' @return Container object.
399 #' @name containers.lock
404 #' containers.unlock is a method defined in Arvados class.
406 #' @usage arv$containers.unlock(uuid)
408 #' @return Container object.
409 #' @name containers.unlock
412 #' containers.secret_mounts
414 #' containers.secret_mounts is a method defined in Arvados class.
416 #' @usage arv$containers.secret_mounts(uuid)
418 #' @return Container object.
419 #' @name containers.secret_mounts
422 #' containers.current
424 #' containers.current is a method defined in Arvados class.
426 #' @usage arv$containers.current(NULL)
427 #' @return Container object.
428 #' @name containers.current
433 #' containers.list is a method defined in Arvados class.
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)
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
453 #' container_requests.get
455 #' container_requests.get is a method defined in Arvados class.
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
463 #' container_requests.create
465 #' container_requests.create is a method defined in Arvados class.
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
476 #' container_requests.update
478 #' container_requests.update is a method defined in Arvados class.
480 #' @usage arv$container_requests.update(containerrequest,
482 #' @param containerRequest ContainerRequest object.
483 #' @param uuid The UUID of the ContainerRequest in question.
484 #' @return ContainerRequest object.
485 #' @name container_requests.update
488 #' container_requests.delete
490 #' container_requests.delete is a method defined in Arvados class.
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
498 #' container_requests.list
500 #' container_requests.list is a method defined in Arvados class.
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)
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
524 #' groups.get is a method defined in Arvados class.
526 #' @usage arv$groups.get(uuid)
527 #' @param uuid The UUID of the Group in question.
528 #' @return Group object.
534 #' groups.create is a method defined in Arvados class.
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
548 #' groups.update is a method defined in Arvados class.
550 #' @usage arv$groups.update(group, uuid,
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
561 #' groups.delete is a method defined in Arvados class.
563 #' @usage arv$groups.delete(uuid)
564 #' @param uuid The UUID of the Group in question.
565 #' @return Group object.
566 #' @name groups.delete
571 #' groups.contents is a method defined in Arvados class.
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,
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.
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
598 #' groups.shared is a method defined in Arvados class.
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)
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.
617 #' @return Group object.
618 #' @name groups.shared
623 #' groups.trash is a method defined in Arvados class.
625 #' @usage arv$groups.trash(uuid)
627 #' @return Group object.
628 #' @name groups.trash
633 #' groups.untrash is a method defined in Arvados class.
635 #' @usage arv$groups.untrash(uuid)
637 #' @return Group object.
638 #' @name groups.untrash
643 #' groups.list is a method defined in Arvados class.
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)
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.
667 #' keep_services.get is a method defined in Arvados class.
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
675 #' keep_services.create
677 #' keep_services.create is a method defined in Arvados class.
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
688 #' keep_services.update
690 #' keep_services.update is a method defined in Arvados class.
692 #' @usage arv$keep_services.update(keepservice,
694 #' @param keepService KeepService object.
695 #' @param uuid The UUID of the KeepService in question.
696 #' @return KeepService object.
697 #' @name keep_services.update
700 #' keep_services.delete
702 #' keep_services.delete is a method defined in Arvados class.
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
710 #' keep_services.accessible
712 #' keep_services.accessible is a method defined in Arvados class.
714 #' @usage arv$keep_services.accessible(NULL)
715 #' @return KeepService object.
716 #' @name keep_services.accessible
719 #' keep_services.list
721 #' keep_services.list is a method defined in Arvados class.
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)
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
743 #' links.get is a method defined in Arvados class.
745 #' @usage arv$links.get(uuid)
746 #' @param uuid The UUID of the Link in question.
747 #' @return Link object.
753 #' links.create is a method defined in Arvados class.
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
766 #' links.update is a method defined in Arvados class.
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
777 #' links.delete is a method defined in Arvados class.
779 #' @usage arv$links.delete(uuid)
780 #' @param uuid The UUID of the Link in question.
781 #' @return Link object.
782 #' @name links.delete
787 #' links.list is a method defined in Arvados class.
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)
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.
807 #' links.get_permissions
809 #' links.get_permissions is a method defined in Arvados class.
811 #' @usage arv$links.get_permissions(uuid)
813 #' @return Link object.
814 #' @name links.get_permissions
819 #' logs.get is a method defined in Arvados class.
821 #' @usage arv$logs.get(uuid)
822 #' @param uuid The UUID of the Log in question.
823 #' @return Log object.
829 #' logs.create is a method defined in Arvados class.
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.
842 #' logs.update is a method defined in Arvados class.
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.
853 #' logs.delete is a method defined in Arvados class.
855 #' @usage arv$logs.delete(uuid)
856 #' @param uuid The UUID of the Log in question.
857 #' @return Log object.
863 #' logs.list is a method defined in Arvados class.
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)
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.
885 #' users.get is a method defined in Arvados class.
887 #' @usage arv$users.get(uuid)
888 #' @param uuid The UUID of the User in question.
889 #' @return User object.
895 #' users.create is a method defined in Arvados class.
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
908 #' users.update is a method defined in Arvados class.
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
920 #' users.delete is a method defined in Arvados class.
922 #' @usage arv$users.delete(uuid)
923 #' @param uuid The UUID of the User in question.
924 #' @return User object.
925 #' @name users.delete
930 #' users.current is a method defined in Arvados class.
932 #' @usage arv$users.current(NULL)
933 #' @return User object.
934 #' @name users.current
939 #' users.system is a method defined in Arvados class.
941 #' @usage arv$users.system(NULL)
942 #' @return User object.
943 #' @name users.system
948 #' users.activate is a method defined in Arvados class.
950 #' @usage arv$users.activate(uuid)
952 #' @return User object.
953 #' @name users.activate
958 #' users.setup is a method defined in Arvados class.
960 #' @usage arv$users.setup(uuid = NULL, user = NULL,
961 #' repo_name = NULL, vm_uuid = NULL, send_notification_email = "false")
966 #' @param send_notification_email
967 #' @return User object.
973 #' users.unsetup is a method defined in Arvados class.
975 #' @usage arv$users.unsetup(uuid)
977 #' @return User object.
978 #' @name users.unsetup
983 #' users.merge is a method defined in Arvados class.
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.
999 #' users.list is a method defined in Arvados class.
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)
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.
1021 #' repositories.get is a method defined in Arvados class.
1023 #' @usage arv$repositories.get(uuid)
1024 #' @param uuid The UUID of the Repository in question.
1025 #' @return Repository object.
1026 #' @name repositories.get
1029 #' repositories.create
1031 #' repositories.create is a method defined in Arvados class.
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
1042 #' repositories.update
1044 #' repositories.update is a method defined in Arvados class.
1046 #' @usage arv$repositories.update(repository,
1048 #' @param repository Repository object.
1049 #' @param uuid The UUID of the Repository in question.
1050 #' @return Repository object.
1051 #' @name repositories.update
1054 #' repositories.delete
1056 #' repositories.delete is a method defined in Arvados class.
1058 #' @usage arv$repositories.delete(uuid)
1059 #' @param uuid The UUID of the Repository in question.
1060 #' @return Repository object.
1061 #' @name repositories.delete
1064 #' repositories.get_all_permissions
1066 #' repositories.get_all_permissions is a method defined in Arvados class.
1068 #' @usage arv$repositories.get_all_permissions(NULL)
1069 #' @return Repository object.
1070 #' @name repositories.get_all_permissions
1073 #' repositories.list
1075 #' repositories.list is a method defined in Arvados class.
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)
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
1095 #' virtual_machines.get
1097 #' virtual_machines.get is a method defined in Arvados class.
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
1105 #' virtual_machines.create
1107 #' virtual_machines.create is a method defined in Arvados class.
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
1118 #' virtual_machines.update
1120 #' virtual_machines.update is a method defined in Arvados class.
1122 #' @usage arv$virtual_machines.update(virtualmachine,
1124 #' @param virtualMachine VirtualMachine object.
1125 #' @param uuid The UUID of the VirtualMachine in question.
1126 #' @return VirtualMachine object.
1127 #' @name virtual_machines.update
1130 #' virtual_machines.delete
1132 #' virtual_machines.delete is a method defined in Arvados class.
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
1140 #' virtual_machines.logins
1142 #' virtual_machines.logins is a method defined in Arvados class.
1144 #' @usage arv$virtual_machines.logins(uuid)
1146 #' @return VirtualMachine object.
1147 #' @name virtual_machines.logins
1150 #' virtual_machines.get_all_logins
1152 #' virtual_machines.get_all_logins is a method defined in Arvados class.
1154 #' @usage arv$virtual_machines.get_all_logins(NULL)
1155 #' @return VirtualMachine object.
1156 #' @name virtual_machines.get_all_logins
1159 #' virtual_machines.list
1161 #' virtual_machines.list is a method defined in Arvados class.
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)
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
1183 #' workflows.get is a method defined in Arvados class.
1185 #' @usage arv$workflows.get(uuid)
1186 #' @param uuid The UUID of the Workflow in question.
1187 #' @return Workflow object.
1188 #' @name workflows.get
1193 #' workflows.create is a method defined in Arvados class.
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
1206 #' workflows.update is a method defined in Arvados class.
1208 #' @usage arv$workflows.update(workflow,
1210 #' @param workflow Workflow object.
1211 #' @param uuid The UUID of the Workflow in question.
1212 #' @return Workflow object.
1213 #' @name workflows.update
1218 #' workflows.delete is a method defined in Arvados class.
1220 #' @usage arv$workflows.delete(uuid)
1221 #' @param uuid The UUID of the Workflow in question.
1222 #' @return Workflow object.
1223 #' @name workflows.delete
1228 #' workflows.list is a method defined in Arvados class.
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)
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
1248 #' user_agreements.get
1250 #' user_agreements.get is a method defined in Arvados class.
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
1258 #' user_agreements.create
1260 #' user_agreements.create is a method defined in Arvados class.
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
1271 #' user_agreements.update
1273 #' user_agreements.update is a method defined in Arvados class.
1275 #' @usage arv$user_agreements.update(useragreement,
1277 #' @param userAgreement UserAgreement object.
1278 #' @param uuid The UUID of the UserAgreement in question.
1279 #' @return UserAgreement object.
1280 #' @name user_agreements.update
1283 #' user_agreements.delete
1285 #' user_agreements.delete is a method defined in Arvados class.
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
1293 #' user_agreements.signatures
1295 #' user_agreements.signatures is a method defined in Arvados class.
1297 #' @usage arv$user_agreements.signatures(NULL)
1298 #' @return UserAgreement object.
1299 #' @name user_agreements.signatures
1302 #' user_agreements.sign
1304 #' user_agreements.sign is a method defined in Arvados class.
1306 #' @usage arv$user_agreements.sign(NULL)
1307 #' @return UserAgreement object.
1308 #' @name user_agreements.sign
1311 #' user_agreements.list
1313 #' user_agreements.list is a method defined in Arvados class.
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)
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
1333 #' user_agreements.new
1335 #' user_agreements.new is a method defined in Arvados class.
1337 #' @usage arv$user_agreements.new(NULL)
1338 #' @return UserAgreement object.
1339 #' @name user_agreements.new
1344 #' configs.get is a method defined in Arvados class.
1346 #' @usage arv$configs.get(NULL)
1348 #' @name configs.get
1353 #' projects.get is equivalent to groups.get method.
1355 #' @usage arv$projects.get(uuid)
1356 #' @param uuid The UUID of the Group in question.
1357 #' @return Group object.
1358 #' @name projects.get
1363 #' projects.create wrapps groups.create method by setting group_class attribute to "project".
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
1374 #' projects.update wrapps groups.update method by setting group_class attribute to "project".
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
1385 #' projects.delete is equivalent to groups.delete method.
1387 #' @usage arv$project.delete(uuid)
1388 #' @param uuid The UUID of the Group in question.
1389 #' @return Group object.
1390 #' @name projects.delete
1395 #' projects.list wrapps groups.list method by setting group_class attribute to "project".
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)
1408 #' @param include_trash Include items whose is_trashed attribute is true.
1410 #' @param recursive Include contents from child groups recursively.
1411 #' @return Group object.
1412 #' @name projects.list
1417 #' Arvados class gives users ability to access Arvados REST API.
1420 #' \preformatted{arv = Arvados$new(authToken = NULL, hostName = NULL, numRetries = 0)}
1422 #' @section Arguments:
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.}
1429 #' @section Methods:
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}}}
1546 #' arv <- Arvados$new("your Arvados token", "example.arvadosapi.com")
1548 #' collection <- arv$collections.get("uuid")
1550 #' collectionList <- arv$collections.list(list(list("name", "like", "Test%")))
1551 #' collectionList <- listAll(arv$collections.list, list(list("name", "like", "Test%")))
1553 #' deletedCollection <- arv$collections.delete("uuid")
1555 #' updatedCollection <- arv$collections.update(list(name = "New name", description = "New description"),
1558 #' createdCollection <- arv$collections.create(list(name = "Example",
1559 #' description = "This is a test collection"))
1564 Arvados <- R6::R6Class(
1570 initialize = function(authToken = NULL, hostName = NULL, numRetries = 0)
1572 if(!is.null(hostName))
1573 Sys.setenv(ARVADOS_API_HOST = hostName)
1575 if(!is.null(authToken))
1576 Sys.setenv(ARVADOS_API_TOKEN = authToken)
1578 hostName <- Sys.getenv("ARVADOS_API_HOST")
1579 token <- Sys.getenv("ARVADOS_API_TOKEN")
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."))
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(),
1595 projects.get = function(uuid)
1597 self$groups.get(uuid)
1600 projects.create = function(group, ensure_unique_name = "false")
1602 group <- c("group_class" = "project", group)
1603 self$groups.create(group, ensure_unique_name)
1606 projects.update = function(group, uuid)
1608 group <- c("group_class" = "project", group)
1609 self$groups.update(group, uuid)
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)
1617 filters[[length(filters) + 1]] <- list("group_class", "=", "project")
1618 self$groups.list(filters, where, order, select, distinct,
1619 limit, offset, count, include_trash)
1622 projects.delete = function(uuid)
1624 self$groups.delete(uuid)
1627 api_clients.get = function(uuid)
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")
1637 response <- private$REST$http$exec("GET", url, headers, body,
1638 queryArgs, private$numRetries)
1639 resource <- private$REST$httpParser$parseJSONResponse(response)
1641 if(!is.null(resource$errors))
1642 stop(resource$errors)
1647 api_clients.create = function(apiclient,
1648 ensure_unique_name = "false", cluster_id = NULL)
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)
1657 if(length(apiclient) > 0)
1658 body <- jsonlite::toJSON(list(apiclient = apiclient),
1663 response <- private$REST$http$exec("POST", url, headers, body,
1664 queryArgs, private$numRetries)
1665 resource <- private$REST$httpParser$parseJSONResponse(response)
1667 if(!is.null(resource$errors))
1668 stop(resource$errors)
1673 api_clients.update = function(apiclient, uuid)
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")
1681 if(length(apiclient) > 0)
1682 body <- jsonlite::toJSON(list(apiclient = apiclient),
1687 response <- private$REST$http$exec("PUT", url, headers, body,
1688 queryArgs, private$numRetries)
1689 resource <- private$REST$httpParser$parseJSONResponse(response)
1691 if(!is.null(resource$errors))
1692 stop(resource$errors)
1697 api_clients.delete = function(uuid)
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")
1707 response <- private$REST$http$exec("DELETE", url, headers, body,
1708 queryArgs, private$numRetries)
1709 resource <- private$REST$httpParser$parseJSONResponse(response)
1711 if(!is.null(resource$errors))
1712 stop(resource$errors)
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)
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)
1733 response <- private$REST$http$exec("GET", url, headers, body,
1734 queryArgs, private$numRetries)
1735 resource <- private$REST$httpParser$parseJSONResponse(response)
1737 if(!is.null(resource$errors))
1738 stop(resource$errors)
1743 api_client_authorizations.get = function(uuid)
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")
1753 response <- private$REST$http$exec("GET", url, headers, body,
1754 queryArgs, private$numRetries)
1755 resource <- private$REST$httpParser$parseJSONResponse(response)
1757 if(!is.null(resource$errors))
1758 stop(resource$errors)
1763 api_client_authorizations.create = function(apiclientauthorization,
1764 ensure_unique_name = "false", cluster_id = NULL)
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)
1773 if(length(apiclientauthorization) > 0)
1774 body <- jsonlite::toJSON(list(apiclientauthorization = apiclientauthorization),
1779 response <- private$REST$http$exec("POST", url, headers, body,
1780 queryArgs, private$numRetries)
1781 resource <- private$REST$httpParser$parseJSONResponse(response)
1783 if(!is.null(resource$errors))
1784 stop(resource$errors)
1789 api_client_authorizations.update = function(apiclientauthorization, uuid)
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")
1797 if(length(apiclientauthorization) > 0)
1798 body <- jsonlite::toJSON(list(apiclientauthorization = apiclientauthorization),
1803 response <- private$REST$http$exec("PUT", url, headers, body,
1804 queryArgs, private$numRetries)
1805 resource <- private$REST$httpParser$parseJSONResponse(response)
1807 if(!is.null(resource$errors))
1808 stop(resource$errors)
1813 api_client_authorizations.delete = function(uuid)
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")
1823 response <- private$REST$http$exec("DELETE", url, headers, body,
1824 queryArgs, private$numRetries)
1825 resource <- private$REST$httpParser$parseJSONResponse(response)
1827 if(!is.null(resource$errors))
1828 stop(resource$errors)
1833 api_client_authorizations.create_system_auth = function(api_client_id = NULL, scopes = NULL)
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,
1844 response <- private$REST$http$exec("POST", url, headers, body,
1845 queryArgs, private$numRetries)
1846 resource <- private$REST$httpParser$parseJSONResponse(response)
1848 if(!is.null(resource$errors))
1849 stop(resource$errors)
1854 api_client_authorizations.current = function()
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")
1864 response <- private$REST$http$exec("GET", url, headers, body,
1865 queryArgs, private$numRetries)
1866 resource <- private$REST$httpParser$parseJSONResponse(response)
1868 if(!is.null(resource$errors))
1869 stop(resource$errors)
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)
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)
1890 response <- private$REST$http$exec("GET", url, headers, body,
1891 queryArgs, private$numRetries)
1892 resource <- private$REST$httpParser$parseJSONResponse(response)
1894 if(!is.null(resource$errors))
1895 stop(resource$errors)
1900 authorized_keys.get = function(uuid)
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")
1910 response <- private$REST$http$exec("GET", url, headers, body,
1911 queryArgs, private$numRetries)
1912 resource <- private$REST$httpParser$parseJSONResponse(response)
1914 if(!is.null(resource$errors))
1915 stop(resource$errors)
1920 authorized_keys.create = function(authorizedkey,
1921 ensure_unique_name = "false", cluster_id = NULL)
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)
1930 if(length(authorizedkey) > 0)
1931 body <- jsonlite::toJSON(list(authorizedkey = authorizedkey),
1936 response <- private$REST$http$exec("POST", url, headers, body,
1937 queryArgs, private$numRetries)
1938 resource <- private$REST$httpParser$parseJSONResponse(response)
1940 if(!is.null(resource$errors))
1941 stop(resource$errors)
1946 authorized_keys.update = function(authorizedkey, uuid)
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")
1954 if(length(authorizedkey) > 0)
1955 body <- jsonlite::toJSON(list(authorizedkey = authorizedkey),
1960 response <- private$REST$http$exec("PUT", url, headers, body,
1961 queryArgs, private$numRetries)
1962 resource <- private$REST$httpParser$parseJSONResponse(response)
1964 if(!is.null(resource$errors))
1965 stop(resource$errors)
1970 authorized_keys.delete = function(uuid)
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")
1980 response <- private$REST$http$exec("DELETE", url, headers, body,
1981 queryArgs, private$numRetries)
1982 resource <- private$REST$httpParser$parseJSONResponse(response)
1984 if(!is.null(resource$errors))
1985 stop(resource$errors)
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)
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)
2006 response <- private$REST$http$exec("GET", url, headers, body,
2007 queryArgs, private$numRetries)
2008 resource <- private$REST$httpParser$parseJSONResponse(response)
2010 if(!is.null(resource$errors))
2011 stop(resource$errors)
2016 collections.get = function(uuid)
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")
2026 response <- private$REST$http$exec("GET", url, headers, body,
2027 queryArgs, private$numRetries)
2028 resource <- private$REST$httpParser$parseJSONResponse(response)
2030 if(!is.null(resource$errors))
2031 stop(resource$errors)
2036 collections.create = function(collection,
2037 ensure_unique_name = "false", cluster_id = NULL)
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)
2046 if(length(collection) > 0)
2047 body <- jsonlite::toJSON(list(collection = collection),
2052 response <- private$REST$http$exec("POST", url, headers, body,
2053 queryArgs, private$numRetries)
2054 resource <- private$REST$httpParser$parseJSONResponse(response)
2056 if(!is.null(resource$errors))
2057 stop(resource$errors)
2062 collections.update = function(collection, uuid)
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")
2070 if(length(collection) > 0)
2071 body <- jsonlite::toJSON(list(collection = collection),
2076 response <- private$REST$http$exec("PUT", url, headers, body,
2077 queryArgs, private$numRetries)
2078 resource <- private$REST$httpParser$parseJSONResponse(response)
2080 if(!is.null(resource$errors))
2081 stop(resource$errors)
2086 collections.delete = function(uuid)
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")
2096 response <- private$REST$http$exec("DELETE", url, headers, body,
2097 queryArgs, private$numRetries)
2098 resource <- private$REST$httpParser$parseJSONResponse(response)
2100 if(!is.null(resource$errors))
2101 stop(resource$errors)
2106 collections.provenance = function(uuid)
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")
2116 response <- private$REST$http$exec("GET", url, headers, body,
2117 queryArgs, private$numRetries)
2118 resource <- private$REST$httpParser$parseJSONResponse(response)
2120 if(!is.null(resource$errors))
2121 stop(resource$errors)
2126 collections.used_by = function(uuid)
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")
2136 response <- private$REST$http$exec("GET", url, headers, body,
2137 queryArgs, private$numRetries)
2138 resource <- private$REST$httpParser$parseJSONResponse(response)
2140 if(!is.null(resource$errors))
2141 stop(resource$errors)
2146 collections.trash = function(uuid)
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")
2156 response <- private$REST$http$exec("POST", url, headers, body,
2157 queryArgs, private$numRetries)
2158 resource <- private$REST$httpParser$parseJSONResponse(response)
2160 if(!is.null(resource$errors))
2161 stop(resource$errors)
2166 collections.untrash = function(uuid)
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")
2176 response <- private$REST$http$exec("POST", url, headers, body,
2177 queryArgs, private$numRetries)
2178 resource <- private$REST$httpParser$parseJSONResponse(response)
2180 if(!is.null(resource$errors))
2181 stop(resource$errors)
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)
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)
2204 response <- private$REST$http$exec("GET", url, headers, body,
2205 queryArgs, private$numRetries)
2206 resource <- private$REST$httpParser$parseJSONResponse(response)
2208 if(!is.null(resource$errors))
2209 stop(resource$errors)
2214 containers.get = function(uuid)
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")
2224 response <- private$REST$http$exec("GET", url, headers, body,
2225 queryArgs, private$numRetries)
2226 resource <- private$REST$httpParser$parseJSONResponse(response)
2228 if(!is.null(resource$errors))
2229 stop(resource$errors)
2234 containers.create = function(container, ensure_unique_name = "false",
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)
2244 if(length(container) > 0)
2245 body <- jsonlite::toJSON(list(container = container),
2250 response <- private$REST$http$exec("POST", url, headers, body,
2251 queryArgs, private$numRetries)
2252 resource <- private$REST$httpParser$parseJSONResponse(response)
2254 if(!is.null(resource$errors))
2255 stop(resource$errors)
2260 containers.update = function(container, uuid)
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")
2268 if(length(container) > 0)
2269 body <- jsonlite::toJSON(list(container = container),
2274 response <- private$REST$http$exec("PUT", url, headers, body,
2275 queryArgs, private$numRetries)
2276 resource <- private$REST$httpParser$parseJSONResponse(response)
2278 if(!is.null(resource$errors))
2279 stop(resource$errors)
2284 containers.delete = function(uuid)
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")
2294 response <- private$REST$http$exec("DELETE", url, headers, body,
2295 queryArgs, private$numRetries)
2296 resource <- private$REST$httpParser$parseJSONResponse(response)
2298 if(!is.null(resource$errors))
2299 stop(resource$errors)
2304 containers.auth = function(uuid)
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")
2314 response <- private$REST$http$exec("GET", url, headers, body,
2315 queryArgs, private$numRetries)
2316 resource <- private$REST$httpParser$parseJSONResponse(response)
2318 if(!is.null(resource$errors))
2319 stop(resource$errors)
2324 containers.lock = function(uuid)
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")
2334 response <- private$REST$http$exec("POST", url, headers, body,
2335 queryArgs, private$numRetries)
2336 resource <- private$REST$httpParser$parseJSONResponse(response)
2338 if(!is.null(resource$errors))
2339 stop(resource$errors)
2344 containers.unlock = function(uuid)
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")
2354 response <- private$REST$http$exec("POST", url, headers, body,
2355 queryArgs, private$numRetries)
2356 resource <- private$REST$httpParser$parseJSONResponse(response)
2358 if(!is.null(resource$errors))
2359 stop(resource$errors)
2364 containers.secret_mounts = function(uuid)
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")
2374 response <- private$REST$http$exec("GET", url, headers, body,
2375 queryArgs, private$numRetries)
2376 resource <- private$REST$httpParser$parseJSONResponse(response)
2378 if(!is.null(resource$errors))
2379 stop(resource$errors)
2384 containers.current = function()
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")
2394 response <- private$REST$http$exec("GET", url, headers, body,
2395 queryArgs, private$numRetries)
2396 resource <- private$REST$httpParser$parseJSONResponse(response)
2398 if(!is.null(resource$errors))
2399 stop(resource$errors)
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)
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)
2420 response <- private$REST$http$exec("GET", url, headers, body,
2421 queryArgs, private$numRetries)
2422 resource <- private$REST$httpParser$parseJSONResponse(response)
2424 if(!is.null(resource$errors))
2425 stop(resource$errors)
2430 container_requests.get = function(uuid)
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")
2440 response <- private$REST$http$exec("GET", url, headers, body,
2441 queryArgs, private$numRetries)
2442 resource <- private$REST$httpParser$parseJSONResponse(response)
2444 if(!is.null(resource$errors))
2445 stop(resource$errors)
2450 container_requests.create = function(containerrequest,
2451 ensure_unique_name = "false", cluster_id = NULL)
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)
2460 if(length(containerrequest) > 0)
2461 body <- jsonlite::toJSON(list(containerrequest = containerrequest),
2466 response <- private$REST$http$exec("POST", url, headers, body,
2467 queryArgs, private$numRetries)
2468 resource <- private$REST$httpParser$parseJSONResponse(response)
2470 if(!is.null(resource$errors))
2471 stop(resource$errors)
2476 container_requests.update = function(containerrequest, uuid)
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")
2484 if(length(containerrequest) > 0)
2485 body <- jsonlite::toJSON(list(containerrequest = containerrequest),
2490 response <- private$REST$http$exec("PUT", url, headers, body,
2491 queryArgs, private$numRetries)
2492 resource <- private$REST$httpParser$parseJSONResponse(response)
2494 if(!is.null(resource$errors))
2495 stop(resource$errors)
2500 container_requests.delete = function(uuid)
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")
2510 response <- private$REST$http$exec("DELETE", url, headers, body,
2511 queryArgs, private$numRetries)
2512 resource <- private$REST$httpParser$parseJSONResponse(response)
2514 if(!is.null(resource$errors))
2515 stop(resource$errors)
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)
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)
2538 response <- private$REST$http$exec("GET", url, headers, body,
2539 queryArgs, private$numRetries)
2540 resource <- private$REST$httpParser$parseJSONResponse(response)
2542 if(!is.null(resource$errors))
2543 stop(resource$errors)
2548 groups.get = function(uuid)
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")
2558 response <- private$REST$http$exec("GET", url, headers, body,
2559 queryArgs, private$numRetries)
2560 resource <- private$REST$httpParser$parseJSONResponse(response)
2562 if(!is.null(resource$errors))
2563 stop(resource$errors)
2568 groups.create = function(group, ensure_unique_name = "false",
2569 cluster_id = NULL, async = "false")
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)
2578 if(length(group) > 0)
2579 body <- jsonlite::toJSON(list(group = group),
2584 response <- private$REST$http$exec("POST", url, headers, body,
2585 queryArgs, private$numRetries)
2586 resource <- private$REST$httpParser$parseJSONResponse(response)
2588 if(!is.null(resource$errors))
2589 stop(resource$errors)
2594 groups.update = function(group, uuid, async = "false")
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)
2602 if(length(group) > 0)
2603 body <- jsonlite::toJSON(list(group = group),
2608 response <- private$REST$http$exec("PUT", url, headers, body,
2609 queryArgs, private$numRetries)
2610 resource <- private$REST$httpParser$parseJSONResponse(response)
2612 if(!is.null(resource$errors))
2613 stop(resource$errors)
2618 groups.delete = function(uuid)
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")
2628 response <- private$REST$http$exec("DELETE", url, headers, body,
2629 queryArgs, private$numRetries)
2630 resource <- private$REST$httpParser$parseJSONResponse(response)
2632 if(!is.null(resource$errors))
2633 stop(resource$errors)
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,
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)
2657 response <- private$REST$http$exec("GET", url, headers, body,
2658 queryArgs, private$numRetries)
2659 resource <- private$REST$httpParser$parseJSONResponse(response)
2661 if(!is.null(resource$errors))
2662 stop(resource$errors)
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)
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)
2685 response <- private$REST$http$exec("GET", url, headers, body,
2686 queryArgs, private$numRetries)
2687 resource <- private$REST$httpParser$parseJSONResponse(response)
2689 if(!is.null(resource$errors))
2690 stop(resource$errors)
2695 groups.trash = function(uuid)
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")
2705 response <- private$REST$http$exec("POST", url, headers, body,
2706 queryArgs, private$numRetries)
2707 resource <- private$REST$httpParser$parseJSONResponse(response)
2709 if(!is.null(resource$errors))
2710 stop(resource$errors)
2715 groups.untrash = function(uuid)
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")
2725 response <- private$REST$http$exec("POST", url, headers, body,
2726 queryArgs, private$numRetries)
2727 resource <- private$REST$httpParser$parseJSONResponse(response)
2729 if(!is.null(resource$errors))
2730 stop(resource$errors)
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)
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)
2753 response <- private$REST$http$exec("GET", url, headers, body,
2754 queryArgs, private$numRetries)
2755 resource <- private$REST$httpParser$parseJSONResponse(response)
2757 if(!is.null(resource$errors))
2758 stop(resource$errors)
2763 keep_services.get = function(uuid)
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")
2773 response <- private$REST$http$exec("GET", url, headers, body,
2774 queryArgs, private$numRetries)
2775 resource <- private$REST$httpParser$parseJSONResponse(response)
2777 if(!is.null(resource$errors))
2778 stop(resource$errors)
2783 keep_services.create = function(keepservice,
2784 ensure_unique_name = "false", cluster_id = NULL)
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)
2793 if(length(keepservice) > 0)
2794 body <- jsonlite::toJSON(list(keepservice = keepservice),
2799 response <- private$REST$http$exec("POST", url, headers, body,
2800 queryArgs, private$numRetries)
2801 resource <- private$REST$httpParser$parseJSONResponse(response)
2803 if(!is.null(resource$errors))
2804 stop(resource$errors)
2809 keep_services.update = function(keepservice, uuid)
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")
2817 if(length(keepservice) > 0)
2818 body <- jsonlite::toJSON(list(keepservice = keepservice),
2823 response <- private$REST$http$exec("PUT", url, headers, body,
2824 queryArgs, private$numRetries)
2825 resource <- private$REST$httpParser$parseJSONResponse(response)
2827 if(!is.null(resource$errors))
2828 stop(resource$errors)
2833 keep_services.delete = function(uuid)
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")
2843 response <- private$REST$http$exec("DELETE", url, headers, body,
2844 queryArgs, private$numRetries)
2845 resource <- private$REST$httpParser$parseJSONResponse(response)
2847 if(!is.null(resource$errors))
2848 stop(resource$errors)
2853 keep_services.accessible = function()
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")
2863 response <- private$REST$http$exec("GET", url, headers, body,
2864 queryArgs, private$numRetries)
2865 resource <- private$REST$httpParser$parseJSONResponse(response)
2867 if(!is.null(resource$errors))
2868 stop(resource$errors)
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)
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)
2889 response <- private$REST$http$exec("GET", url, headers, body,
2890 queryArgs, private$numRetries)
2891 resource <- private$REST$httpParser$parseJSONResponse(response)
2893 if(!is.null(resource$errors))
2894 stop(resource$errors)
2899 links.get = function(uuid)
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")
2909 response <- private$REST$http$exec("GET", url, headers, body,
2910 queryArgs, private$numRetries)
2911 resource <- private$REST$httpParser$parseJSONResponse(response)
2913 if(!is.null(resource$errors))
2914 stop(resource$errors)
2919 links.create = function(link, ensure_unique_name = "false",
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)
2929 if(length(link) > 0)
2930 body <- jsonlite::toJSON(list(link = link),
2935 response <- private$REST$http$exec("POST", url, headers, body,
2936 queryArgs, private$numRetries)
2937 resource <- private$REST$httpParser$parseJSONResponse(response)
2939 if(!is.null(resource$errors))
2940 stop(resource$errors)
2945 links.update = function(link, uuid)
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")
2953 if(length(link) > 0)
2954 body <- jsonlite::toJSON(list(link = link),
2959 response <- private$REST$http$exec("PUT", url, headers, body,
2960 queryArgs, private$numRetries)
2961 resource <- private$REST$httpParser$parseJSONResponse(response)
2963 if(!is.null(resource$errors))
2964 stop(resource$errors)
2969 links.delete = function(uuid)
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")
2979 response <- private$REST$http$exec("DELETE", url, headers, body,
2980 queryArgs, private$numRetries)
2981 resource <- private$REST$httpParser$parseJSONResponse(response)
2983 if(!is.null(resource$errors))
2984 stop(resource$errors)
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)
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)
3005 response <- private$REST$http$exec("GET", url, headers, body,
3006 queryArgs, private$numRetries)
3007 resource <- private$REST$httpParser$parseJSONResponse(response)
3009 if(!is.null(resource$errors))
3010 stop(resource$errors)
3015 links.get_permissions = function(uuid)
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")
3025 response <- private$REST$http$exec("GET", url, headers, body,
3026 queryArgs, private$numRetries)
3027 resource <- private$REST$httpParser$parseJSONResponse(response)
3029 if(!is.null(resource$errors))
3030 stop(resource$errors)
3035 logs.get = function(uuid)
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")
3045 response <- private$REST$http$exec("GET", url, headers, body,
3046 queryArgs, private$numRetries)
3047 resource <- private$REST$httpParser$parseJSONResponse(response)
3049 if(!is.null(resource$errors))
3050 stop(resource$errors)
3055 logs.create = function(log, ensure_unique_name = "false",
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)
3066 body <- jsonlite::toJSON(list(log = log),
3071 response <- private$REST$http$exec("POST", url, headers, body,
3072 queryArgs, private$numRetries)
3073 resource <- private$REST$httpParser$parseJSONResponse(response)
3075 if(!is.null(resource$errors))
3076 stop(resource$errors)
3081 logs.update = function(log, uuid)
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")
3090 body <- jsonlite::toJSON(list(log = log),
3095 response <- private$REST$http$exec("PUT", url, headers, body,
3096 queryArgs, private$numRetries)
3097 resource <- private$REST$httpParser$parseJSONResponse(response)
3099 if(!is.null(resource$errors))
3100 stop(resource$errors)
3105 logs.delete = function(uuid)
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")
3115 response <- private$REST$http$exec("DELETE", url, headers, body,
3116 queryArgs, private$numRetries)
3117 resource <- private$REST$httpParser$parseJSONResponse(response)
3119 if(!is.null(resource$errors))
3120 stop(resource$errors)
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)
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)
3141 response <- private$REST$http$exec("GET", url, headers, body,
3142 queryArgs, private$numRetries)
3143 resource <- private$REST$httpParser$parseJSONResponse(response)
3145 if(!is.null(resource$errors))
3146 stop(resource$errors)
3151 users.get = function(uuid)
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")
3161 response <- private$REST$http$exec("GET", url, headers, body,
3162 queryArgs, private$numRetries)
3163 resource <- private$REST$httpParser$parseJSONResponse(response)
3165 if(!is.null(resource$errors))
3166 stop(resource$errors)
3171 users.create = function(user, ensure_unique_name = "false",
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)
3181 if(length(user) > 0)
3182 body <- jsonlite::toJSON(list(user = user),
3187 response <- private$REST$http$exec("POST", url, headers, body,
3188 queryArgs, private$numRetries)
3189 resource <- private$REST$httpParser$parseJSONResponse(response)
3191 if(!is.null(resource$errors))
3192 stop(resource$errors)
3197 users.update = function(user, uuid, bypass_federation = NULL)
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)
3205 if(length(user) > 0)
3206 body <- jsonlite::toJSON(list(user = user),
3211 response <- private$REST$http$exec("PUT", url, headers, body,
3212 queryArgs, private$numRetries)
3213 resource <- private$REST$httpParser$parseJSONResponse(response)
3215 if(!is.null(resource$errors))
3216 stop(resource$errors)
3221 users.delete = function(uuid)
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")
3231 response <- private$REST$http$exec("DELETE", url, headers, body,
3232 queryArgs, private$numRetries)
3233 resource <- private$REST$httpParser$parseJSONResponse(response)
3235 if(!is.null(resource$errors))
3236 stop(resource$errors)
3241 users.current = function()
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")
3251 response <- private$REST$http$exec("GET", url, headers, body,
3252 queryArgs, private$numRetries)
3253 resource <- private$REST$httpParser$parseJSONResponse(response)
3255 if(!is.null(resource$errors))
3256 stop(resource$errors)
3261 users.system = function()
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")
3271 response <- private$REST$http$exec("GET", url, headers, body,
3272 queryArgs, private$numRetries)
3273 resource <- private$REST$httpParser$parseJSONResponse(response)
3275 if(!is.null(resource$errors))
3276 stop(resource$errors)
3281 users.activate = function(uuid)
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")
3291 response <- private$REST$http$exec("POST", url, headers, body,
3292 queryArgs, private$numRetries)
3293 resource <- private$REST$httpParser$parseJSONResponse(response)
3295 if(!is.null(resource$errors))
3296 stop(resource$errors)
3301 users.setup = function(uuid = NULL, user = NULL,
3302 repo_name = NULL, vm_uuid = NULL, send_notification_email = "false")
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)
3314 response <- private$REST$http$exec("POST", url, headers, body,
3315 queryArgs, private$numRetries)
3316 resource <- private$REST$httpParser$parseJSONResponse(response)
3318 if(!is.null(resource$errors))
3319 stop(resource$errors)
3324 users.unsetup = function(uuid)
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")
3334 response <- private$REST$http$exec("POST", url, headers, body,
3335 queryArgs, private$numRetries)
3336 resource <- private$REST$httpParser$parseJSONResponse(response)
3338 if(!is.null(resource$errors))
3339 stop(resource$errors)
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)
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)
3358 response <- private$REST$http$exec("POST", url, headers, body,
3359 queryArgs, private$numRetries)
3360 resource <- private$REST$httpParser$parseJSONResponse(response)
3362 if(!is.null(resource$errors))
3363 stop(resource$errors)
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)
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)
3384 response <- private$REST$http$exec("GET", url, headers, body,
3385 queryArgs, private$numRetries)
3386 resource <- private$REST$httpParser$parseJSONResponse(response)
3388 if(!is.null(resource$errors))
3389 stop(resource$errors)
3394 repositories.get = function(uuid)
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")
3404 response <- private$REST$http$exec("GET", url, headers, body,
3405 queryArgs, private$numRetries)
3406 resource <- private$REST$httpParser$parseJSONResponse(response)
3408 if(!is.null(resource$errors))
3409 stop(resource$errors)
3414 repositories.create = function(repository,
3415 ensure_unique_name = "false", cluster_id = NULL)
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)
3424 if(length(repository) > 0)
3425 body <- jsonlite::toJSON(list(repository = repository),
3430 response <- private$REST$http$exec("POST", url, headers, body,
3431 queryArgs, private$numRetries)
3432 resource <- private$REST$httpParser$parseJSONResponse(response)
3434 if(!is.null(resource$errors))
3435 stop(resource$errors)
3440 repositories.update = function(repository, uuid)
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")
3448 if(length(repository) > 0)
3449 body <- jsonlite::toJSON(list(repository = repository),
3454 response <- private$REST$http$exec("PUT", url, headers, body,
3455 queryArgs, private$numRetries)
3456 resource <- private$REST$httpParser$parseJSONResponse(response)
3458 if(!is.null(resource$errors))
3459 stop(resource$errors)
3464 repositories.delete = function(uuid)
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")
3474 response <- private$REST$http$exec("DELETE", url, headers, body,
3475 queryArgs, private$numRetries)
3476 resource <- private$REST$httpParser$parseJSONResponse(response)
3478 if(!is.null(resource$errors))
3479 stop(resource$errors)
3484 repositories.get_all_permissions = function()
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")
3494 response <- private$REST$http$exec("GET", url, headers, body,
3495 queryArgs, private$numRetries)
3496 resource <- private$REST$httpParser$parseJSONResponse(response)
3498 if(!is.null(resource$errors))
3499 stop(resource$errors)
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)
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)
3520 response <- private$REST$http$exec("GET", url, headers, body,
3521 queryArgs, private$numRetries)
3522 resource <- private$REST$httpParser$parseJSONResponse(response)
3524 if(!is.null(resource$errors))
3525 stop(resource$errors)
3530 virtual_machines.get = function(uuid)
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")
3540 response <- private$REST$http$exec("GET", url, headers, body,
3541 queryArgs, private$numRetries)
3542 resource <- private$REST$httpParser$parseJSONResponse(response)
3544 if(!is.null(resource$errors))
3545 stop(resource$errors)
3550 virtual_machines.create = function(virtualmachine,
3551 ensure_unique_name = "false", cluster_id = NULL)
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)
3560 if(length(virtualmachine) > 0)
3561 body <- jsonlite::toJSON(list(virtualmachine = virtualmachine),
3566 response <- private$REST$http$exec("POST", url, headers, body,
3567 queryArgs, private$numRetries)
3568 resource <- private$REST$httpParser$parseJSONResponse(response)
3570 if(!is.null(resource$errors))
3571 stop(resource$errors)
3576 virtual_machines.update = function(virtualmachine, uuid)
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")
3584 if(length(virtualmachine) > 0)
3585 body <- jsonlite::toJSON(list(virtualmachine = virtualmachine),
3590 response <- private$REST$http$exec("PUT", url, headers, body,
3591 queryArgs, private$numRetries)
3592 resource <- private$REST$httpParser$parseJSONResponse(response)
3594 if(!is.null(resource$errors))
3595 stop(resource$errors)
3600 virtual_machines.delete = function(uuid)
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")
3610 response <- private$REST$http$exec("DELETE", url, headers, body,
3611 queryArgs, private$numRetries)
3612 resource <- private$REST$httpParser$parseJSONResponse(response)
3614 if(!is.null(resource$errors))
3615 stop(resource$errors)
3620 virtual_machines.logins = function(uuid)
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")
3630 response <- private$REST$http$exec("GET", url, headers, body,
3631 queryArgs, private$numRetries)
3632 resource <- private$REST$httpParser$parseJSONResponse(response)
3634 if(!is.null(resource$errors))
3635 stop(resource$errors)
3640 virtual_machines.get_all_logins = function()
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")
3650 response <- private$REST$http$exec("GET", url, headers, body,
3651 queryArgs, private$numRetries)
3652 resource <- private$REST$httpParser$parseJSONResponse(response)
3654 if(!is.null(resource$errors))
3655 stop(resource$errors)
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)
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)
3676 response <- private$REST$http$exec("GET", url, headers, body,
3677 queryArgs, private$numRetries)
3678 resource <- private$REST$httpParser$parseJSONResponse(response)
3680 if(!is.null(resource$errors))
3681 stop(resource$errors)
3686 workflows.get = function(uuid)
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")
3696 response <- private$REST$http$exec("GET", url, headers, body,
3697 queryArgs, private$numRetries)
3698 resource <- private$REST$httpParser$parseJSONResponse(response)
3700 if(!is.null(resource$errors))
3701 stop(resource$errors)
3706 workflows.create = function(workflow, ensure_unique_name = "false",
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)
3716 if(length(workflow) > 0)
3717 body <- jsonlite::toJSON(list(workflow = workflow),
3722 response <- private$REST$http$exec("POST", url, headers, body,
3723 queryArgs, private$numRetries)
3724 resource <- private$REST$httpParser$parseJSONResponse(response)
3726 if(!is.null(resource$errors))
3727 stop(resource$errors)
3732 workflows.update = function(workflow, uuid)
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")
3740 if(length(workflow) > 0)
3741 body <- jsonlite::toJSON(list(workflow = workflow),
3746 response <- private$REST$http$exec("PUT", url, headers, body,
3747 queryArgs, private$numRetries)
3748 resource <- private$REST$httpParser$parseJSONResponse(response)
3750 if(!is.null(resource$errors))
3751 stop(resource$errors)
3756 workflows.delete = function(uuid)
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")
3766 response <- private$REST$http$exec("DELETE", url, headers, body,
3767 queryArgs, private$numRetries)
3768 resource <- private$REST$httpParser$parseJSONResponse(response)
3770 if(!is.null(resource$errors))
3771 stop(resource$errors)
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)
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)
3792 response <- private$REST$http$exec("GET", url, headers, body,
3793 queryArgs, private$numRetries)
3794 resource <- private$REST$httpParser$parseJSONResponse(response)
3796 if(!is.null(resource$errors))
3797 stop(resource$errors)
3802 user_agreements.get = function(uuid)
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")
3812 response <- private$REST$http$exec("GET", url, headers, body,
3813 queryArgs, private$numRetries)
3814 resource <- private$REST$httpParser$parseJSONResponse(response)
3816 if(!is.null(resource$errors))
3817 stop(resource$errors)
3822 user_agreements.create = function(useragreement,
3823 ensure_unique_name = "false", cluster_id = NULL)
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)
3832 if(length(useragreement) > 0)
3833 body <- jsonlite::toJSON(list(useragreement = useragreement),
3838 response <- private$REST$http$exec("POST", url, headers, body,
3839 queryArgs, private$numRetries)
3840 resource <- private$REST$httpParser$parseJSONResponse(response)
3842 if(!is.null(resource$errors))
3843 stop(resource$errors)
3848 user_agreements.update = function(useragreement, uuid)
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")
3856 if(length(useragreement) > 0)
3857 body <- jsonlite::toJSON(list(useragreement = useragreement),
3862 response <- private$REST$http$exec("PUT", url, headers, body,
3863 queryArgs, private$numRetries)
3864 resource <- private$REST$httpParser$parseJSONResponse(response)
3866 if(!is.null(resource$errors))
3867 stop(resource$errors)
3872 user_agreements.delete = function(uuid)
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")
3882 response <- private$REST$http$exec("DELETE", url, headers, body,
3883 queryArgs, private$numRetries)
3884 resource <- private$REST$httpParser$parseJSONResponse(response)
3886 if(!is.null(resource$errors))
3887 stop(resource$errors)
3892 user_agreements.signatures = function()
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")
3902 response <- private$REST$http$exec("GET", url, headers, body,
3903 queryArgs, private$numRetries)
3904 resource <- private$REST$httpParser$parseJSONResponse(response)
3906 if(!is.null(resource$errors))
3907 stop(resource$errors)
3912 user_agreements.sign = function()
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")
3922 response <- private$REST$http$exec("POST", url, headers, body,
3923 queryArgs, private$numRetries)
3924 resource <- private$REST$httpParser$parseJSONResponse(response)
3926 if(!is.null(resource$errors))
3927 stop(resource$errors)
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)
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)
3948 response <- private$REST$http$exec("GET", url, headers, body,
3949 queryArgs, private$numRetries)
3950 resource <- private$REST$httpParser$parseJSONResponse(response)
3952 if(!is.null(resource$errors))
3953 stop(resource$errors)
3958 user_agreements.new = function()
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")
3968 response <- private$REST$http$exec("GET", url, headers, body,
3969 queryArgs, private$numRetries)
3970 resource <- private$REST$httpParser$parseJSONResponse(response)
3972 if(!is.null(resource$errors))
3973 stop(resource$errors)
3978 configs.get = function()
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")
3988 response <- private$REST$http$exec("GET", url, headers, body,
3989 queryArgs, private$numRetries)
3990 resource <- private$REST$httpParser$parseJSONResponse(response)
3992 if(!is.null(resource$errors))
3993 stop(resource$errors)
3998 getHostName = function() private$host,
3999 getToken = function() private$token,
4000 setRESTService = function(newREST) private$REST <- newREST,
4001 getRESTService = function() private$REST