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.update_uuid is a method defined in Arvados class.
985 #' @usage arv$users.update_uuid(uuid, new_uuid)
988 #' @return User object.
989 #' @name users.update_uuid
994 #' users.merge is a method defined in Arvados class.
996 #' @usage arv$users.merge(new_owner_uuid,
997 #' new_user_token = NULL, redirect_to_new_user = NULL,
998 #' old_user_uuid = NULL, new_user_uuid = NULL)
999 #' @param new_owner_uuid
1000 #' @param new_user_token
1001 #' @param redirect_to_new_user
1002 #' @param old_user_uuid
1003 #' @param new_user_uuid
1004 #' @return User object.
1005 #' @name users.merge
1010 #' users.list is a method defined in Arvados class.
1012 #' @usage arv$users.list(filters = NULL,
1013 #' where = NULL, order = NULL, select = NULL,
1014 #' distinct = NULL, limit = "100", offset = "0",
1015 #' count = "exact", cluster_id = NULL, bypass_federation = NULL)
1024 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
1025 #' @param bypass_federation bypass federation behavior, list items from local instance database only
1026 #' @return UserList object.
1032 #' repositories.get is a method defined in Arvados class.
1034 #' @usage arv$repositories.get(uuid)
1035 #' @param uuid The UUID of the Repository in question.
1036 #' @return Repository object.
1037 #' @name repositories.get
1040 #' repositories.create
1042 #' repositories.create is a method defined in Arvados class.
1044 #' @usage arv$repositories.create(repository,
1045 #' ensure_unique_name = "false", cluster_id = NULL)
1046 #' @param repository Repository object.
1047 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
1048 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
1049 #' @return Repository object.
1050 #' @name repositories.create
1053 #' repositories.update
1055 #' repositories.update is a method defined in Arvados class.
1057 #' @usage arv$repositories.update(repository,
1059 #' @param repository Repository object.
1060 #' @param uuid The UUID of the Repository in question.
1061 #' @return Repository object.
1062 #' @name repositories.update
1065 #' repositories.delete
1067 #' repositories.delete is a method defined in Arvados class.
1069 #' @usage arv$repositories.delete(uuid)
1070 #' @param uuid The UUID of the Repository in question.
1071 #' @return Repository object.
1072 #' @name repositories.delete
1075 #' repositories.get_all_permissions
1077 #' repositories.get_all_permissions is a method defined in Arvados class.
1079 #' @usage arv$repositories.get_all_permissions(NULL)
1080 #' @return Repository object.
1081 #' @name repositories.get_all_permissions
1084 #' repositories.list
1086 #' repositories.list is a method defined in Arvados class.
1088 #' @usage arv$repositories.list(filters = NULL,
1089 #' where = NULL, order = NULL, select = NULL,
1090 #' distinct = NULL, limit = "100", offset = "0",
1091 #' count = "exact", cluster_id = NULL, bypass_federation = NULL)
1100 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
1101 #' @param bypass_federation bypass federation behavior, list items from local instance database only
1102 #' @return RepositoryList object.
1103 #' @name repositories.list
1106 #' virtual_machines.get
1108 #' virtual_machines.get is a method defined in Arvados class.
1110 #' @usage arv$virtual_machines.get(uuid)
1111 #' @param uuid The UUID of the VirtualMachine in question.
1112 #' @return VirtualMachine object.
1113 #' @name virtual_machines.get
1116 #' virtual_machines.create
1118 #' virtual_machines.create is a method defined in Arvados class.
1120 #' @usage arv$virtual_machines.create(virtualmachine,
1121 #' ensure_unique_name = "false", cluster_id = NULL)
1122 #' @param virtualMachine VirtualMachine object.
1123 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
1124 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
1125 #' @return VirtualMachine object.
1126 #' @name virtual_machines.create
1129 #' virtual_machines.update
1131 #' virtual_machines.update is a method defined in Arvados class.
1133 #' @usage arv$virtual_machines.update(virtualmachine,
1135 #' @param virtualMachine VirtualMachine object.
1136 #' @param uuid The UUID of the VirtualMachine in question.
1137 #' @return VirtualMachine object.
1138 #' @name virtual_machines.update
1141 #' virtual_machines.delete
1143 #' virtual_machines.delete is a method defined in Arvados class.
1145 #' @usage arv$virtual_machines.delete(uuid)
1146 #' @param uuid The UUID of the VirtualMachine in question.
1147 #' @return VirtualMachine object.
1148 #' @name virtual_machines.delete
1151 #' virtual_machines.logins
1153 #' virtual_machines.logins is a method defined in Arvados class.
1155 #' @usage arv$virtual_machines.logins(uuid)
1157 #' @return VirtualMachine object.
1158 #' @name virtual_machines.logins
1161 #' virtual_machines.get_all_logins
1163 #' virtual_machines.get_all_logins is a method defined in Arvados class.
1165 #' @usage arv$virtual_machines.get_all_logins(NULL)
1166 #' @return VirtualMachine object.
1167 #' @name virtual_machines.get_all_logins
1170 #' virtual_machines.list
1172 #' virtual_machines.list is a method defined in Arvados class.
1174 #' @usage arv$virtual_machines.list(filters = NULL,
1175 #' where = NULL, order = NULL, select = NULL,
1176 #' distinct = NULL, limit = "100", offset = "0",
1177 #' count = "exact", cluster_id = NULL, bypass_federation = NULL)
1186 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
1187 #' @param bypass_federation bypass federation behavior, list items from local instance database only
1188 #' @return VirtualMachineList object.
1189 #' @name virtual_machines.list
1194 #' workflows.get is a method defined in Arvados class.
1196 #' @usage arv$workflows.get(uuid)
1197 #' @param uuid The UUID of the Workflow in question.
1198 #' @return Workflow object.
1199 #' @name workflows.get
1204 #' workflows.create is a method defined in Arvados class.
1206 #' @usage arv$workflows.create(workflow,
1207 #' ensure_unique_name = "false", cluster_id = NULL)
1208 #' @param workflow Workflow object.
1209 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
1210 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
1211 #' @return Workflow object.
1212 #' @name workflows.create
1217 #' workflows.update is a method defined in Arvados class.
1219 #' @usage arv$workflows.update(workflow,
1221 #' @param workflow Workflow object.
1222 #' @param uuid The UUID of the Workflow in question.
1223 #' @return Workflow object.
1224 #' @name workflows.update
1229 #' workflows.delete is a method defined in Arvados class.
1231 #' @usage arv$workflows.delete(uuid)
1232 #' @param uuid The UUID of the Workflow in question.
1233 #' @return Workflow object.
1234 #' @name workflows.delete
1239 #' workflows.list is a method defined in Arvados class.
1241 #' @usage arv$workflows.list(filters = NULL,
1242 #' where = NULL, order = NULL, select = NULL,
1243 #' distinct = NULL, limit = "100", offset = "0",
1244 #' count = "exact", cluster_id = NULL, bypass_federation = NULL)
1253 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
1254 #' @param bypass_federation bypass federation behavior, list items from local instance database only
1255 #' @return WorkflowList object.
1256 #' @name workflows.list
1259 #' user_agreements.get
1261 #' user_agreements.get is a method defined in Arvados class.
1263 #' @usage arv$user_agreements.get(uuid)
1264 #' @param uuid The UUID of the UserAgreement in question.
1265 #' @return UserAgreement object.
1266 #' @name user_agreements.get
1269 #' user_agreements.create
1271 #' user_agreements.create is a method defined in Arvados class.
1273 #' @usage arv$user_agreements.create(useragreement,
1274 #' ensure_unique_name = "false", cluster_id = NULL)
1275 #' @param userAgreement UserAgreement object.
1276 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
1277 #' @param cluster_id Create object on a remote federated cluster instead of the current one.
1278 #' @return UserAgreement object.
1279 #' @name user_agreements.create
1282 #' user_agreements.update
1284 #' user_agreements.update is a method defined in Arvados class.
1286 #' @usage arv$user_agreements.update(useragreement,
1288 #' @param userAgreement UserAgreement object.
1289 #' @param uuid The UUID of the UserAgreement in question.
1290 #' @return UserAgreement object.
1291 #' @name user_agreements.update
1294 #' user_agreements.delete
1296 #' user_agreements.delete is a method defined in Arvados class.
1298 #' @usage arv$user_agreements.delete(uuid)
1299 #' @param uuid The UUID of the UserAgreement in question.
1300 #' @return UserAgreement object.
1301 #' @name user_agreements.delete
1304 #' user_agreements.signatures
1306 #' user_agreements.signatures is a method defined in Arvados class.
1308 #' @usage arv$user_agreements.signatures(NULL)
1309 #' @return UserAgreement object.
1310 #' @name user_agreements.signatures
1313 #' user_agreements.sign
1315 #' user_agreements.sign is a method defined in Arvados class.
1317 #' @usage arv$user_agreements.sign(NULL)
1318 #' @return UserAgreement object.
1319 #' @name user_agreements.sign
1322 #' user_agreements.list
1324 #' user_agreements.list is a method defined in Arvados class.
1326 #' @usage arv$user_agreements.list(filters = NULL,
1327 #' where = NULL, order = NULL, select = NULL,
1328 #' distinct = NULL, limit = "100", offset = "0",
1329 #' count = "exact", cluster_id = NULL, bypass_federation = NULL)
1338 #' @param cluster_id List objects on a remote federated cluster instead of the current one.
1339 #' @param bypass_federation bypass federation behavior, list items from local instance database only
1340 #' @return UserAgreementList object.
1341 #' @name user_agreements.list
1344 #' user_agreements.new
1346 #' user_agreements.new is a method defined in Arvados class.
1348 #' @usage arv$user_agreements.new(NULL)
1349 #' @return UserAgreement object.
1350 #' @name user_agreements.new
1355 #' configs.get is a method defined in Arvados class.
1357 #' @usage arv$configs.get(NULL)
1359 #' @name configs.get
1364 #' projects.get is equivalent to groups.get method.
1366 #' @usage arv$projects.get(uuid)
1367 #' @param uuid The UUID of the Group in question.
1368 #' @return Group object.
1369 #' @name projects.get
1374 #' projects.create wrapps groups.create method by setting group_class attribute to "project".
1376 #' @usage arv$projects.create(group, ensure_unique_name = "false")
1377 #' @param group Group object.
1378 #' @param ensure_unique_name Adjust name to ensure uniqueness instead of returning an error on (owner_uuid, name) collision.
1379 #' @return Group object.
1380 #' @name projects.create
1385 #' projects.update wrapps groups.update method by setting group_class attribute to "project".
1387 #' @usage arv$projects.update(group, uuid)
1388 #' @param group Group object.
1389 #' @param uuid The UUID of the Group in question.
1390 #' @return Group object.
1391 #' @name projects.update
1396 #' projects.delete is equivalent to groups.delete method.
1398 #' @usage arv$project.delete(uuid)
1399 #' @param uuid The UUID of the Group in question.
1400 #' @return Group object.
1401 #' @name projects.delete
1406 #' projects.list wrapps groups.list method by setting group_class attribute to "project".
1408 #' @usage arv$projects.list(filters = NULL,
1409 #' where = NULL, order = NULL, distinct = NULL,
1410 #' limit = "100", offset = "0", count = "exact",
1411 #' include_trash = NULL, uuid = NULL, recursive = NULL)
1419 #' @param include_trash Include items whose is_trashed attribute is true.
1421 #' @param recursive Include contents from child groups recursively.
1422 #' @return Group object.
1423 #' @name projects.list
1428 #' Arvados class gives users ability to access Arvados REST API.
1431 #' \preformatted{arv = Arvados$new(authToken = NULL, hostName = NULL, numRetries = 0)}
1433 #' @section Arguments:
1435 #' \item{authToken}{Authentification token. If not specified ARVADOS_API_TOKEN environment variable will be used.}
1436 #' \item{hostName}{Host name. If not specified ARVADOS_API_HOST environment variable will be used.}
1437 #' \item{numRetries}{Number which specifies how many times to retry failed service requests.}
1440 #' @section Methods:
1442 #' \item{}{\code{\link{api_client_authorizations.create}}}
1443 #' \item{}{\code{\link{api_client_authorizations.create_system_auth}}}
1444 #' \item{}{\code{\link{api_client_authorizations.current}}}
1445 #' \item{}{\code{\link{api_client_authorizations.delete}}}
1446 #' \item{}{\code{\link{api_client_authorizations.get}}}
1447 #' \item{}{\code{\link{api_client_authorizations.list}}}
1448 #' \item{}{\code{\link{api_client_authorizations.update}}}
1449 #' \item{}{\code{\link{api_clients.create}}}
1450 #' \item{}{\code{\link{api_clients.delete}}}
1451 #' \item{}{\code{\link{api_clients.get}}}
1452 #' \item{}{\code{\link{api_clients.list}}}
1453 #' \item{}{\code{\link{api_clients.update}}}
1454 #' \item{}{\code{\link{authorized_keys.create}}}
1455 #' \item{}{\code{\link{authorized_keys.delete}}}
1456 #' \item{}{\code{\link{authorized_keys.get}}}
1457 #' \item{}{\code{\link{authorized_keys.list}}}
1458 #' \item{}{\code{\link{authorized_keys.update}}}
1459 #' \item{}{\code{\link{collections.create}}}
1460 #' \item{}{\code{\link{collections.delete}}}
1461 #' \item{}{\code{\link{collections.get}}}
1462 #' \item{}{\code{\link{collections.list}}}
1463 #' \item{}{\code{\link{collections.provenance}}}
1464 #' \item{}{\code{\link{collections.trash}}}
1465 #' \item{}{\code{\link{collections.untrash}}}
1466 #' \item{}{\code{\link{collections.update}}}
1467 #' \item{}{\code{\link{collections.used_by}}}
1468 #' \item{}{\code{\link{configs.get}}}
1469 #' \item{}{\code{\link{container_requests.create}}}
1470 #' \item{}{\code{\link{container_requests.delete}}}
1471 #' \item{}{\code{\link{container_requests.get}}}
1472 #' \item{}{\code{\link{container_requests.list}}}
1473 #' \item{}{\code{\link{container_requests.update}}}
1474 #' \item{}{\code{\link{containers.auth}}}
1475 #' \item{}{\code{\link{containers.create}}}
1476 #' \item{}{\code{\link{containers.current}}}
1477 #' \item{}{\code{\link{containers.delete}}}
1478 #' \item{}{\code{\link{containers.get}}}
1479 #' \item{}{\code{\link{containers.list}}}
1480 #' \item{}{\code{\link{containers.lock}}}
1481 #' \item{}{\code{\link{containers.secret_mounts}}}
1482 #' \item{}{\code{\link{containers.unlock}}}
1483 #' \item{}{\code{\link{containers.update}}}
1484 #' \item{}{\code{\link{groups.contents}}}
1485 #' \item{}{\code{\link{groups.create}}}
1486 #' \item{}{\code{\link{groups.delete}}}
1487 #' \item{}{\code{\link{groups.get}}}
1488 #' \item{}{\code{\link{groups.list}}}
1489 #' \item{}{\code{\link{groups.shared}}}
1490 #' \item{}{\code{\link{groups.trash}}}
1491 #' \item{}{\code{\link{groups.untrash}}}
1492 #' \item{}{\code{\link{groups.update}}}
1493 #' \item{}{\code{\link{keep_services.accessible}}}
1494 #' \item{}{\code{\link{keep_services.create}}}
1495 #' \item{}{\code{\link{keep_services.delete}}}
1496 #' \item{}{\code{\link{keep_services.get}}}
1497 #' \item{}{\code{\link{keep_services.list}}}
1498 #' \item{}{\code{\link{keep_services.update}}}
1499 #' \item{}{\code{\link{links.create}}}
1500 #' \item{}{\code{\link{links.delete}}}
1501 #' \item{}{\code{\link{links.get}}}
1502 #' \item{}{\code{\link{links.get_permissions}}}
1503 #' \item{}{\code{\link{links.list}}}
1504 #' \item{}{\code{\link{links.update}}}
1505 #' \item{}{\code{\link{logs.create}}}
1506 #' \item{}{\code{\link{logs.delete}}}
1507 #' \item{}{\code{\link{logs.get}}}
1508 #' \item{}{\code{\link{logs.list}}}
1509 #' \item{}{\code{\link{logs.update}}}
1510 #' \item{}{\code{\link{projects.create}}}
1511 #' \item{}{\code{\link{projects.delete}}}
1512 #' \item{}{\code{\link{projects.get}}}
1513 #' \item{}{\code{\link{projects.list}}}
1514 #' \item{}{\code{\link{projects.update}}}
1515 #' \item{}{\code{\link{repositories.create}}}
1516 #' \item{}{\code{\link{repositories.delete}}}
1517 #' \item{}{\code{\link{repositories.get}}}
1518 #' \item{}{\code{\link{repositories.get_all_permissions}}}
1519 #' \item{}{\code{\link{repositories.list}}}
1520 #' \item{}{\code{\link{repositories.update}}}
1521 #' \item{}{\code{\link{user_agreements.create}}}
1522 #' \item{}{\code{\link{user_agreements.delete}}}
1523 #' \item{}{\code{\link{user_agreements.get}}}
1524 #' \item{}{\code{\link{user_agreements.list}}}
1525 #' \item{}{\code{\link{user_agreements.new}}}
1526 #' \item{}{\code{\link{user_agreements.sign}}}
1527 #' \item{}{\code{\link{user_agreements.signatures}}}
1528 #' \item{}{\code{\link{user_agreements.update}}}
1529 #' \item{}{\code{\link{users.activate}}}
1530 #' \item{}{\code{\link{users.create}}}
1531 #' \item{}{\code{\link{users.current}}}
1532 #' \item{}{\code{\link{users.delete}}}
1533 #' \item{}{\code{\link{users.get}}}
1534 #' \item{}{\code{\link{users.list}}}
1535 #' \item{}{\code{\link{users.merge}}}
1536 #' \item{}{\code{\link{users.setup}}}
1537 #' \item{}{\code{\link{users.system}}}
1538 #' \item{}{\code{\link{users.unsetup}}}
1539 #' \item{}{\code{\link{users.update}}}
1540 #' \item{}{\code{\link{users.update_uuid}}}
1541 #' \item{}{\code{\link{virtual_machines.create}}}
1542 #' \item{}{\code{\link{virtual_machines.delete}}}
1543 #' \item{}{\code{\link{virtual_machines.get}}}
1544 #' \item{}{\code{\link{virtual_machines.get_all_logins}}}
1545 #' \item{}{\code{\link{virtual_machines.list}}}
1546 #' \item{}{\code{\link{virtual_machines.logins}}}
1547 #' \item{}{\code{\link{virtual_machines.update}}}
1548 #' \item{}{\code{\link{workflows.create}}}
1549 #' \item{}{\code{\link{workflows.delete}}}
1550 #' \item{}{\code{\link{workflows.get}}}
1551 #' \item{}{\code{\link{workflows.list}}}
1552 #' \item{}{\code{\link{workflows.update}}}
1558 #' arv <- Arvados$new("your Arvados token", "example.arvadosapi.com")
1560 #' collection <- arv$collections.get("uuid")
1562 #' collectionList <- arv$collections.list(list(list("name", "like", "Test%")))
1563 #' collectionList <- listAll(arv$collections.list, list(list("name", "like", "Test%")))
1565 #' deletedCollection <- arv$collections.delete("uuid")
1567 #' updatedCollection <- arv$collections.update(list(name = "New name", description = "New description"),
1570 #' createdCollection <- arv$collections.create(list(name = "Example",
1571 #' description = "This is a test collection"))
1576 Arvados <- R6::R6Class(
1582 initialize = function(authToken = NULL, hostName = NULL, numRetries = 0)
1584 if(!is.null(hostName))
1585 Sys.setenv(ARVADOS_API_HOST = hostName)
1587 if(!is.null(authToken))
1588 Sys.setenv(ARVADOS_API_TOKEN = authToken)
1590 hostName <- Sys.getenv("ARVADOS_API_HOST")
1591 token <- Sys.getenv("ARVADOS_API_TOKEN")
1593 if(hostName == "" | token == "")
1594 stop(paste("Please provide host name and authentification token",
1595 "or set ARVADOS_API_HOST and ARVADOS_API_TOKEN",
1596 "environment variables."))
1598 private$token <- token
1599 private$host <- paste0("https://", hostName, "/arvados/v1/")
1600 private$numRetries <- numRetries
1601 private$REST <- RESTService$new(token, hostName,
1602 HttpRequest$new(), HttpParser$new(),
1607 projects.get = function(uuid)
1609 self$groups.get(uuid)
1612 projects.create = function(group, ensure_unique_name = "false")
1614 group <- c("group_class" = "project", group)
1615 self$groups.create(group, ensure_unique_name)
1618 projects.update = function(group, uuid)
1620 group <- c("group_class" = "project", group)
1621 self$groups.update(group, uuid)
1624 projects.list = function(filters = NULL, where = NULL,
1625 order = NULL, select = NULL, distinct = NULL,
1626 limit = "100", offset = "0", count = "exact",
1627 include_trash = NULL)
1629 filters[[length(filters) + 1]] <- list("group_class", "=", "project")
1630 self$groups.list(filters, where, order, select, distinct,
1631 limit, offset, count, include_trash)
1634 projects.delete = function(uuid)
1636 self$groups.delete(uuid)
1639 api_clients.get = function(uuid)
1641 endPoint <- stringr::str_interp("api_clients/${uuid}")
1642 url <- paste0(private$host, endPoint)
1643 headers <- list(Authorization = paste("Bearer", private$token),
1644 "Content-Type" = "application/json")
1649 response <- private$REST$http$exec("GET", url, headers, body,
1650 queryArgs, private$numRetries)
1651 resource <- private$REST$httpParser$parseJSONResponse(response)
1653 if(!is.null(resource$errors))
1654 stop(resource$errors)
1659 api_clients.create = function(apiclient,
1660 ensure_unique_name = "false", cluster_id = NULL)
1662 endPoint <- stringr::str_interp("api_clients")
1663 url <- paste0(private$host, endPoint)
1664 headers <- list(Authorization = paste("Bearer", private$token),
1665 "Content-Type" = "application/json")
1666 queryArgs <- list(ensure_unique_name = ensure_unique_name,
1667 cluster_id = cluster_id)
1669 if(length(apiclient) > 0)
1670 body <- jsonlite::toJSON(list(apiclient = apiclient),
1675 response <- private$REST$http$exec("POST", url, headers, body,
1676 queryArgs, private$numRetries)
1677 resource <- private$REST$httpParser$parseJSONResponse(response)
1679 if(!is.null(resource$errors))
1680 stop(resource$errors)
1685 api_clients.update = function(apiclient, uuid)
1687 endPoint <- stringr::str_interp("api_clients/${uuid}")
1688 url <- paste0(private$host, endPoint)
1689 headers <- list(Authorization = paste("Bearer", private$token),
1690 "Content-Type" = "application/json")
1693 if(length(apiclient) > 0)
1694 body <- jsonlite::toJSON(list(apiclient = apiclient),
1699 response <- private$REST$http$exec("PUT", url, headers, body,
1700 queryArgs, private$numRetries)
1701 resource <- private$REST$httpParser$parseJSONResponse(response)
1703 if(!is.null(resource$errors))
1704 stop(resource$errors)
1709 api_clients.delete = function(uuid)
1711 endPoint <- stringr::str_interp("api_clients/${uuid}")
1712 url <- paste0(private$host, endPoint)
1713 headers <- list(Authorization = paste("Bearer", private$token),
1714 "Content-Type" = "application/json")
1719 response <- private$REST$http$exec("DELETE", url, headers, body,
1720 queryArgs, private$numRetries)
1721 resource <- private$REST$httpParser$parseJSONResponse(response)
1723 if(!is.null(resource$errors))
1724 stop(resource$errors)
1729 api_clients.list = function(filters = NULL,
1730 where = NULL, order = NULL, select = NULL,
1731 distinct = NULL, limit = "100", offset = "0",
1732 count = "exact", cluster_id = NULL, bypass_federation = NULL)
1734 endPoint <- stringr::str_interp("api_clients")
1735 url <- paste0(private$host, endPoint)
1736 headers <- list(Authorization = paste("Bearer", private$token),
1737 "Content-Type" = "application/json")
1738 queryArgs <- list(filters = filters, where = where,
1739 order = order, select = select, distinct = distinct,
1740 limit = limit, offset = offset, count = count,
1741 cluster_id = cluster_id, bypass_federation = bypass_federation)
1745 response <- private$REST$http$exec("GET", url, headers, body,
1746 queryArgs, private$numRetries)
1747 resource <- private$REST$httpParser$parseJSONResponse(response)
1749 if(!is.null(resource$errors))
1750 stop(resource$errors)
1755 api_client_authorizations.get = function(uuid)
1757 endPoint <- stringr::str_interp("api_client_authorizations/${uuid}")
1758 url <- paste0(private$host, endPoint)
1759 headers <- list(Authorization = paste("Bearer", private$token),
1760 "Content-Type" = "application/json")
1765 response <- private$REST$http$exec("GET", url, headers, body,
1766 queryArgs, private$numRetries)
1767 resource <- private$REST$httpParser$parseJSONResponse(response)
1769 if(!is.null(resource$errors))
1770 stop(resource$errors)
1775 api_client_authorizations.create = function(apiclientauthorization,
1776 ensure_unique_name = "false", cluster_id = NULL)
1778 endPoint <- stringr::str_interp("api_client_authorizations")
1779 url <- paste0(private$host, endPoint)
1780 headers <- list(Authorization = paste("Bearer", private$token),
1781 "Content-Type" = "application/json")
1782 queryArgs <- list(ensure_unique_name = ensure_unique_name,
1783 cluster_id = cluster_id)
1785 if(length(apiclientauthorization) > 0)
1786 body <- jsonlite::toJSON(list(apiclientauthorization = apiclientauthorization),
1791 response <- private$REST$http$exec("POST", url, headers, body,
1792 queryArgs, private$numRetries)
1793 resource <- private$REST$httpParser$parseJSONResponse(response)
1795 if(!is.null(resource$errors))
1796 stop(resource$errors)
1801 api_client_authorizations.update = function(apiclientauthorization, uuid)
1803 endPoint <- stringr::str_interp("api_client_authorizations/${uuid}")
1804 url <- paste0(private$host, endPoint)
1805 headers <- list(Authorization = paste("Bearer", private$token),
1806 "Content-Type" = "application/json")
1809 if(length(apiclientauthorization) > 0)
1810 body <- jsonlite::toJSON(list(apiclientauthorization = apiclientauthorization),
1815 response <- private$REST$http$exec("PUT", url, headers, body,
1816 queryArgs, private$numRetries)
1817 resource <- private$REST$httpParser$parseJSONResponse(response)
1819 if(!is.null(resource$errors))
1820 stop(resource$errors)
1825 api_client_authorizations.delete = function(uuid)
1827 endPoint <- stringr::str_interp("api_client_authorizations/${uuid}")
1828 url <- paste0(private$host, endPoint)
1829 headers <- list(Authorization = paste("Bearer", private$token),
1830 "Content-Type" = "application/json")
1835 response <- private$REST$http$exec("DELETE", url, headers, body,
1836 queryArgs, private$numRetries)
1837 resource <- private$REST$httpParser$parseJSONResponse(response)
1839 if(!is.null(resource$errors))
1840 stop(resource$errors)
1845 api_client_authorizations.create_system_auth = function(api_client_id = NULL, scopes = NULL)
1847 endPoint <- stringr::str_interp("api_client_authorizations/create_system_auth")
1848 url <- paste0(private$host, endPoint)
1849 headers <- list(Authorization = paste("Bearer", private$token),
1850 "Content-Type" = "application/json")
1851 queryArgs <- list(api_client_id = api_client_id,
1856 response <- private$REST$http$exec("POST", url, headers, body,
1857 queryArgs, private$numRetries)
1858 resource <- private$REST$httpParser$parseJSONResponse(response)
1860 if(!is.null(resource$errors))
1861 stop(resource$errors)
1866 api_client_authorizations.current = function()
1868 endPoint <- stringr::str_interp("api_client_authorizations/current")
1869 url <- paste0(private$host, endPoint)
1870 headers <- list(Authorization = paste("Bearer", private$token),
1871 "Content-Type" = "application/json")
1876 response <- private$REST$http$exec("GET", url, headers, body,
1877 queryArgs, private$numRetries)
1878 resource <- private$REST$httpParser$parseJSONResponse(response)
1880 if(!is.null(resource$errors))
1881 stop(resource$errors)
1886 api_client_authorizations.list = function(filters = NULL,
1887 where = NULL, order = NULL, select = NULL,
1888 distinct = NULL, limit = "100", offset = "0",
1889 count = "exact", cluster_id = NULL, bypass_federation = NULL)
1891 endPoint <- stringr::str_interp("api_client_authorizations")
1892 url <- paste0(private$host, endPoint)
1893 headers <- list(Authorization = paste("Bearer", private$token),
1894 "Content-Type" = "application/json")
1895 queryArgs <- list(filters = filters, where = where,
1896 order = order, select = select, distinct = distinct,
1897 limit = limit, offset = offset, count = count,
1898 cluster_id = cluster_id, bypass_federation = bypass_federation)
1902 response <- private$REST$http$exec("GET", url, headers, body,
1903 queryArgs, private$numRetries)
1904 resource <- private$REST$httpParser$parseJSONResponse(response)
1906 if(!is.null(resource$errors))
1907 stop(resource$errors)
1912 authorized_keys.get = function(uuid)
1914 endPoint <- stringr::str_interp("authorized_keys/${uuid}")
1915 url <- paste0(private$host, endPoint)
1916 headers <- list(Authorization = paste("Bearer", private$token),
1917 "Content-Type" = "application/json")
1922 response <- private$REST$http$exec("GET", url, headers, body,
1923 queryArgs, private$numRetries)
1924 resource <- private$REST$httpParser$parseJSONResponse(response)
1926 if(!is.null(resource$errors))
1927 stop(resource$errors)
1932 authorized_keys.create = function(authorizedkey,
1933 ensure_unique_name = "false", cluster_id = NULL)
1935 endPoint <- stringr::str_interp("authorized_keys")
1936 url <- paste0(private$host, endPoint)
1937 headers <- list(Authorization = paste("Bearer", private$token),
1938 "Content-Type" = "application/json")
1939 queryArgs <- list(ensure_unique_name = ensure_unique_name,
1940 cluster_id = cluster_id)
1942 if(length(authorizedkey) > 0)
1943 body <- jsonlite::toJSON(list(authorizedkey = authorizedkey),
1948 response <- private$REST$http$exec("POST", url, headers, body,
1949 queryArgs, private$numRetries)
1950 resource <- private$REST$httpParser$parseJSONResponse(response)
1952 if(!is.null(resource$errors))
1953 stop(resource$errors)
1958 authorized_keys.update = function(authorizedkey, uuid)
1960 endPoint <- stringr::str_interp("authorized_keys/${uuid}")
1961 url <- paste0(private$host, endPoint)
1962 headers <- list(Authorization = paste("Bearer", private$token),
1963 "Content-Type" = "application/json")
1966 if(length(authorizedkey) > 0)
1967 body <- jsonlite::toJSON(list(authorizedkey = authorizedkey),
1972 response <- private$REST$http$exec("PUT", url, headers, body,
1973 queryArgs, private$numRetries)
1974 resource <- private$REST$httpParser$parseJSONResponse(response)
1976 if(!is.null(resource$errors))
1977 stop(resource$errors)
1982 authorized_keys.delete = function(uuid)
1984 endPoint <- stringr::str_interp("authorized_keys/${uuid}")
1985 url <- paste0(private$host, endPoint)
1986 headers <- list(Authorization = paste("Bearer", private$token),
1987 "Content-Type" = "application/json")
1992 response <- private$REST$http$exec("DELETE", url, headers, body,
1993 queryArgs, private$numRetries)
1994 resource <- private$REST$httpParser$parseJSONResponse(response)
1996 if(!is.null(resource$errors))
1997 stop(resource$errors)
2002 authorized_keys.list = function(filters = NULL,
2003 where = NULL, order = NULL, select = NULL,
2004 distinct = NULL, limit = "100", offset = "0",
2005 count = "exact", cluster_id = NULL, bypass_federation = NULL)
2007 endPoint <- stringr::str_interp("authorized_keys")
2008 url <- paste0(private$host, endPoint)
2009 headers <- list(Authorization = paste("Bearer", private$token),
2010 "Content-Type" = "application/json")
2011 queryArgs <- list(filters = filters, where = where,
2012 order = order, select = select, distinct = distinct,
2013 limit = limit, offset = offset, count = count,
2014 cluster_id = cluster_id, bypass_federation = bypass_federation)
2018 response <- private$REST$http$exec("GET", url, headers, body,
2019 queryArgs, private$numRetries)
2020 resource <- private$REST$httpParser$parseJSONResponse(response)
2022 if(!is.null(resource$errors))
2023 stop(resource$errors)
2028 collections.get = function(uuid)
2030 endPoint <- stringr::str_interp("collections/${uuid}")
2031 url <- paste0(private$host, endPoint)
2032 headers <- list(Authorization = paste("Bearer", private$token),
2033 "Content-Type" = "application/json")
2038 response <- private$REST$http$exec("GET", url, headers, body,
2039 queryArgs, private$numRetries)
2040 resource <- private$REST$httpParser$parseJSONResponse(response)
2042 if(!is.null(resource$errors))
2043 stop(resource$errors)
2048 collections.create = function(collection,
2049 ensure_unique_name = "false", cluster_id = NULL)
2051 endPoint <- stringr::str_interp("collections")
2052 url <- paste0(private$host, endPoint)
2053 headers <- list(Authorization = paste("Bearer", private$token),
2054 "Content-Type" = "application/json")
2055 queryArgs <- list(ensure_unique_name = ensure_unique_name,
2056 cluster_id = cluster_id)
2058 if(length(collection) > 0)
2059 body <- jsonlite::toJSON(list(collection = collection),
2064 response <- private$REST$http$exec("POST", url, headers, body,
2065 queryArgs, private$numRetries)
2066 resource <- private$REST$httpParser$parseJSONResponse(response)
2068 if(!is.null(resource$errors))
2069 stop(resource$errors)
2074 collections.update = function(collection, uuid)
2076 endPoint <- stringr::str_interp("collections/${uuid}")
2077 url <- paste0(private$host, endPoint)
2078 headers <- list(Authorization = paste("Bearer", private$token),
2079 "Content-Type" = "application/json")
2082 if(length(collection) > 0)
2083 body <- jsonlite::toJSON(list(collection = collection),
2088 response <- private$REST$http$exec("PUT", url, headers, body,
2089 queryArgs, private$numRetries)
2090 resource <- private$REST$httpParser$parseJSONResponse(response)
2092 if(!is.null(resource$errors))
2093 stop(resource$errors)
2098 collections.delete = function(uuid)
2100 endPoint <- stringr::str_interp("collections/${uuid}")
2101 url <- paste0(private$host, endPoint)
2102 headers <- list(Authorization = paste("Bearer", private$token),
2103 "Content-Type" = "application/json")
2108 response <- private$REST$http$exec("DELETE", url, headers, body,
2109 queryArgs, private$numRetries)
2110 resource <- private$REST$httpParser$parseJSONResponse(response)
2112 if(!is.null(resource$errors))
2113 stop(resource$errors)
2118 collections.provenance = function(uuid)
2120 endPoint <- stringr::str_interp("collections/${uuid}/provenance")
2121 url <- paste0(private$host, endPoint)
2122 headers <- list(Authorization = paste("Bearer", private$token),
2123 "Content-Type" = "application/json")
2128 response <- private$REST$http$exec("GET", url, headers, body,
2129 queryArgs, private$numRetries)
2130 resource <- private$REST$httpParser$parseJSONResponse(response)
2132 if(!is.null(resource$errors))
2133 stop(resource$errors)
2138 collections.used_by = function(uuid)
2140 endPoint <- stringr::str_interp("collections/${uuid}/used_by")
2141 url <- paste0(private$host, endPoint)
2142 headers <- list(Authorization = paste("Bearer", private$token),
2143 "Content-Type" = "application/json")
2148 response <- private$REST$http$exec("GET", url, headers, body,
2149 queryArgs, private$numRetries)
2150 resource <- private$REST$httpParser$parseJSONResponse(response)
2152 if(!is.null(resource$errors))
2153 stop(resource$errors)
2158 collections.trash = function(uuid)
2160 endPoint <- stringr::str_interp("collections/${uuid}/trash")
2161 url <- paste0(private$host, endPoint)
2162 headers <- list(Authorization = paste("Bearer", private$token),
2163 "Content-Type" = "application/json")
2168 response <- private$REST$http$exec("POST", url, headers, body,
2169 queryArgs, private$numRetries)
2170 resource <- private$REST$httpParser$parseJSONResponse(response)
2172 if(!is.null(resource$errors))
2173 stop(resource$errors)
2178 collections.untrash = function(uuid)
2180 endPoint <- stringr::str_interp("collections/${uuid}/untrash")
2181 url <- paste0(private$host, endPoint)
2182 headers <- list(Authorization = paste("Bearer", private$token),
2183 "Content-Type" = "application/json")
2188 response <- private$REST$http$exec("POST", url, headers, body,
2189 queryArgs, private$numRetries)
2190 resource <- private$REST$httpParser$parseJSONResponse(response)
2192 if(!is.null(resource$errors))
2193 stop(resource$errors)
2198 collections.list = function(filters = NULL,
2199 where = NULL, order = NULL, select = NULL,
2200 distinct = NULL, limit = "100", offset = "0",
2201 count = "exact", cluster_id = NULL, bypass_federation = NULL,
2202 include_trash = NULL, include_old_versions = NULL)
2204 endPoint <- stringr::str_interp("collections")
2205 url <- paste0(private$host, endPoint)
2206 headers <- list(Authorization = paste("Bearer", private$token),
2207 "Content-Type" = "application/json")
2208 queryArgs <- list(filters = filters, where = where,
2209 order = order, select = select, distinct = distinct,
2210 limit = limit, offset = offset, count = count,
2211 cluster_id = cluster_id, bypass_federation = bypass_federation,
2212 include_trash = include_trash, include_old_versions = include_old_versions)
2216 response <- private$REST$http$exec("GET", url, headers, body,
2217 queryArgs, private$numRetries)
2218 resource <- private$REST$httpParser$parseJSONResponse(response)
2220 if(!is.null(resource$errors))
2221 stop(resource$errors)
2226 containers.get = function(uuid)
2228 endPoint <- stringr::str_interp("containers/${uuid}")
2229 url <- paste0(private$host, endPoint)
2230 headers <- list(Authorization = paste("Bearer", private$token),
2231 "Content-Type" = "application/json")
2236 response <- private$REST$http$exec("GET", url, headers, body,
2237 queryArgs, private$numRetries)
2238 resource <- private$REST$httpParser$parseJSONResponse(response)
2240 if(!is.null(resource$errors))
2241 stop(resource$errors)
2246 containers.create = function(container, ensure_unique_name = "false",
2249 endPoint <- stringr::str_interp("containers")
2250 url <- paste0(private$host, endPoint)
2251 headers <- list(Authorization = paste("Bearer", private$token),
2252 "Content-Type" = "application/json")
2253 queryArgs <- list(ensure_unique_name = ensure_unique_name,
2254 cluster_id = cluster_id)
2256 if(length(container) > 0)
2257 body <- jsonlite::toJSON(list(container = container),
2262 response <- private$REST$http$exec("POST", url, headers, body,
2263 queryArgs, private$numRetries)
2264 resource <- private$REST$httpParser$parseJSONResponse(response)
2266 if(!is.null(resource$errors))
2267 stop(resource$errors)
2272 containers.update = function(container, uuid)
2274 endPoint <- stringr::str_interp("containers/${uuid}")
2275 url <- paste0(private$host, endPoint)
2276 headers <- list(Authorization = paste("Bearer", private$token),
2277 "Content-Type" = "application/json")
2280 if(length(container) > 0)
2281 body <- jsonlite::toJSON(list(container = container),
2286 response <- private$REST$http$exec("PUT", url, headers, body,
2287 queryArgs, private$numRetries)
2288 resource <- private$REST$httpParser$parseJSONResponse(response)
2290 if(!is.null(resource$errors))
2291 stop(resource$errors)
2296 containers.delete = function(uuid)
2298 endPoint <- stringr::str_interp("containers/${uuid}")
2299 url <- paste0(private$host, endPoint)
2300 headers <- list(Authorization = paste("Bearer", private$token),
2301 "Content-Type" = "application/json")
2306 response <- private$REST$http$exec("DELETE", url, headers, body,
2307 queryArgs, private$numRetries)
2308 resource <- private$REST$httpParser$parseJSONResponse(response)
2310 if(!is.null(resource$errors))
2311 stop(resource$errors)
2316 containers.auth = function(uuid)
2318 endPoint <- stringr::str_interp("containers/${uuid}/auth")
2319 url <- paste0(private$host, endPoint)
2320 headers <- list(Authorization = paste("Bearer", private$token),
2321 "Content-Type" = "application/json")
2326 response <- private$REST$http$exec("GET", url, headers, body,
2327 queryArgs, private$numRetries)
2328 resource <- private$REST$httpParser$parseJSONResponse(response)
2330 if(!is.null(resource$errors))
2331 stop(resource$errors)
2336 containers.lock = function(uuid)
2338 endPoint <- stringr::str_interp("containers/${uuid}/lock")
2339 url <- paste0(private$host, endPoint)
2340 headers <- list(Authorization = paste("Bearer", private$token),
2341 "Content-Type" = "application/json")
2346 response <- private$REST$http$exec("POST", url, headers, body,
2347 queryArgs, private$numRetries)
2348 resource <- private$REST$httpParser$parseJSONResponse(response)
2350 if(!is.null(resource$errors))
2351 stop(resource$errors)
2356 containers.unlock = function(uuid)
2358 endPoint <- stringr::str_interp("containers/${uuid}/unlock")
2359 url <- paste0(private$host, endPoint)
2360 headers <- list(Authorization = paste("Bearer", private$token),
2361 "Content-Type" = "application/json")
2366 response <- private$REST$http$exec("POST", url, headers, body,
2367 queryArgs, private$numRetries)
2368 resource <- private$REST$httpParser$parseJSONResponse(response)
2370 if(!is.null(resource$errors))
2371 stop(resource$errors)
2376 containers.secret_mounts = function(uuid)
2378 endPoint <- stringr::str_interp("containers/${uuid}/secret_mounts")
2379 url <- paste0(private$host, endPoint)
2380 headers <- list(Authorization = paste("Bearer", private$token),
2381 "Content-Type" = "application/json")
2386 response <- private$REST$http$exec("GET", url, headers, body,
2387 queryArgs, private$numRetries)
2388 resource <- private$REST$httpParser$parseJSONResponse(response)
2390 if(!is.null(resource$errors))
2391 stop(resource$errors)
2396 containers.current = function()
2398 endPoint <- stringr::str_interp("containers/current")
2399 url <- paste0(private$host, endPoint)
2400 headers <- list(Authorization = paste("Bearer", private$token),
2401 "Content-Type" = "application/json")
2406 response <- private$REST$http$exec("GET", url, headers, body,
2407 queryArgs, private$numRetries)
2408 resource <- private$REST$httpParser$parseJSONResponse(response)
2410 if(!is.null(resource$errors))
2411 stop(resource$errors)
2416 containers.list = function(filters = NULL,
2417 where = NULL, order = NULL, select = NULL,
2418 distinct = NULL, limit = "100", offset = "0",
2419 count = "exact", cluster_id = NULL, bypass_federation = NULL)
2421 endPoint <- stringr::str_interp("containers")
2422 url <- paste0(private$host, endPoint)
2423 headers <- list(Authorization = paste("Bearer", private$token),
2424 "Content-Type" = "application/json")
2425 queryArgs <- list(filters = filters, where = where,
2426 order = order, select = select, distinct = distinct,
2427 limit = limit, offset = offset, count = count,
2428 cluster_id = cluster_id, bypass_federation = bypass_federation)
2432 response <- private$REST$http$exec("GET", url, headers, body,
2433 queryArgs, private$numRetries)
2434 resource <- private$REST$httpParser$parseJSONResponse(response)
2436 if(!is.null(resource$errors))
2437 stop(resource$errors)
2442 container_requests.get = function(uuid)
2444 endPoint <- stringr::str_interp("container_requests/${uuid}")
2445 url <- paste0(private$host, endPoint)
2446 headers <- list(Authorization = paste("Bearer", private$token),
2447 "Content-Type" = "application/json")
2452 response <- private$REST$http$exec("GET", url, headers, body,
2453 queryArgs, private$numRetries)
2454 resource <- private$REST$httpParser$parseJSONResponse(response)
2456 if(!is.null(resource$errors))
2457 stop(resource$errors)
2462 container_requests.create = function(containerrequest,
2463 ensure_unique_name = "false", cluster_id = NULL)
2465 endPoint <- stringr::str_interp("container_requests")
2466 url <- paste0(private$host, endPoint)
2467 headers <- list(Authorization = paste("Bearer", private$token),
2468 "Content-Type" = "application/json")
2469 queryArgs <- list(ensure_unique_name = ensure_unique_name,
2470 cluster_id = cluster_id)
2472 if(length(containerrequest) > 0)
2473 body <- jsonlite::toJSON(list(containerrequest = containerrequest),
2478 response <- private$REST$http$exec("POST", url, headers, body,
2479 queryArgs, private$numRetries)
2480 resource <- private$REST$httpParser$parseJSONResponse(response)
2482 if(!is.null(resource$errors))
2483 stop(resource$errors)
2488 container_requests.update = function(containerrequest, uuid)
2490 endPoint <- stringr::str_interp("container_requests/${uuid}")
2491 url <- paste0(private$host, endPoint)
2492 headers <- list(Authorization = paste("Bearer", private$token),
2493 "Content-Type" = "application/json")
2496 if(length(containerrequest) > 0)
2497 body <- jsonlite::toJSON(list(containerrequest = containerrequest),
2502 response <- private$REST$http$exec("PUT", url, headers, body,
2503 queryArgs, private$numRetries)
2504 resource <- private$REST$httpParser$parseJSONResponse(response)
2506 if(!is.null(resource$errors))
2507 stop(resource$errors)
2512 container_requests.delete = function(uuid)
2514 endPoint <- stringr::str_interp("container_requests/${uuid}")
2515 url <- paste0(private$host, endPoint)
2516 headers <- list(Authorization = paste("Bearer", private$token),
2517 "Content-Type" = "application/json")
2522 response <- private$REST$http$exec("DELETE", url, headers, body,
2523 queryArgs, private$numRetries)
2524 resource <- private$REST$httpParser$parseJSONResponse(response)
2526 if(!is.null(resource$errors))
2527 stop(resource$errors)
2532 container_requests.list = function(filters = NULL,
2533 where = NULL, order = NULL, select = NULL,
2534 distinct = NULL, limit = "100", offset = "0",
2535 count = "exact", cluster_id = NULL, bypass_federation = NULL,
2536 include_trash = NULL)
2538 endPoint <- stringr::str_interp("container_requests")
2539 url <- paste0(private$host, endPoint)
2540 headers <- list(Authorization = paste("Bearer", private$token),
2541 "Content-Type" = "application/json")
2542 queryArgs <- list(filters = filters, where = where,
2543 order = order, select = select, distinct = distinct,
2544 limit = limit, offset = offset, count = count,
2545 cluster_id = cluster_id, bypass_federation = bypass_federation,
2546 include_trash = include_trash)
2550 response <- private$REST$http$exec("GET", url, headers, body,
2551 queryArgs, private$numRetries)
2552 resource <- private$REST$httpParser$parseJSONResponse(response)
2554 if(!is.null(resource$errors))
2555 stop(resource$errors)
2560 groups.get = function(uuid)
2562 endPoint <- stringr::str_interp("groups/${uuid}")
2563 url <- paste0(private$host, endPoint)
2564 headers <- list(Authorization = paste("Bearer", private$token),
2565 "Content-Type" = "application/json")
2570 response <- private$REST$http$exec("GET", url, headers, body,
2571 queryArgs, private$numRetries)
2572 resource <- private$REST$httpParser$parseJSONResponse(response)
2574 if(!is.null(resource$errors))
2575 stop(resource$errors)
2580 groups.create = function(group, ensure_unique_name = "false",
2581 cluster_id = NULL, async = "false")
2583 endPoint <- stringr::str_interp("groups")
2584 url <- paste0(private$host, endPoint)
2585 headers <- list(Authorization = paste("Bearer", private$token),
2586 "Content-Type" = "application/json")
2587 queryArgs <- list(ensure_unique_name = ensure_unique_name,
2588 cluster_id = cluster_id, async = async)
2590 if(length(group) > 0)
2591 body <- jsonlite::toJSON(list(group = group),
2596 response <- private$REST$http$exec("POST", url, headers, body,
2597 queryArgs, private$numRetries)
2598 resource <- private$REST$httpParser$parseJSONResponse(response)
2600 if(!is.null(resource$errors))
2601 stop(resource$errors)
2606 groups.update = function(group, uuid, async = "false")
2608 endPoint <- stringr::str_interp("groups/${uuid}")
2609 url <- paste0(private$host, endPoint)
2610 headers <- list(Authorization = paste("Bearer", private$token),
2611 "Content-Type" = "application/json")
2612 queryArgs <- list(async = async)
2614 if(length(group) > 0)
2615 body <- jsonlite::toJSON(list(group = group),
2620 response <- private$REST$http$exec("PUT", url, headers, body,
2621 queryArgs, private$numRetries)
2622 resource <- private$REST$httpParser$parseJSONResponse(response)
2624 if(!is.null(resource$errors))
2625 stop(resource$errors)
2630 groups.delete = function(uuid)
2632 endPoint <- stringr::str_interp("groups/${uuid}")
2633 url <- paste0(private$host, endPoint)
2634 headers <- list(Authorization = paste("Bearer", private$token),
2635 "Content-Type" = "application/json")
2640 response <- private$REST$http$exec("DELETE", url, headers, body,
2641 queryArgs, private$numRetries)
2642 resource <- private$REST$httpParser$parseJSONResponse(response)
2644 if(!is.null(resource$errors))
2645 stop(resource$errors)
2650 groups.contents = function(filters = NULL,
2651 where = NULL, order = NULL, distinct = NULL,
2652 limit = "100", offset = "0", count = "exact",
2653 cluster_id = NULL, bypass_federation = NULL,
2654 include_trash = NULL, uuid = NULL, recursive = NULL,
2657 endPoint <- stringr::str_interp("groups/contents")
2658 url <- paste0(private$host, endPoint)
2659 headers <- list(Authorization = paste("Bearer", private$token),
2660 "Content-Type" = "application/json")
2661 queryArgs <- list(filters = filters, where = where,
2662 order = order, distinct = distinct, limit = limit,
2663 offset = offset, count = count, cluster_id = cluster_id,
2664 bypass_federation = bypass_federation, include_trash = include_trash,
2665 uuid = uuid, recursive = recursive, include = include)
2669 response <- private$REST$http$exec("GET", url, headers, body,
2670 queryArgs, private$numRetries)
2671 resource <- private$REST$httpParser$parseJSONResponse(response)
2673 if(!is.null(resource$errors))
2674 stop(resource$errors)
2679 groups.shared = function(filters = NULL,
2680 where = NULL, order = NULL, select = NULL,
2681 distinct = NULL, limit = "100", offset = "0",
2682 count = "exact", cluster_id = NULL, bypass_federation = NULL,
2683 include_trash = NULL, include = NULL)
2685 endPoint <- stringr::str_interp("groups/shared")
2686 url <- paste0(private$host, endPoint)
2687 headers <- list(Authorization = paste("Bearer", private$token),
2688 "Content-Type" = "application/json")
2689 queryArgs <- list(filters = filters, where = where,
2690 order = order, select = select, distinct = distinct,
2691 limit = limit, offset = offset, count = count,
2692 cluster_id = cluster_id, bypass_federation = bypass_federation,
2693 include_trash = include_trash, include = include)
2697 response <- private$REST$http$exec("GET", url, headers, body,
2698 queryArgs, private$numRetries)
2699 resource <- private$REST$httpParser$parseJSONResponse(response)
2701 if(!is.null(resource$errors))
2702 stop(resource$errors)
2707 groups.trash = function(uuid)
2709 endPoint <- stringr::str_interp("groups/${uuid}/trash")
2710 url <- paste0(private$host, endPoint)
2711 headers <- list(Authorization = paste("Bearer", private$token),
2712 "Content-Type" = "application/json")
2717 response <- private$REST$http$exec("POST", url, headers, body,
2718 queryArgs, private$numRetries)
2719 resource <- private$REST$httpParser$parseJSONResponse(response)
2721 if(!is.null(resource$errors))
2722 stop(resource$errors)
2727 groups.untrash = function(uuid)
2729 endPoint <- stringr::str_interp("groups/${uuid}/untrash")
2730 url <- paste0(private$host, endPoint)
2731 headers <- list(Authorization = paste("Bearer", private$token),
2732 "Content-Type" = "application/json")
2737 response <- private$REST$http$exec("POST", url, headers, body,
2738 queryArgs, private$numRetries)
2739 resource <- private$REST$httpParser$parseJSONResponse(response)
2741 if(!is.null(resource$errors))
2742 stop(resource$errors)
2747 groups.list = function(filters = NULL, where = NULL,
2748 order = NULL, select = NULL, distinct = NULL,
2749 limit = "100", offset = "0", count = "exact",
2750 cluster_id = NULL, bypass_federation = NULL,
2751 include_trash = NULL)
2753 endPoint <- stringr::str_interp("groups")
2754 url <- paste0(private$host, endPoint)
2755 headers <- list(Authorization = paste("Bearer", private$token),
2756 "Content-Type" = "application/json")
2757 queryArgs <- list(filters = filters, where = where,
2758 order = order, select = select, distinct = distinct,
2759 limit = limit, offset = offset, count = count,
2760 cluster_id = cluster_id, bypass_federation = bypass_federation,
2761 include_trash = include_trash)
2765 response <- private$REST$http$exec("GET", url, headers, body,
2766 queryArgs, private$numRetries)
2767 resource <- private$REST$httpParser$parseJSONResponse(response)
2769 if(!is.null(resource$errors))
2770 stop(resource$errors)
2775 keep_services.get = function(uuid)
2777 endPoint <- stringr::str_interp("keep_services/${uuid}")
2778 url <- paste0(private$host, endPoint)
2779 headers <- list(Authorization = paste("Bearer", private$token),
2780 "Content-Type" = "application/json")
2785 response <- private$REST$http$exec("GET", url, headers, body,
2786 queryArgs, private$numRetries)
2787 resource <- private$REST$httpParser$parseJSONResponse(response)
2789 if(!is.null(resource$errors))
2790 stop(resource$errors)
2795 keep_services.create = function(keepservice,
2796 ensure_unique_name = "false", cluster_id = NULL)
2798 endPoint <- stringr::str_interp("keep_services")
2799 url <- paste0(private$host, endPoint)
2800 headers <- list(Authorization = paste("Bearer", private$token),
2801 "Content-Type" = "application/json")
2802 queryArgs <- list(ensure_unique_name = ensure_unique_name,
2803 cluster_id = cluster_id)
2805 if(length(keepservice) > 0)
2806 body <- jsonlite::toJSON(list(keepservice = keepservice),
2811 response <- private$REST$http$exec("POST", url, headers, body,
2812 queryArgs, private$numRetries)
2813 resource <- private$REST$httpParser$parseJSONResponse(response)
2815 if(!is.null(resource$errors))
2816 stop(resource$errors)
2821 keep_services.update = function(keepservice, uuid)
2823 endPoint <- stringr::str_interp("keep_services/${uuid}")
2824 url <- paste0(private$host, endPoint)
2825 headers <- list(Authorization = paste("Bearer", private$token),
2826 "Content-Type" = "application/json")
2829 if(length(keepservice) > 0)
2830 body <- jsonlite::toJSON(list(keepservice = keepservice),
2835 response <- private$REST$http$exec("PUT", url, headers, body,
2836 queryArgs, private$numRetries)
2837 resource <- private$REST$httpParser$parseJSONResponse(response)
2839 if(!is.null(resource$errors))
2840 stop(resource$errors)
2845 keep_services.delete = function(uuid)
2847 endPoint <- stringr::str_interp("keep_services/${uuid}")
2848 url <- paste0(private$host, endPoint)
2849 headers <- list(Authorization = paste("Bearer", private$token),
2850 "Content-Type" = "application/json")
2855 response <- private$REST$http$exec("DELETE", url, headers, body,
2856 queryArgs, private$numRetries)
2857 resource <- private$REST$httpParser$parseJSONResponse(response)
2859 if(!is.null(resource$errors))
2860 stop(resource$errors)
2865 keep_services.accessible = function()
2867 endPoint <- stringr::str_interp("keep_services/accessible")
2868 url <- paste0(private$host, endPoint)
2869 headers <- list(Authorization = paste("Bearer", private$token),
2870 "Content-Type" = "application/json")
2875 response <- private$REST$http$exec("GET", url, headers, body,
2876 queryArgs, private$numRetries)
2877 resource <- private$REST$httpParser$parseJSONResponse(response)
2879 if(!is.null(resource$errors))
2880 stop(resource$errors)
2885 keep_services.list = function(filters = NULL,
2886 where = NULL, order = NULL, select = NULL,
2887 distinct = NULL, limit = "100", offset = "0",
2888 count = "exact", cluster_id = NULL, bypass_federation = NULL)
2890 endPoint <- stringr::str_interp("keep_services")
2891 url <- paste0(private$host, endPoint)
2892 headers <- list(Authorization = paste("Bearer", private$token),
2893 "Content-Type" = "application/json")
2894 queryArgs <- list(filters = filters, where = where,
2895 order = order, select = select, distinct = distinct,
2896 limit = limit, offset = offset, count = count,
2897 cluster_id = cluster_id, bypass_federation = bypass_federation)
2901 response <- private$REST$http$exec("GET", url, headers, body,
2902 queryArgs, private$numRetries)
2903 resource <- private$REST$httpParser$parseJSONResponse(response)
2905 if(!is.null(resource$errors))
2906 stop(resource$errors)
2911 links.get = function(uuid)
2913 endPoint <- stringr::str_interp("links/${uuid}")
2914 url <- paste0(private$host, endPoint)
2915 headers <- list(Authorization = paste("Bearer", private$token),
2916 "Content-Type" = "application/json")
2921 response <- private$REST$http$exec("GET", url, headers, body,
2922 queryArgs, private$numRetries)
2923 resource <- private$REST$httpParser$parseJSONResponse(response)
2925 if(!is.null(resource$errors))
2926 stop(resource$errors)
2931 links.create = function(link, ensure_unique_name = "false",
2934 endPoint <- stringr::str_interp("links")
2935 url <- paste0(private$host, endPoint)
2936 headers <- list(Authorization = paste("Bearer", private$token),
2937 "Content-Type" = "application/json")
2938 queryArgs <- list(ensure_unique_name = ensure_unique_name,
2939 cluster_id = cluster_id)
2941 if(length(link) > 0)
2942 body <- jsonlite::toJSON(list(link = link),
2947 response <- private$REST$http$exec("POST", url, headers, body,
2948 queryArgs, private$numRetries)
2949 resource <- private$REST$httpParser$parseJSONResponse(response)
2951 if(!is.null(resource$errors))
2952 stop(resource$errors)
2957 links.update = function(link, uuid)
2959 endPoint <- stringr::str_interp("links/${uuid}")
2960 url <- paste0(private$host, endPoint)
2961 headers <- list(Authorization = paste("Bearer", private$token),
2962 "Content-Type" = "application/json")
2965 if(length(link) > 0)
2966 body <- jsonlite::toJSON(list(link = link),
2971 response <- private$REST$http$exec("PUT", url, headers, body,
2972 queryArgs, private$numRetries)
2973 resource <- private$REST$httpParser$parseJSONResponse(response)
2975 if(!is.null(resource$errors))
2976 stop(resource$errors)
2981 links.delete = function(uuid)
2983 endPoint <- stringr::str_interp("links/${uuid}")
2984 url <- paste0(private$host, endPoint)
2985 headers <- list(Authorization = paste("Bearer", private$token),
2986 "Content-Type" = "application/json")
2991 response <- private$REST$http$exec("DELETE", url, headers, body,
2992 queryArgs, private$numRetries)
2993 resource <- private$REST$httpParser$parseJSONResponse(response)
2995 if(!is.null(resource$errors))
2996 stop(resource$errors)
3001 links.list = function(filters = NULL, where = NULL,
3002 order = NULL, select = NULL, distinct = NULL,
3003 limit = "100", offset = "0", count = "exact",
3004 cluster_id = NULL, bypass_federation = NULL)
3006 endPoint <- stringr::str_interp("links")
3007 url <- paste0(private$host, endPoint)
3008 headers <- list(Authorization = paste("Bearer", private$token),
3009 "Content-Type" = "application/json")
3010 queryArgs <- list(filters = filters, where = where,
3011 order = order, select = select, distinct = distinct,
3012 limit = limit, offset = offset, count = count,
3013 cluster_id = cluster_id, bypass_federation = bypass_federation)
3017 response <- private$REST$http$exec("GET", url, headers, body,
3018 queryArgs, private$numRetries)
3019 resource <- private$REST$httpParser$parseJSONResponse(response)
3021 if(!is.null(resource$errors))
3022 stop(resource$errors)
3027 links.get_permissions = function(uuid)
3029 endPoint <- stringr::str_interp("permissions/${uuid}")
3030 url <- paste0(private$host, endPoint)
3031 headers <- list(Authorization = paste("Bearer", private$token),
3032 "Content-Type" = "application/json")
3037 response <- private$REST$http$exec("GET", url, headers, body,
3038 queryArgs, private$numRetries)
3039 resource <- private$REST$httpParser$parseJSONResponse(response)
3041 if(!is.null(resource$errors))
3042 stop(resource$errors)
3047 logs.get = function(uuid)
3049 endPoint <- stringr::str_interp("logs/${uuid}")
3050 url <- paste0(private$host, endPoint)
3051 headers <- list(Authorization = paste("Bearer", private$token),
3052 "Content-Type" = "application/json")
3057 response <- private$REST$http$exec("GET", url, headers, body,
3058 queryArgs, private$numRetries)
3059 resource <- private$REST$httpParser$parseJSONResponse(response)
3061 if(!is.null(resource$errors))
3062 stop(resource$errors)
3067 logs.create = function(log, ensure_unique_name = "false",
3070 endPoint <- stringr::str_interp("logs")
3071 url <- paste0(private$host, endPoint)
3072 headers <- list(Authorization = paste("Bearer", private$token),
3073 "Content-Type" = "application/json")
3074 queryArgs <- list(ensure_unique_name = ensure_unique_name,
3075 cluster_id = cluster_id)
3078 body <- jsonlite::toJSON(list(log = log),
3083 response <- private$REST$http$exec("POST", url, headers, body,
3084 queryArgs, private$numRetries)
3085 resource <- private$REST$httpParser$parseJSONResponse(response)
3087 if(!is.null(resource$errors))
3088 stop(resource$errors)
3093 logs.update = function(log, uuid)
3095 endPoint <- stringr::str_interp("logs/${uuid}")
3096 url <- paste0(private$host, endPoint)
3097 headers <- list(Authorization = paste("Bearer", private$token),
3098 "Content-Type" = "application/json")
3102 body <- jsonlite::toJSON(list(log = log),
3107 response <- private$REST$http$exec("PUT", url, headers, body,
3108 queryArgs, private$numRetries)
3109 resource <- private$REST$httpParser$parseJSONResponse(response)
3111 if(!is.null(resource$errors))
3112 stop(resource$errors)
3117 logs.delete = function(uuid)
3119 endPoint <- stringr::str_interp("logs/${uuid}")
3120 url <- paste0(private$host, endPoint)
3121 headers <- list(Authorization = paste("Bearer", private$token),
3122 "Content-Type" = "application/json")
3127 response <- private$REST$http$exec("DELETE", url, headers, body,
3128 queryArgs, private$numRetries)
3129 resource <- private$REST$httpParser$parseJSONResponse(response)
3131 if(!is.null(resource$errors))
3132 stop(resource$errors)
3137 logs.list = function(filters = NULL, where = NULL,
3138 order = NULL, select = NULL, distinct = NULL,
3139 limit = "100", offset = "0", count = "exact",
3140 cluster_id = NULL, bypass_federation = NULL)
3142 endPoint <- stringr::str_interp("logs")
3143 url <- paste0(private$host, endPoint)
3144 headers <- list(Authorization = paste("Bearer", private$token),
3145 "Content-Type" = "application/json")
3146 queryArgs <- list(filters = filters, where = where,
3147 order = order, select = select, distinct = distinct,
3148 limit = limit, offset = offset, count = count,
3149 cluster_id = cluster_id, bypass_federation = bypass_federation)
3153 response <- private$REST$http$exec("GET", url, headers, body,
3154 queryArgs, private$numRetries)
3155 resource <- private$REST$httpParser$parseJSONResponse(response)
3157 if(!is.null(resource$errors))
3158 stop(resource$errors)
3163 users.get = function(uuid)
3165 endPoint <- stringr::str_interp("users/${uuid}")
3166 url <- paste0(private$host, endPoint)
3167 headers <- list(Authorization = paste("Bearer", private$token),
3168 "Content-Type" = "application/json")
3173 response <- private$REST$http$exec("GET", url, headers, body,
3174 queryArgs, private$numRetries)
3175 resource <- private$REST$httpParser$parseJSONResponse(response)
3177 if(!is.null(resource$errors))
3178 stop(resource$errors)
3183 users.create = function(user, ensure_unique_name = "false",
3186 endPoint <- stringr::str_interp("users")
3187 url <- paste0(private$host, endPoint)
3188 headers <- list(Authorization = paste("Bearer", private$token),
3189 "Content-Type" = "application/json")
3190 queryArgs <- list(ensure_unique_name = ensure_unique_name,
3191 cluster_id = cluster_id)
3193 if(length(user) > 0)
3194 body <- jsonlite::toJSON(list(user = user),
3199 response <- private$REST$http$exec("POST", url, headers, body,
3200 queryArgs, private$numRetries)
3201 resource <- private$REST$httpParser$parseJSONResponse(response)
3203 if(!is.null(resource$errors))
3204 stop(resource$errors)
3209 users.update = function(user, uuid, bypass_federation = NULL)
3211 endPoint <- stringr::str_interp("users/${uuid}")
3212 url <- paste0(private$host, endPoint)
3213 headers <- list(Authorization = paste("Bearer", private$token),
3214 "Content-Type" = "application/json")
3215 queryArgs <- list(bypass_federation = bypass_federation)
3217 if(length(user) > 0)
3218 body <- jsonlite::toJSON(list(user = user),
3223 response <- private$REST$http$exec("PUT", url, headers, body,
3224 queryArgs, private$numRetries)
3225 resource <- private$REST$httpParser$parseJSONResponse(response)
3227 if(!is.null(resource$errors))
3228 stop(resource$errors)
3233 users.delete = function(uuid)
3235 endPoint <- stringr::str_interp("users/${uuid}")
3236 url <- paste0(private$host, endPoint)
3237 headers <- list(Authorization = paste("Bearer", private$token),
3238 "Content-Type" = "application/json")
3243 response <- private$REST$http$exec("DELETE", url, headers, body,
3244 queryArgs, private$numRetries)
3245 resource <- private$REST$httpParser$parseJSONResponse(response)
3247 if(!is.null(resource$errors))
3248 stop(resource$errors)
3253 users.current = function()
3255 endPoint <- stringr::str_interp("users/current")
3256 url <- paste0(private$host, endPoint)
3257 headers <- list(Authorization = paste("Bearer", private$token),
3258 "Content-Type" = "application/json")
3263 response <- private$REST$http$exec("GET", url, headers, body,
3264 queryArgs, private$numRetries)
3265 resource <- private$REST$httpParser$parseJSONResponse(response)
3267 if(!is.null(resource$errors))
3268 stop(resource$errors)
3273 users.system = function()
3275 endPoint <- stringr::str_interp("users/system")
3276 url <- paste0(private$host, endPoint)
3277 headers <- list(Authorization = paste("Bearer", private$token),
3278 "Content-Type" = "application/json")
3283 response <- private$REST$http$exec("GET", url, headers, body,
3284 queryArgs, private$numRetries)
3285 resource <- private$REST$httpParser$parseJSONResponse(response)
3287 if(!is.null(resource$errors))
3288 stop(resource$errors)
3293 users.activate = function(uuid)
3295 endPoint <- stringr::str_interp("users/${uuid}/activate")
3296 url <- paste0(private$host, endPoint)
3297 headers <- list(Authorization = paste("Bearer", private$token),
3298 "Content-Type" = "application/json")
3303 response <- private$REST$http$exec("POST", url, headers, body,
3304 queryArgs, private$numRetries)
3305 resource <- private$REST$httpParser$parseJSONResponse(response)
3307 if(!is.null(resource$errors))
3308 stop(resource$errors)
3313 users.setup = function(uuid = NULL, user = NULL,
3314 repo_name = NULL, vm_uuid = NULL, send_notification_email = "false")
3316 endPoint <- stringr::str_interp("users/setup")
3317 url <- paste0(private$host, endPoint)
3318 headers <- list(Authorization = paste("Bearer", private$token),
3319 "Content-Type" = "application/json")
3320 queryArgs <- list(uuid = uuid, user = user,
3321 repo_name = repo_name, vm_uuid = vm_uuid,
3322 send_notification_email = send_notification_email)
3326 response <- private$REST$http$exec("POST", url, headers, body,
3327 queryArgs, private$numRetries)
3328 resource <- private$REST$httpParser$parseJSONResponse(response)
3330 if(!is.null(resource$errors))
3331 stop(resource$errors)
3336 users.unsetup = function(uuid)
3338 endPoint <- stringr::str_interp("users/${uuid}/unsetup")
3339 url <- paste0(private$host, endPoint)
3340 headers <- list(Authorization = paste("Bearer", private$token),
3341 "Content-Type" = "application/json")
3346 response <- private$REST$http$exec("POST", url, headers, body,
3347 queryArgs, private$numRetries)
3348 resource <- private$REST$httpParser$parseJSONResponse(response)
3350 if(!is.null(resource$errors))
3351 stop(resource$errors)
3356 users.update_uuid = function(uuid, new_uuid)
3358 endPoint <- stringr::str_interp("users/${uuid}/update_uuid")
3359 url <- paste0(private$host, endPoint)
3360 headers <- list(Authorization = paste("Bearer", private$token),
3361 "Content-Type" = "application/json")
3362 queryArgs <- list(new_uuid = new_uuid)
3366 response <- private$REST$http$exec("POST", url, headers, body,
3367 queryArgs, private$numRetries)
3368 resource <- private$REST$httpParser$parseJSONResponse(response)
3370 if(!is.null(resource$errors))
3371 stop(resource$errors)
3376 users.merge = function(new_owner_uuid, new_user_token = NULL,
3377 redirect_to_new_user = NULL, old_user_uuid = NULL,
3378 new_user_uuid = NULL)
3380 endPoint <- stringr::str_interp("users/merge")
3381 url <- paste0(private$host, endPoint)
3382 headers <- list(Authorization = paste("Bearer", private$token),
3383 "Content-Type" = "application/json")
3384 queryArgs <- list(new_owner_uuid = new_owner_uuid,
3385 new_user_token = new_user_token, redirect_to_new_user = redirect_to_new_user,
3386 old_user_uuid = old_user_uuid, new_user_uuid = new_user_uuid)
3390 response <- private$REST$http$exec("POST", url, headers, body,
3391 queryArgs, private$numRetries)
3392 resource <- private$REST$httpParser$parseJSONResponse(response)
3394 if(!is.null(resource$errors))
3395 stop(resource$errors)
3400 users.list = function(filters = NULL, where = NULL,
3401 order = NULL, select = NULL, distinct = NULL,
3402 limit = "100", offset = "0", count = "exact",
3403 cluster_id = NULL, bypass_federation = NULL)
3405 endPoint <- stringr::str_interp("users")
3406 url <- paste0(private$host, endPoint)
3407 headers <- list(Authorization = paste("Bearer", private$token),
3408 "Content-Type" = "application/json")
3409 queryArgs <- list(filters = filters, where = where,
3410 order = order, select = select, distinct = distinct,
3411 limit = limit, offset = offset, count = count,
3412 cluster_id = cluster_id, bypass_federation = bypass_federation)
3416 response <- private$REST$http$exec("GET", url, headers, body,
3417 queryArgs, private$numRetries)
3418 resource <- private$REST$httpParser$parseJSONResponse(response)
3420 if(!is.null(resource$errors))
3421 stop(resource$errors)
3426 repositories.get = function(uuid)
3428 endPoint <- stringr::str_interp("repositories/${uuid}")
3429 url <- paste0(private$host, endPoint)
3430 headers <- list(Authorization = paste("Bearer", private$token),
3431 "Content-Type" = "application/json")
3436 response <- private$REST$http$exec("GET", url, headers, body,
3437 queryArgs, private$numRetries)
3438 resource <- private$REST$httpParser$parseJSONResponse(response)
3440 if(!is.null(resource$errors))
3441 stop(resource$errors)
3446 repositories.create = function(repository,
3447 ensure_unique_name = "false", cluster_id = NULL)
3449 endPoint <- stringr::str_interp("repositories")
3450 url <- paste0(private$host, endPoint)
3451 headers <- list(Authorization = paste("Bearer", private$token),
3452 "Content-Type" = "application/json")
3453 queryArgs <- list(ensure_unique_name = ensure_unique_name,
3454 cluster_id = cluster_id)
3456 if(length(repository) > 0)
3457 body <- jsonlite::toJSON(list(repository = repository),
3462 response <- private$REST$http$exec("POST", url, headers, body,
3463 queryArgs, private$numRetries)
3464 resource <- private$REST$httpParser$parseJSONResponse(response)
3466 if(!is.null(resource$errors))
3467 stop(resource$errors)
3472 repositories.update = function(repository, uuid)
3474 endPoint <- stringr::str_interp("repositories/${uuid}")
3475 url <- paste0(private$host, endPoint)
3476 headers <- list(Authorization = paste("Bearer", private$token),
3477 "Content-Type" = "application/json")
3480 if(length(repository) > 0)
3481 body <- jsonlite::toJSON(list(repository = repository),
3486 response <- private$REST$http$exec("PUT", url, headers, body,
3487 queryArgs, private$numRetries)
3488 resource <- private$REST$httpParser$parseJSONResponse(response)
3490 if(!is.null(resource$errors))
3491 stop(resource$errors)
3496 repositories.delete = function(uuid)
3498 endPoint <- stringr::str_interp("repositories/${uuid}")
3499 url <- paste0(private$host, endPoint)
3500 headers <- list(Authorization = paste("Bearer", private$token),
3501 "Content-Type" = "application/json")
3506 response <- private$REST$http$exec("DELETE", url, headers, body,
3507 queryArgs, private$numRetries)
3508 resource <- private$REST$httpParser$parseJSONResponse(response)
3510 if(!is.null(resource$errors))
3511 stop(resource$errors)
3516 repositories.get_all_permissions = function()
3518 endPoint <- stringr::str_interp("repositories/get_all_permissions")
3519 url <- paste0(private$host, endPoint)
3520 headers <- list(Authorization = paste("Bearer", private$token),
3521 "Content-Type" = "application/json")
3526 response <- private$REST$http$exec("GET", url, headers, body,
3527 queryArgs, private$numRetries)
3528 resource <- private$REST$httpParser$parseJSONResponse(response)
3530 if(!is.null(resource$errors))
3531 stop(resource$errors)
3536 repositories.list = function(filters = NULL,
3537 where = NULL, order = NULL, select = NULL,
3538 distinct = NULL, limit = "100", offset = "0",
3539 count = "exact", cluster_id = NULL, bypass_federation = NULL)
3541 endPoint <- stringr::str_interp("repositories")
3542 url <- paste0(private$host, endPoint)
3543 headers <- list(Authorization = paste("Bearer", private$token),
3544 "Content-Type" = "application/json")
3545 queryArgs <- list(filters = filters, where = where,
3546 order = order, select = select, distinct = distinct,
3547 limit = limit, offset = offset, count = count,
3548 cluster_id = cluster_id, bypass_federation = bypass_federation)
3552 response <- private$REST$http$exec("GET", url, headers, body,
3553 queryArgs, private$numRetries)
3554 resource <- private$REST$httpParser$parseJSONResponse(response)
3556 if(!is.null(resource$errors))
3557 stop(resource$errors)
3562 virtual_machines.get = function(uuid)
3564 endPoint <- stringr::str_interp("virtual_machines/${uuid}")
3565 url <- paste0(private$host, endPoint)
3566 headers <- list(Authorization = paste("Bearer", private$token),
3567 "Content-Type" = "application/json")
3572 response <- private$REST$http$exec("GET", url, headers, body,
3573 queryArgs, private$numRetries)
3574 resource <- private$REST$httpParser$parseJSONResponse(response)
3576 if(!is.null(resource$errors))
3577 stop(resource$errors)
3582 virtual_machines.create = function(virtualmachine,
3583 ensure_unique_name = "false", cluster_id = NULL)
3585 endPoint <- stringr::str_interp("virtual_machines")
3586 url <- paste0(private$host, endPoint)
3587 headers <- list(Authorization = paste("Bearer", private$token),
3588 "Content-Type" = "application/json")
3589 queryArgs <- list(ensure_unique_name = ensure_unique_name,
3590 cluster_id = cluster_id)
3592 if(length(virtualmachine) > 0)
3593 body <- jsonlite::toJSON(list(virtualmachine = virtualmachine),
3598 response <- private$REST$http$exec("POST", url, headers, body,
3599 queryArgs, private$numRetries)
3600 resource <- private$REST$httpParser$parseJSONResponse(response)
3602 if(!is.null(resource$errors))
3603 stop(resource$errors)
3608 virtual_machines.update = function(virtualmachine, uuid)
3610 endPoint <- stringr::str_interp("virtual_machines/${uuid}")
3611 url <- paste0(private$host, endPoint)
3612 headers <- list(Authorization = paste("Bearer", private$token),
3613 "Content-Type" = "application/json")
3616 if(length(virtualmachine) > 0)
3617 body <- jsonlite::toJSON(list(virtualmachine = virtualmachine),
3622 response <- private$REST$http$exec("PUT", url, headers, body,
3623 queryArgs, private$numRetries)
3624 resource <- private$REST$httpParser$parseJSONResponse(response)
3626 if(!is.null(resource$errors))
3627 stop(resource$errors)
3632 virtual_machines.delete = function(uuid)
3634 endPoint <- stringr::str_interp("virtual_machines/${uuid}")
3635 url <- paste0(private$host, endPoint)
3636 headers <- list(Authorization = paste("Bearer", private$token),
3637 "Content-Type" = "application/json")
3642 response <- private$REST$http$exec("DELETE", url, headers, body,
3643 queryArgs, private$numRetries)
3644 resource <- private$REST$httpParser$parseJSONResponse(response)
3646 if(!is.null(resource$errors))
3647 stop(resource$errors)
3652 virtual_machines.logins = function(uuid)
3654 endPoint <- stringr::str_interp("virtual_machines/${uuid}/logins")
3655 url <- paste0(private$host, endPoint)
3656 headers <- list(Authorization = paste("Bearer", private$token),
3657 "Content-Type" = "application/json")
3662 response <- private$REST$http$exec("GET", url, headers, body,
3663 queryArgs, private$numRetries)
3664 resource <- private$REST$httpParser$parseJSONResponse(response)
3666 if(!is.null(resource$errors))
3667 stop(resource$errors)
3672 virtual_machines.get_all_logins = function()
3674 endPoint <- stringr::str_interp("virtual_machines/get_all_logins")
3675 url <- paste0(private$host, endPoint)
3676 headers <- list(Authorization = paste("Bearer", private$token),
3677 "Content-Type" = "application/json")
3682 response <- private$REST$http$exec("GET", url, headers, body,
3683 queryArgs, private$numRetries)
3684 resource <- private$REST$httpParser$parseJSONResponse(response)
3686 if(!is.null(resource$errors))
3687 stop(resource$errors)
3692 virtual_machines.list = function(filters = NULL,
3693 where = NULL, order = NULL, select = NULL,
3694 distinct = NULL, limit = "100", offset = "0",
3695 count = "exact", cluster_id = NULL, bypass_federation = NULL)
3697 endPoint <- stringr::str_interp("virtual_machines")
3698 url <- paste0(private$host, endPoint)
3699 headers <- list(Authorization = paste("Bearer", private$token),
3700 "Content-Type" = "application/json")
3701 queryArgs <- list(filters = filters, where = where,
3702 order = order, select = select, distinct = distinct,
3703 limit = limit, offset = offset, count = count,
3704 cluster_id = cluster_id, bypass_federation = bypass_federation)
3708 response <- private$REST$http$exec("GET", url, headers, body,
3709 queryArgs, private$numRetries)
3710 resource <- private$REST$httpParser$parseJSONResponse(response)
3712 if(!is.null(resource$errors))
3713 stop(resource$errors)
3718 workflows.get = function(uuid)
3720 endPoint <- stringr::str_interp("workflows/${uuid}")
3721 url <- paste0(private$host, endPoint)
3722 headers <- list(Authorization = paste("Bearer", private$token),
3723 "Content-Type" = "application/json")
3728 response <- private$REST$http$exec("GET", url, headers, body,
3729 queryArgs, private$numRetries)
3730 resource <- private$REST$httpParser$parseJSONResponse(response)
3732 if(!is.null(resource$errors))
3733 stop(resource$errors)
3738 workflows.create = function(workflow, ensure_unique_name = "false",
3741 endPoint <- stringr::str_interp("workflows")
3742 url <- paste0(private$host, endPoint)
3743 headers <- list(Authorization = paste("Bearer", private$token),
3744 "Content-Type" = "application/json")
3745 queryArgs <- list(ensure_unique_name = ensure_unique_name,
3746 cluster_id = cluster_id)
3748 if(length(workflow) > 0)
3749 body <- jsonlite::toJSON(list(workflow = workflow),
3754 response <- private$REST$http$exec("POST", url, headers, body,
3755 queryArgs, private$numRetries)
3756 resource <- private$REST$httpParser$parseJSONResponse(response)
3758 if(!is.null(resource$errors))
3759 stop(resource$errors)
3764 workflows.update = function(workflow, uuid)
3766 endPoint <- stringr::str_interp("workflows/${uuid}")
3767 url <- paste0(private$host, endPoint)
3768 headers <- list(Authorization = paste("Bearer", private$token),
3769 "Content-Type" = "application/json")
3772 if(length(workflow) > 0)
3773 body <- jsonlite::toJSON(list(workflow = workflow),
3778 response <- private$REST$http$exec("PUT", url, headers, body,
3779 queryArgs, private$numRetries)
3780 resource <- private$REST$httpParser$parseJSONResponse(response)
3782 if(!is.null(resource$errors))
3783 stop(resource$errors)
3788 workflows.delete = function(uuid)
3790 endPoint <- stringr::str_interp("workflows/${uuid}")
3791 url <- paste0(private$host, endPoint)
3792 headers <- list(Authorization = paste("Bearer", private$token),
3793 "Content-Type" = "application/json")
3798 response <- private$REST$http$exec("DELETE", url, headers, body,
3799 queryArgs, private$numRetries)
3800 resource <- private$REST$httpParser$parseJSONResponse(response)
3802 if(!is.null(resource$errors))
3803 stop(resource$errors)
3808 workflows.list = function(filters = NULL,
3809 where = NULL, order = NULL, select = NULL,
3810 distinct = NULL, limit = "100", offset = "0",
3811 count = "exact", cluster_id = NULL, bypass_federation = NULL)
3813 endPoint <- stringr::str_interp("workflows")
3814 url <- paste0(private$host, endPoint)
3815 headers <- list(Authorization = paste("Bearer", private$token),
3816 "Content-Type" = "application/json")
3817 queryArgs <- list(filters = filters, where = where,
3818 order = order, select = select, distinct = distinct,
3819 limit = limit, offset = offset, count = count,
3820 cluster_id = cluster_id, bypass_federation = bypass_federation)
3824 response <- private$REST$http$exec("GET", url, headers, body,
3825 queryArgs, private$numRetries)
3826 resource <- private$REST$httpParser$parseJSONResponse(response)
3828 if(!is.null(resource$errors))
3829 stop(resource$errors)
3834 user_agreements.get = function(uuid)
3836 endPoint <- stringr::str_interp("user_agreements/${uuid}")
3837 url <- paste0(private$host, endPoint)
3838 headers <- list(Authorization = paste("Bearer", private$token),
3839 "Content-Type" = "application/json")
3844 response <- private$REST$http$exec("GET", url, headers, body,
3845 queryArgs, private$numRetries)
3846 resource <- private$REST$httpParser$parseJSONResponse(response)
3848 if(!is.null(resource$errors))
3849 stop(resource$errors)
3854 user_agreements.create = function(useragreement,
3855 ensure_unique_name = "false", cluster_id = NULL)
3857 endPoint <- stringr::str_interp("user_agreements")
3858 url <- paste0(private$host, endPoint)
3859 headers <- list(Authorization = paste("Bearer", private$token),
3860 "Content-Type" = "application/json")
3861 queryArgs <- list(ensure_unique_name = ensure_unique_name,
3862 cluster_id = cluster_id)
3864 if(length(useragreement) > 0)
3865 body <- jsonlite::toJSON(list(useragreement = useragreement),
3870 response <- private$REST$http$exec("POST", url, headers, body,
3871 queryArgs, private$numRetries)
3872 resource <- private$REST$httpParser$parseJSONResponse(response)
3874 if(!is.null(resource$errors))
3875 stop(resource$errors)
3880 user_agreements.update = function(useragreement, uuid)
3882 endPoint <- stringr::str_interp("user_agreements/${uuid}")
3883 url <- paste0(private$host, endPoint)
3884 headers <- list(Authorization = paste("Bearer", private$token),
3885 "Content-Type" = "application/json")
3888 if(length(useragreement) > 0)
3889 body <- jsonlite::toJSON(list(useragreement = useragreement),
3894 response <- private$REST$http$exec("PUT", url, headers, body,
3895 queryArgs, private$numRetries)
3896 resource <- private$REST$httpParser$parseJSONResponse(response)
3898 if(!is.null(resource$errors))
3899 stop(resource$errors)
3904 user_agreements.delete = function(uuid)
3906 endPoint <- stringr::str_interp("user_agreements/${uuid}")
3907 url <- paste0(private$host, endPoint)
3908 headers <- list(Authorization = paste("Bearer", private$token),
3909 "Content-Type" = "application/json")
3914 response <- private$REST$http$exec("DELETE", url, headers, body,
3915 queryArgs, private$numRetries)
3916 resource <- private$REST$httpParser$parseJSONResponse(response)
3918 if(!is.null(resource$errors))
3919 stop(resource$errors)
3924 user_agreements.signatures = function()
3926 endPoint <- stringr::str_interp("user_agreements/signatures")
3927 url <- paste0(private$host, endPoint)
3928 headers <- list(Authorization = paste("Bearer", private$token),
3929 "Content-Type" = "application/json")
3934 response <- private$REST$http$exec("GET", url, headers, body,
3935 queryArgs, private$numRetries)
3936 resource <- private$REST$httpParser$parseJSONResponse(response)
3938 if(!is.null(resource$errors))
3939 stop(resource$errors)
3944 user_agreements.sign = function()
3946 endPoint <- stringr::str_interp("user_agreements/sign")
3947 url <- paste0(private$host, endPoint)
3948 headers <- list(Authorization = paste("Bearer", private$token),
3949 "Content-Type" = "application/json")
3954 response <- private$REST$http$exec("POST", url, headers, body,
3955 queryArgs, private$numRetries)
3956 resource <- private$REST$httpParser$parseJSONResponse(response)
3958 if(!is.null(resource$errors))
3959 stop(resource$errors)
3964 user_agreements.list = function(filters = NULL,
3965 where = NULL, order = NULL, select = NULL,
3966 distinct = NULL, limit = "100", offset = "0",
3967 count = "exact", cluster_id = NULL, bypass_federation = NULL)
3969 endPoint <- stringr::str_interp("user_agreements")
3970 url <- paste0(private$host, endPoint)
3971 headers <- list(Authorization = paste("Bearer", private$token),
3972 "Content-Type" = "application/json")
3973 queryArgs <- list(filters = filters, where = where,
3974 order = order, select = select, distinct = distinct,
3975 limit = limit, offset = offset, count = count,
3976 cluster_id = cluster_id, bypass_federation = bypass_federation)
3980 response <- private$REST$http$exec("GET", url, headers, body,
3981 queryArgs, private$numRetries)
3982 resource <- private$REST$httpParser$parseJSONResponse(response)
3984 if(!is.null(resource$errors))
3985 stop(resource$errors)
3990 user_agreements.new = function()
3992 endPoint <- stringr::str_interp("user_agreements/new")
3993 url <- paste0(private$host, endPoint)
3994 headers <- list(Authorization = paste("Bearer", private$token),
3995 "Content-Type" = "application/json")
4000 response <- private$REST$http$exec("GET", url, headers, body,
4001 queryArgs, private$numRetries)
4002 resource <- private$REST$httpParser$parseJSONResponse(response)
4004 if(!is.null(resource$errors))
4005 stop(resource$errors)
4010 configs.get = function()
4012 endPoint <- stringr::str_interp("config")
4013 url <- paste0(private$host, endPoint)
4014 headers <- list(Authorization = paste("Bearer", private$token),
4015 "Content-Type" = "application/json")
4020 response <- private$REST$http$exec("GET", url, headers, body,
4021 queryArgs, private$numRetries)
4022 resource <- private$REST$httpParser$parseJSONResponse(response)
4024 if(!is.null(resource$errors))
4025 stop(resource$errors)
4030 getHostName = function() private$host,
4031 getToken = function() private$token,
4032 setRESTService = function(newREST) private$REST <- newREST,
4033 getRESTService = function() private$REST