1 % Generated by roxygen2: do not edit by hand
\r
2 % Please edit documentation in R/Arvados.R
\r
5 \title{R6 Class Representing a Arvados}
\r
7 Arvados class gives users ability to access Arvados REST API. It also allowes user to manipulate collections (and projects?)
\r
11 ## ------------------------------------------------
\r
12 ## Method `Arvados$new`
\r
13 ## ------------------------------------------------
\r
15 arv <- Arvados$new(authToken = "ARVADOS_API_TOKEN", hostName = "ARVADOS_API_HOST", numRetries = 3)
\r
17 ## ------------------------------------------------
\r
18 ## Method `Arvados$project_exist`
\r
19 ## ------------------------------------------------
\r
22 arv$project_exist(uuid = "projectUUID")
\r
25 ## ------------------------------------------------
\r
26 ## Method `Arvados$project_get`
\r
27 ## ------------------------------------------------
\r
30 project <- arv$project_get(uuid = 'projectUUID')
\r
33 ## ------------------------------------------------
\r
34 ## Method `Arvados$project_create`
\r
35 ## ------------------------------------------------
\r
38 Properties <- list() # should contain a list of new properties to be added
\r
39 new_project <- arv$project_create(name = "project name", description = "project description", owner_uuid = "project UUID", properties = NULL, ensureUniqueName = "false")
\r
42 ## ------------------------------------------------
\r
43 ## Method `Arvados$project_properties_set`
\r
44 ## ------------------------------------------------
\r
47 Properties <- list() # should contain a list of new properties to be added
\r
48 arv$project_properties_set(Properties, uuid)
\r
51 ## ------------------------------------------------
\r
52 ## Method `Arvados$project_properties_append`
\r
53 ## ------------------------------------------------
\r
56 newProperties <- list() # should contain a list of new properties to be added
\r
57 arv$project_properties_append(properties = newProperties, uuid)
\r
60 ## ------------------------------------------------
\r
61 ## Method `Arvados$project_properties_get`
\r
62 ## ------------------------------------------------
\r
65 arv$project_properties_get(projectUUID)
\r
68 ## ------------------------------------------------
\r
69 ## Method `Arvados$project_properties_delete`
\r
70 ## ------------------------------------------------
\r
73 Properties <- list() # should contain a list of new properties to be added
\r
74 arv$project_properties_delete(Properties, projectUUID)
\r
77 ## ------------------------------------------------
\r
78 ## Method `Arvados$project_update`
\r
79 ## ------------------------------------------------
\r
82 newProperties <- list() # should contain a list of new properties to be added
\r
83 arv$project_update(name = "new project name", properties = newProperties, uuid = projectUUID)
\r
86 ## ------------------------------------------------
\r
87 ## Method `Arvados$project_list`
\r
88 ## ------------------------------------------------
\r
91 listOfprojects <- arv$project_list(list(list("owner_uuid", "=", projectUUID))) # Sample query which show projects within the project of a given UUID
\r
94 ## ------------------------------------------------
\r
95 ## Method `Arvados$project_delete`
\r
96 ## ------------------------------------------------
\r
99 arv$project_delete(uuid = 'projectUUID')
\r
102 ## ------------------------------------------------
\r
103 ## Method `Arvados$collections_get`
\r
104 ## ------------------------------------------------
\r
107 collection <- arv$collections_get(uuid = collectionUUID)
\r
110 ## ------------------------------------------------
\r
111 ## Method `Arvados$collections_create`
\r
112 ## ------------------------------------------------
\r
115 Properties <- list() # should contain a list of new properties to be added
\r
116 arv$collections_create(name = "collectionTitle", description = "collectionDescription", ownerUUID = "collectionOwner", properties = Properties)
\r
119 ## ------------------------------------------------
\r
120 ## Method `Arvados$collections_update`
\r
121 ## ------------------------------------------------
\r
124 collection <- arv$collections_update(name = "newCollectionTitle", description = "newCollectionDescription", ownerUUID = "collectionOwner", properties = NULL, uuid = "collectionUUID")
\r
127 ## ------------------------------------------------
\r
128 ## Method `Arvados$collections_delete`
\r
129 ## ------------------------------------------------
\r
132 arv$collection_delete(collectionUUID)
\r
135 ## ------------------------------------------------
\r
136 ## Method `Arvados$collections_provenance`
\r
137 ## ------------------------------------------------
\r
140 collection <- arv$collections_provenance(collectionUUID)
\r
143 ## ------------------------------------------------
\r
144 ## Method `Arvados$collections_trash`
\r
145 ## ------------------------------------------------
\r
148 arv$collections_trash(collectionUUID)
\r
151 ## ------------------------------------------------
\r
152 ## Method `Arvados$collections_untrash`
\r
153 ## ------------------------------------------------
\r
156 arv$collections_untrash(collectionUUID)
\r
159 ## ------------------------------------------------
\r
160 ## Method `Arvados$collections_list`
\r
161 ## ------------------------------------------------
\r
164 collectionList <- arv$collections_list(list(list("name", "=", "Example")))
\r
167 ## ------------------------------------------------
\r
168 ## Method `Arvados$project_permission_give`
\r
169 ## ------------------------------------------------
\r
172 arv$project_permission_give(type = "can_read", uuid = objectUUID, user = userUUID)
\r
175 ## ------------------------------------------------
\r
176 ## Method `Arvados$project_permission_refuse`
\r
177 ## ------------------------------------------------
\r
180 arv$project_permission_refuse(type = "can_read", uuid = objectUUID, user = userUUID)
\r
183 ## ------------------------------------------------
\r
184 ## Method `Arvados$project_permission_update`
\r
185 ## ------------------------------------------------
\r
188 arv$project_permission_update(typeOld = "can_read", typeNew = "can_write", uuid = objectUUID, user = userUUID)
\r
191 ## ------------------------------------------------
\r
192 ## Method `Arvados$project_permission_check`
\r
193 ## ------------------------------------------------
\r
196 arv$project_permission_check(type = "can_read", uuid = objectUUID, user = userUUID)
\r
200 \subsection{Public methods}{
\r
202 \item \href{#method-Arvados-new}{\code{Arvados$new()}}
\r
203 \item \href{#method-Arvados-project_exist}{\code{Arvados$project_exist()}}
\r
204 \item \href{#method-Arvados-project_get}{\code{Arvados$project_get()}}
\r
205 \item \href{#method-Arvados-project_create}{\code{Arvados$project_create()}}
\r
206 \item \href{#method-Arvados-project_properties_set}{\code{Arvados$project_properties_set()}}
\r
207 \item \href{#method-Arvados-project_properties_append}{\code{Arvados$project_properties_append()}}
\r
208 \item \href{#method-Arvados-project_properties_get}{\code{Arvados$project_properties_get()}}
\r
209 \item \href{#method-Arvados-project_properties_delete}{\code{Arvados$project_properties_delete()}}
\r
210 \item \href{#method-Arvados-project_update}{\code{Arvados$project_update()}}
\r
211 \item \href{#method-Arvados-project_list}{\code{Arvados$project_list()}}
\r
212 \item \href{#method-Arvados-project_delete}{\code{Arvados$project_delete()}}
\r
213 \item \href{#method-Arvados-api_clients_get}{\code{Arvados$api_clients_get()}}
\r
214 \item \href{#method-Arvados-api_clients_create}{\code{Arvados$api_clients_create()}}
\r
215 \item \href{#method-Arvados-api_clients_update}{\code{Arvados$api_clients_update()}}
\r
216 \item \href{#method-Arvados-api_clients_delete}{\code{Arvados$api_clients_delete()}}
\r
217 \item \href{#method-Arvados-api_clients_list}{\code{Arvados$api_clients_list()}}
\r
218 \item \href{#method-Arvados-api_client_authorizations_get}{\code{Arvados$api_client_authorizations_get()}}
\r
219 \item \href{#method-Arvados-api_client_authorizations_create}{\code{Arvados$api_client_authorizations_create()}}
\r
220 \item \href{#method-Arvados-api_client_authorizations_update}{\code{Arvados$api_client_authorizations_update()}}
\r
221 \item \href{#method-Arvados-api_client_authorizations_delete}{\code{Arvados$api_client_authorizations_delete()}}
\r
222 \item \href{#method-Arvados-api_client_authorizations_create_system_auth}{\code{Arvados$api_client_authorizations_create_system_auth()}}
\r
223 \item \href{#method-Arvados-api_client_authorizations_current}{\code{Arvados$api_client_authorizations_current()}}
\r
224 \item \href{#method-Arvados-api_client_authorizations_list}{\code{Arvados$api_client_authorizations_list()}}
\r
225 \item \href{#method-Arvados-authorized_keys_get}{\code{Arvados$authorized_keys_get()}}
\r
226 \item \href{#method-Arvados-authorized_keys_create}{\code{Arvados$authorized_keys_create()}}
\r
227 \item \href{#method-Arvados-authorized_keys_update}{\code{Arvados$authorized_keys_update()}}
\r
228 \item \href{#method-Arvados-authorized_keys_delete}{\code{Arvados$authorized_keys_delete()}}
\r
229 \item \href{#method-Arvados-authorized_keys_list}{\code{Arvados$authorized_keys_list()}}
\r
230 \item \href{#method-Arvados-collections_get}{\code{Arvados$collections_get()}}
\r
231 \item \href{#method-Arvados-collections_create}{\code{Arvados$collections_create()}}
\r
232 \item \href{#method-Arvados-collections_update}{\code{Arvados$collections_update()}}
\r
233 \item \href{#method-Arvados-collections_delete}{\code{Arvados$collections_delete()}}
\r
234 \item \href{#method-Arvados-collections_provenance}{\code{Arvados$collections_provenance()}}
\r
235 \item \href{#method-Arvados-collections_used_by}{\code{Arvados$collections_used_by()}}
\r
236 \item \href{#method-Arvados-collections_trash}{\code{Arvados$collections_trash()}}
\r
237 \item \href{#method-Arvados-collections_untrash}{\code{Arvados$collections_untrash()}}
\r
238 \item \href{#method-Arvados-collections_list}{\code{Arvados$collections_list()}}
\r
239 \item \href{#method-Arvados-containers_get}{\code{Arvados$containers_get()}}
\r
240 \item \href{#method-Arvados-containers_create}{\code{Arvados$containers_create()}}
\r
241 \item \href{#method-Arvados-containers_update}{\code{Arvados$containers_update()}}
\r
242 \item \href{#method-Arvados-containers_delete}{\code{Arvados$containers_delete()}}
\r
243 \item \href{#method-Arvados-containers_auth}{\code{Arvados$containers_auth()}}
\r
244 \item \href{#method-Arvados-containers_lock}{\code{Arvados$containers_lock()}}
\r
245 \item \href{#method-Arvados-containers_unlock}{\code{Arvados$containers_unlock()}}
\r
246 \item \href{#method-Arvados-containers_secret_mounts}{\code{Arvados$containers_secret_mounts()}}
\r
247 \item \href{#method-Arvados-containers_current}{\code{Arvados$containers_current()}}
\r
248 \item \href{#method-Arvados-containers_list}{\code{Arvados$containers_list()}}
\r
249 \item \href{#method-Arvados-container_requests_get}{\code{Arvados$container_requests_get()}}
\r
250 \item \href{#method-Arvados-container_requests_create}{\code{Arvados$container_requests_create()}}
\r
251 \item \href{#method-Arvados-container_requests_update}{\code{Arvados$container_requests_update()}}
\r
252 \item \href{#method-Arvados-container_requests_delete}{\code{Arvados$container_requests_delete()}}
\r
253 \item \href{#method-Arvados-container_requests_list}{\code{Arvados$container_requests_list()}}
\r
254 \item \href{#method-Arvados-groups_get}{\code{Arvados$groups_get()}}
\r
255 \item \href{#method-Arvados-groups_create}{\code{Arvados$groups_create()}}
\r
256 \item \href{#method-Arvados-groups_update}{\code{Arvados$groups_update()}}
\r
257 \item \href{#method-Arvados-groups_delete}{\code{Arvados$groups_delete()}}
\r
258 \item \href{#method-Arvados-groups_contents}{\code{Arvados$groups_contents()}}
\r
259 \item \href{#method-Arvados-groups_shared}{\code{Arvados$groups_shared()}}
\r
260 \item \href{#method-Arvados-groups_trash}{\code{Arvados$groups_trash()}}
\r
261 \item \href{#method-Arvados-groups_untrash}{\code{Arvados$groups_untrash()}}
\r
262 \item \href{#method-Arvados-groups_list}{\code{Arvados$groups_list()}}
\r
263 \item \href{#method-Arvados-keep_services_get}{\code{Arvados$keep_services_get()}}
\r
264 \item \href{#method-Arvados-keep_services_create}{\code{Arvados$keep_services_create()}}
\r
265 \item \href{#method-Arvados-keep_services_update}{\code{Arvados$keep_services_update()}}
\r
266 \item \href{#method-Arvados-keep_services_delete}{\code{Arvados$keep_services_delete()}}
\r
267 \item \href{#method-Arvados-keep_services_accessible}{\code{Arvados$keep_services_accessible()}}
\r
268 \item \href{#method-Arvados-keep_services_list}{\code{Arvados$keep_services_list()}}
\r
269 \item \href{#method-Arvados-project_permission_give}{\code{Arvados$project_permission_give()}}
\r
270 \item \href{#method-Arvados-project_permission_refuse}{\code{Arvados$project_permission_refuse()}}
\r
271 \item \href{#method-Arvados-project_permission_update}{\code{Arvados$project_permission_update()}}
\r
272 \item \href{#method-Arvados-project_permission_check}{\code{Arvados$project_permission_check()}}
\r
273 \item \href{#method-Arvados-links_get}{\code{Arvados$links_get()}}
\r
274 \item \href{#method-Arvados-links_create}{\code{Arvados$links_create()}}
\r
275 \item \href{#method-Arvados-links_update}{\code{Arvados$links_update()}}
\r
276 \item \href{#method-Arvados-links_delete}{\code{Arvados$links_delete()}}
\r
277 \item \href{#method-Arvados-links_list}{\code{Arvados$links_list()}}
\r
278 \item \href{#method-Arvados-links_get_permissions}{\code{Arvados$links_get_permissions()}}
\r
279 \item \href{#method-Arvados-logs_get}{\code{Arvados$logs_get()}}
\r
280 \item \href{#method-Arvados-logs_create}{\code{Arvados$logs_create()}}
\r
281 \item \href{#method-Arvados-logs_update}{\code{Arvados$logs_update()}}
\r
282 \item \href{#method-Arvados-logs_delete}{\code{Arvados$logs_delete()}}
\r
283 \item \href{#method-Arvados-logs_list}{\code{Arvados$logs_list()}}
\r
284 \item \href{#method-Arvados-users_get}{\code{Arvados$users_get()}}
\r
285 \item \href{#method-Arvados-users_create}{\code{Arvados$users_create()}}
\r
286 \item \href{#method-Arvados-users_update}{\code{Arvados$users_update()}}
\r
287 \item \href{#method-Arvados-users_delete}{\code{Arvados$users_delete()}}
\r
288 \item \href{#method-Arvados-users_current}{\code{Arvados$users_current()}}
\r
289 \item \href{#method-Arvados-users_system}{\code{Arvados$users_system()}}
\r
290 \item \href{#method-Arvados-users_activate}{\code{Arvados$users_activate()}}
\r
291 \item \href{#method-Arvados-users_setup}{\code{Arvados$users_setup()}}
\r
292 \item \href{#method-Arvados-users_unsetup}{\code{Arvados$users_unsetup()}}
\r
293 \item \href{#method-Arvados-users_merge}{\code{Arvados$users_merge()}}
\r
294 \item \href{#method-Arvados-users_list}{\code{Arvados$users_list()}}
\r
295 \item \href{#method-Arvados-repositories_get}{\code{Arvados$repositories_get()}}
\r
296 \item \href{#method-Arvados-repositories_create}{\code{Arvados$repositories_create()}}
\r
297 \item \href{#method-Arvados-repositories_update}{\code{Arvados$repositories_update()}}
\r
298 \item \href{#method-Arvados-repositories_delete}{\code{Arvados$repositories_delete()}}
\r
299 \item \href{#method-Arvados-repositories_get_all_permissions}{\code{Arvados$repositories_get_all_permissions()}}
\r
300 \item \href{#method-Arvados-repositories_list}{\code{Arvados$repositories_list()}}
\r
301 \item \href{#method-Arvados-virtual_machines_get}{\code{Arvados$virtual_machines_get()}}
\r
302 \item \href{#method-Arvados-virtual_machines_create}{\code{Arvados$virtual_machines_create()}}
\r
303 \item \href{#method-Arvados-virtual_machines_update}{\code{Arvados$virtual_machines_update()}}
\r
304 \item \href{#method-Arvados-virtual_machines_delete}{\code{Arvados$virtual_machines_delete()}}
\r
305 \item \href{#method-Arvados-virtual_machines_logins}{\code{Arvados$virtual_machines_logins()}}
\r
306 \item \href{#method-Arvados-virtual_machines_get_all_logins}{\code{Arvados$virtual_machines_get_all_logins()}}
\r
307 \item \href{#method-Arvados-virtual_machines_list}{\code{Arvados$virtual_machines_list()}}
\r
308 \item \href{#method-Arvados-workflows_get}{\code{Arvados$workflows_get()}}
\r
309 \item \href{#method-Arvados-workflows_create}{\code{Arvados$workflows_create()}}
\r
310 \item \href{#method-Arvados-workflows_update}{\code{Arvados$workflows_update()}}
\r
311 \item \href{#method-Arvados-workflows_delete}{\code{Arvados$workflows_delete()}}
\r
312 \item \href{#method-Arvados-workflows_list}{\code{Arvados$workflows_list()}}
\r
313 \item \href{#method-Arvados-user_agreements_get}{\code{Arvados$user_agreements_get()}}
\r
314 \item \href{#method-Arvados-user_agreements_create}{\code{Arvados$user_agreements_create()}}
\r
315 \item \href{#method-Arvados-user_agreements_update}{\code{Arvados$user_agreements_update()}}
\r
316 \item \href{#method-Arvados-user_agreements_delete}{\code{Arvados$user_agreements_delete()}}
\r
317 \item \href{#method-Arvados-user_agreements_signatures}{\code{Arvados$user_agreements_signatures()}}
\r
318 \item \href{#method-Arvados-user_agreements_sign}{\code{Arvados$user_agreements_sign()}}
\r
319 \item \href{#method-Arvados-user_agreements_list}{\code{Arvados$user_agreements_list()}}
\r
320 \item \href{#method-Arvados-user_agreements_new}{\code{Arvados$user_agreements_new()}}
\r
321 \item \href{#method-Arvados-configs_get}{\code{Arvados$configs_get()}}
\r
322 \item \href{#method-Arvados-getHostName}{\code{Arvados$getHostName()}}
\r
323 \item \href{#method-Arvados-getToken}{\code{Arvados$getToken()}}
\r
324 \item \href{#method-Arvados-setRESTService}{\code{Arvados$setRESTService()}}
\r
325 \item \href{#method-Arvados-getRESTService}{\code{Arvados$getRESTService()}}
\r
328 \if{html}{\out{<hr>}}
\r
329 \if{html}{\out{<a id="method-Arvados-new"></a>}}
\r
330 \if{latex}{\out{\hypertarget{method-Arvados-new}{}}}
\r
331 \subsection{Method \code{new()}}{
\r
332 Initialize new enviroment.
\r
333 \subsection{Usage}{
\r
334 \if{html}{\out{<div class="r">}}\preformatted{Arvados$new(authToken = NULL, hostName = NULL, numRetries = 0)}\if{html}{\out{</div>}}
\r
337 \subsection{Arguments}{
\r
338 \if{html}{\out{<div class="arguments">}}
\r
340 \item{\code{authToken}}{ARVADOS_API_TOKEN from 'Get API Token' on Arvados.}
\r
342 \item{\code{hostName}}{ARVADOS_API_HOST from 'Get API Token' on Arvados.}
\r
344 \item{\code{numRetries}}{Specify number of times to retry failed service requests.}
\r
346 \if{html}{\out{</div>}}
\r
348 \subsection{Returns}{
\r
349 A new `Arvados` object.
\r
351 \subsection{Examples}{
\r
352 \if{html}{\out{<div class="r example copy">}}
\r
353 \preformatted{arv <- Arvados$new(authToken = "ARVADOS_API_TOKEN", hostName = "ARVADOS_API_HOST", numRetries = 3)
\r
355 \if{html}{\out{</div>}}
\r
360 \if{html}{\out{<hr>}}
\r
361 \if{html}{\out{<a id="method-Arvados-project_exist"></a>}}
\r
362 \if{latex}{\out{\hypertarget{method-Arvados-project_exist}{}}}
\r
363 \subsection{Method \code{project_exist()}}{
\r
364 project_exist enables checking if the project with such a UUID exist.
\r
365 \subsection{Usage}{
\r
366 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_exist(uuid)}\if{html}{\out{</div>}}
\r
369 \subsection{Arguments}{
\r
370 \if{html}{\out{<div class="arguments">}}
\r
372 \item{\code{uuid}}{The UUID of a project or a file.}
\r
374 \if{html}{\out{</div>}}
\r
376 \subsection{Examples}{
\r
377 \if{html}{\out{<div class="r example copy">}}
\r
378 \preformatted{\dontrun{
\r
379 arv$project_exist(uuid = "projectUUID")
\r
382 \if{html}{\out{</div>}}
\r
387 \if{html}{\out{<hr>}}
\r
388 \if{html}{\out{<a id="method-Arvados-project_get"></a>}}
\r
389 \if{latex}{\out{\hypertarget{method-Arvados-project_get}{}}}
\r
390 \subsection{Method \code{project_get()}}{
\r
391 project_get returns the demanded project.
\r
392 \subsection{Usage}{
\r
393 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_get(uuid)}\if{html}{\out{</div>}}
\r
396 \subsection{Arguments}{
\r
397 \if{html}{\out{<div class="arguments">}}
\r
399 \item{\code{uuid}}{The UUID of the Group in question.}
\r
401 \if{html}{\out{</div>}}
\r
403 \subsection{Examples}{
\r
404 \if{html}{\out{<div class="r example copy">}}
\r
405 \preformatted{\dontrun{
\r
406 project <- arv$project_get(uuid = 'projectUUID')
\r
409 \if{html}{\out{</div>}}
\r
414 \if{html}{\out{<hr>}}
\r
415 \if{html}{\out{<a id="method-Arvados-project_create"></a>}}
\r
416 \if{latex}{\out{\hypertarget{method-Arvados-project_create}{}}}
\r
417 \subsection{Method \code{project_create()}}{
\r
418 project_create creates a new project of a given name and description.
\r
419 \subsection{Usage}{
\r
420 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_create(
\r
425 ensureUniqueName = "false"
\r
426 )}\if{html}{\out{</div>}}
\r
429 \subsection{Arguments}{
\r
430 \if{html}{\out{<div class="arguments">}}
\r
432 \item{\code{name}}{Name of the project.}
\r
434 \item{\code{description}}{Description of the project.}
\r
436 \item{\code{ownerUUID}}{The UUID of the maternal project to created one.}
\r
438 \item{\code{properties}}{List of the properties of the project.}
\r
440 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
442 \if{html}{\out{</div>}}
\r
444 \subsection{Examples}{
\r
445 \if{html}{\out{<div class="r example copy">}}
\r
446 \preformatted{\dontrun{
\r
447 Properties <- list() # should contain a list of new properties to be added
\r
448 new_project <- arv$project_create(name = "project name", description = "project description", owner_uuid = "project UUID", properties = NULL, ensureUniqueName = "false")
\r
451 \if{html}{\out{</div>}}
\r
456 \if{html}{\out{<hr>}}
\r
457 \if{html}{\out{<a id="method-Arvados-project_properties_set"></a>}}
\r
458 \if{latex}{\out{\hypertarget{method-Arvados-project_properties_set}{}}}
\r
459 \subsection{Method \code{project_properties_set()}}{
\r
460 project_properties_set is a method defined in Arvados class that enables setting properties. Allows to set or overwrite the properties. In case there are set already it overwrites them.
\r
461 \subsection{Usage}{
\r
462 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_properties_set(listProperties, uuid)}\if{html}{\out{</div>}}
\r
465 \subsection{Arguments}{
\r
466 \if{html}{\out{<div class="arguments">}}
\r
468 \item{\code{listProperties}}{List of new properties.}
\r
470 \item{\code{uuid}}{The UUID of a project or a file.}
\r
472 \if{html}{\out{</div>}}
\r
474 \subsection{Examples}{
\r
475 \if{html}{\out{<div class="r example copy">}}
\r
476 \preformatted{\dontrun{
\r
477 Properties <- list() # should contain a list of new properties to be added
\r
478 arv$project_properties_set(Properties, uuid)
\r
481 \if{html}{\out{</div>}}
\r
486 \if{html}{\out{<hr>}}
\r
487 \if{html}{\out{<a id="method-Arvados-project_properties_append"></a>}}
\r
488 \if{latex}{\out{\hypertarget{method-Arvados-project_properties_append}{}}}
\r
489 \subsection{Method \code{project_properties_append()}}{
\r
490 project_properties_append is a method defined in Arvados class that enables appending properties. Allows to add new properties.
\r
491 \subsection{Usage}{
\r
492 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_properties_append(properties, uuid)}\if{html}{\out{</div>}}
\r
495 \subsection{Arguments}{
\r
496 \if{html}{\out{<div class="arguments">}}
\r
498 \item{\code{properties}}{List of new properties.}
\r
500 \item{\code{uuid}}{The UUID of a project or a file.}
\r
502 \if{html}{\out{</div>}}
\r
504 \subsection{Examples}{
\r
505 \if{html}{\out{<div class="r example copy">}}
\r
506 \preformatted{\dontrun{
\r
507 newProperties <- list() # should contain a list of new properties to be added
\r
508 arv$project_properties_append(properties = newProperties, uuid)
\r
511 \if{html}{\out{</div>}}
\r
516 \if{html}{\out{<hr>}}
\r
517 \if{html}{\out{<a id="method-Arvados-project_properties_get"></a>}}
\r
518 \if{latex}{\out{\hypertarget{method-Arvados-project_properties_get}{}}}
\r
519 \subsection{Method \code{project_properties_get()}}{
\r
520 project_properties_get is a method defined in Arvados class that returns properties.
\r
521 \subsection{Usage}{
\r
522 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_properties_get(uuid)}\if{html}{\out{</div>}}
\r
525 \subsection{Arguments}{
\r
526 \if{html}{\out{<div class="arguments">}}
\r
528 \item{\code{uuid}}{The UUID of a project or a file.}
\r
530 \if{html}{\out{</div>}}
\r
532 \subsection{Examples}{
\r
533 \if{html}{\out{<div class="r example copy">}}
\r
534 \preformatted{\dontrun{
\r
535 arv$project_properties_get(projectUUID)
\r
538 \if{html}{\out{</div>}}
\r
543 \if{html}{\out{<hr>}}
\r
544 \if{html}{\out{<a id="method-Arvados-project_properties_delete"></a>}}
\r
545 \if{latex}{\out{\hypertarget{method-Arvados-project_properties_delete}{}}}
\r
546 \subsection{Method \code{project_properties_delete()}}{
\r
547 project_properties_delete is a method defined in Arvados class that deletes list of properties.
\r
548 \subsection{Usage}{
\r
549 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_properties_delete(oneProp, uuid)}\if{html}{\out{</div>}}
\r
552 \subsection{Arguments}{
\r
553 \if{html}{\out{<div class="arguments">}}
\r
555 \item{\code{oneProp}}{Property to be deleted.}
\r
557 \item{\code{uuid}}{The UUID of a project or a file.}
\r
559 \if{html}{\out{</div>}}
\r
561 \subsection{Examples}{
\r
562 \if{html}{\out{<div class="r example copy">}}
\r
563 \preformatted{\dontrun{
\r
564 Properties <- list() # should contain a list of new properties to be added
\r
565 arv$project_properties_delete(Properties, projectUUID)
\r
568 \if{html}{\out{</div>}}
\r
573 \if{html}{\out{<hr>}}
\r
574 \if{html}{\out{<a id="method-Arvados-project_update"></a>}}
\r
575 \if{latex}{\out{\hypertarget{method-Arvados-project_update}{}}}
\r
576 \subsection{Method \code{project_update()}}{
\r
577 project_update enables updating project. New name, description and properties may be given.
\r
578 \subsection{Usage}{
\r
579 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_update(..., uuid)}\if{html}{\out{</div>}}
\r
582 \subsection{Arguments}{
\r
583 \if{html}{\out{<div class="arguments">}}
\r
585 \item{\code{...}}{Feature to be updated (name, description, properties).}
\r
587 \item{\code{uuid}}{The UUID of a project in question.}
\r
589 \if{html}{\out{</div>}}
\r
591 \subsection{Examples}{
\r
592 \if{html}{\out{<div class="r example copy">}}
\r
593 \preformatted{\dontrun{
\r
594 newProperties <- list() # should contain a list of new properties to be added
\r
595 arv$project_update(name = "new project name", properties = newProperties, uuid = projectUUID)
\r
598 \if{html}{\out{</div>}}
\r
603 \if{html}{\out{<hr>}}
\r
604 \if{html}{\out{<a id="method-Arvados-project_list"></a>}}
\r
605 \if{latex}{\out{\hypertarget{method-Arvados-project_list}{}}}
\r
606 \subsection{Method \code{project_list()}}{
\r
607 project_list enables listing project by its name, uuid, properties, permissions.
\r
608 \subsection{Usage}{
\r
609 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_list(
\r
618 includeTrash = NULL
\r
619 )}\if{html}{\out{</div>}}
\r
622 \subsection{Arguments}{
\r
623 \if{html}{\out{<div class="arguments">}}
\r
625 \item{\code{includeTrash}}{Include items whose is_trashed attribute is true.}
\r
627 \item{\code{uuid}}{The UUID of a project in question.}
\r
629 \item{\code{recursive}}{Include contents from child groups recursively.}
\r
631 \if{html}{\out{</div>}}
\r
633 \subsection{Examples}{
\r
634 \if{html}{\out{<div class="r example copy">}}
\r
635 \preformatted{\dontrun{
\r
636 listOfprojects <- arv$project_list(list(list("owner_uuid", "=", projectUUID))) # Sample query which show projects within the project of a given UUID
\r
639 \if{html}{\out{</div>}}
\r
644 \if{html}{\out{<hr>}}
\r
645 \if{html}{\out{<a id="method-Arvados-project_delete"></a>}}
\r
646 \if{latex}{\out{\hypertarget{method-Arvados-project_delete}{}}}
\r
647 \subsection{Method \code{project_delete()}}{
\r
648 project_delete trashes project of a given uuid. It can be restored from trash or deleted permanently.
\r
649 \subsection{Usage}{
\r
650 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_delete(uuid)}\if{html}{\out{</div>}}
\r
653 \subsection{Arguments}{
\r
654 \if{html}{\out{<div class="arguments">}}
\r
656 \item{\code{uuid}}{The UUID of the Group in question.}
\r
658 \if{html}{\out{</div>}}
\r
660 \subsection{Examples}{
\r
661 \if{html}{\out{<div class="r example copy">}}
\r
662 \preformatted{\dontrun{
\r
663 arv$project_delete(uuid = 'projectUUID')
\r
666 \if{html}{\out{</div>}}
\r
671 \if{html}{\out{<hr>}}
\r
672 \if{html}{\out{<a id="method-Arvados-api_clients_get"></a>}}
\r
673 \if{latex}{\out{\hypertarget{method-Arvados-api_clients_get}{}}}
\r
674 \subsection{Method \code{api_clients_get()}}{
\r
675 api_clients_get is a method defined in Arvados class.
\r
676 \subsection{Usage}{
\r
677 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_clients_get(uuid)}\if{html}{\out{</div>}}
\r
680 \subsection{Arguments}{
\r
681 \if{html}{\out{<div class="arguments">}}
\r
683 \item{\code{uuid}}{The UUID of the apiClient in question.}
\r
685 \if{html}{\out{</div>}}
\r
688 \if{html}{\out{<hr>}}
\r
689 \if{html}{\out{<a id="method-Arvados-api_clients_create"></a>}}
\r
690 \if{latex}{\out{\hypertarget{method-Arvados-api_clients_create}{}}}
\r
691 \subsection{Method \code{api_clients_create()}}{
\r
692 api_clients_create is a method defined in Arvados class.
\r
693 \subsection{Usage}{
\r
694 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_clients_create(
\r
696 ensureUniqueName = "false",
\r
698 )}\if{html}{\out{</div>}}
\r
701 \subsection{Arguments}{
\r
702 \if{html}{\out{<div class="arguments">}}
\r
704 \item{\code{apiClient}}{apiClient object.}
\r
706 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
708 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
710 \if{html}{\out{</div>}}
\r
713 \if{html}{\out{<hr>}}
\r
714 \if{html}{\out{<a id="method-Arvados-api_clients_update"></a>}}
\r
715 \if{latex}{\out{\hypertarget{method-Arvados-api_clients_update}{}}}
\r
716 \subsection{Method \code{api_clients_update()}}{
\r
717 api_clients_update is a method defined in Arvados class.
\r
718 \subsection{Usage}{
\r
719 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_clients_update(apiClient, uuid)}\if{html}{\out{</div>}}
\r
722 \subsection{Arguments}{
\r
723 \if{html}{\out{<div class="arguments">}}
\r
725 \item{\code{apiClient}}{apiClient object.}
\r
727 \item{\code{uuid}}{The UUID of the apiClient in question.}
\r
729 \if{html}{\out{</div>}}
\r
732 \if{html}{\out{<hr>}}
\r
733 \if{html}{\out{<a id="method-Arvados-api_clients_delete"></a>}}
\r
734 \if{latex}{\out{\hypertarget{method-Arvados-api_clients_delete}{}}}
\r
735 \subsection{Method \code{api_clients_delete()}}{
\r
736 api_clients_delete is a method defined in Arvados class.
\r
737 \subsection{Usage}{
\r
738 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_clients_delete(uuid)}\if{html}{\out{</div>}}
\r
741 \subsection{Arguments}{
\r
742 \if{html}{\out{<div class="arguments">}}
\r
744 \item{\code{uuid}}{The UUID of the apiClient in question.}
\r
746 \if{html}{\out{</div>}}
\r
749 \if{html}{\out{<hr>}}
\r
750 \if{html}{\out{<a id="method-Arvados-api_clients_list"></a>}}
\r
751 \if{latex}{\out{\hypertarget{method-Arvados-api_clients_list}{}}}
\r
752 \subsection{Method \code{api_clients_list()}}{
\r
753 api_clients_list is a method defined in Arvados class.
\r
754 \subsection{Usage}{
\r
755 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_clients_list(
\r
765 bypassFederation = NULL
\r
766 )}\if{html}{\out{</div>}}
\r
769 \subsection{Arguments}{
\r
770 \if{html}{\out{<div class="arguments">}}
\r
772 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
774 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
776 \if{html}{\out{</div>}}
\r
779 \if{html}{\out{<hr>}}
\r
780 \if{html}{\out{<a id="method-Arvados-api_client_authorizations_get"></a>}}
\r
781 \if{latex}{\out{\hypertarget{method-Arvados-api_client_authorizations_get}{}}}
\r
782 \subsection{Method \code{api_client_authorizations_get()}}{
\r
783 api_client_authorizations_get is a method defined in Arvados class.
\r
784 \subsection{Usage}{
\r
785 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_get(uuid)}\if{html}{\out{</div>}}
\r
788 \subsection{Arguments}{
\r
789 \if{html}{\out{<div class="arguments">}}
\r
791 \item{\code{uuid}}{The UUID of the apiClientAuthorization in question.}
\r
793 \if{html}{\out{</div>}}
\r
796 \if{html}{\out{<hr>}}
\r
797 \if{html}{\out{<a id="method-Arvados-api_client_authorizations_create"></a>}}
\r
798 \if{latex}{\out{\hypertarget{method-Arvados-api_client_authorizations_create}{}}}
\r
799 \subsection{Method \code{api_client_authorizations_create()}}{
\r
800 api_client_authorizations_create is a method defined in Arvados class.
\r
801 \subsection{Usage}{
\r
802 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_create(
\r
803 apiClientAuthorization,
\r
804 ensureUniqueName = "false",
\r
806 )}\if{html}{\out{</div>}}
\r
809 \subsection{Arguments}{
\r
810 \if{html}{\out{<div class="arguments">}}
\r
812 \item{\code{apiClientAuthorization}}{apiClientAuthorization object.}
\r
814 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error on (ownerUUID, name) collision_}
\r
816 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
818 \if{html}{\out{</div>}}
\r
821 \if{html}{\out{<hr>}}
\r
822 \if{html}{\out{<a id="method-Arvados-api_client_authorizations_update"></a>}}
\r
823 \if{latex}{\out{\hypertarget{method-Arvados-api_client_authorizations_update}{}}}
\r
824 \subsection{Method \code{api_client_authorizations_update()}}{
\r
825 api_client_authorizations_update is a method defined in Arvados class.
\r
826 \subsection{Usage}{
\r
827 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_update(apiClientAuthorization, uuid)}\if{html}{\out{</div>}}
\r
830 \subsection{Arguments}{
\r
831 \if{html}{\out{<div class="arguments">}}
\r
833 \item{\code{apiClientAuthorization}}{apiClientAuthorization object.}
\r
835 \item{\code{uuid}}{The UUID of the apiClientAuthorization in question.}
\r
837 \if{html}{\out{</div>}}
\r
840 \if{html}{\out{<hr>}}
\r
841 \if{html}{\out{<a id="method-Arvados-api_client_authorizations_delete"></a>}}
\r
842 \if{latex}{\out{\hypertarget{method-Arvados-api_client_authorizations_delete}{}}}
\r
843 \subsection{Method \code{api_client_authorizations_delete()}}{
\r
844 api_client_authorizations_delete is a method defined in Arvados class.
\r
845 \subsection{Usage}{
\r
846 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_delete(uuid)}\if{html}{\out{</div>}}
\r
849 \subsection{Arguments}{
\r
850 \if{html}{\out{<div class="arguments">}}
\r
852 \item{\code{uuid}}{The UUID of the apiClientAuthorization in question.}
\r
854 \if{html}{\out{</div>}}
\r
857 \if{html}{\out{<hr>}}
\r
858 \if{html}{\out{<a id="method-Arvados-api_client_authorizations_create_system_auth"></a>}}
\r
859 \if{latex}{\out{\hypertarget{method-Arvados-api_client_authorizations_create_system_auth}{}}}
\r
860 \subsection{Method \code{api_client_authorizations_create_system_auth()}}{
\r
861 api_client_authorizations_create_system_auth is a method defined in Arvados class.
\r
862 \subsection{Usage}{
\r
863 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_create_system_auth(
\r
864 apiClientID = NULL,
\r
866 )}\if{html}{\out{</div>}}
\r
870 \if{html}{\out{<hr>}}
\r
871 \if{html}{\out{<a id="method-Arvados-api_client_authorizations_current"></a>}}
\r
872 \if{latex}{\out{\hypertarget{method-Arvados-api_client_authorizations_current}{}}}
\r
873 \subsection{Method \code{api_client_authorizations_current()}}{
\r
874 api_client_authorizations_current is a method defined in Arvados class.
\r
875 \subsection{Usage}{
\r
876 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_current()}\if{html}{\out{</div>}}
\r
880 \if{html}{\out{<hr>}}
\r
881 \if{html}{\out{<a id="method-Arvados-api_client_authorizations_list"></a>}}
\r
882 \if{latex}{\out{\hypertarget{method-Arvados-api_client_authorizations_list}{}}}
\r
883 \subsection{Method \code{api_client_authorizations_list()}}{
\r
884 api_client_authorizations_list is a method defined in Arvados class.
\r
885 \subsection{Usage}{
\r
886 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_list(
\r
896 bypassFederation = NULL
\r
897 )}\if{html}{\out{</div>}}
\r
900 \subsection{Arguments}{
\r
901 \if{html}{\out{<div class="arguments">}}
\r
903 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
905 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
907 \if{html}{\out{</div>}}
\r
910 \if{html}{\out{<hr>}}
\r
911 \if{html}{\out{<a id="method-Arvados-authorized_keys_get"></a>}}
\r
912 \if{latex}{\out{\hypertarget{method-Arvados-authorized_keys_get}{}}}
\r
913 \subsection{Method \code{authorized_keys_get()}}{
\r
914 authorized_keys_get is a method defined in Arvados class.
\r
915 \subsection{Usage}{
\r
916 \if{html}{\out{<div class="r">}}\preformatted{Arvados$authorized_keys_get(uuid)}\if{html}{\out{</div>}}
\r
919 \subsection{Arguments}{
\r
920 \if{html}{\out{<div class="arguments">}}
\r
922 \item{\code{uuid}}{The UUID of the authorizedKey in question.}
\r
924 \if{html}{\out{</div>}}
\r
927 \if{html}{\out{<hr>}}
\r
928 \if{html}{\out{<a id="method-Arvados-authorized_keys_create"></a>}}
\r
929 \if{latex}{\out{\hypertarget{method-Arvados-authorized_keys_create}{}}}
\r
930 \subsection{Method \code{authorized_keys_create()}}{
\r
931 authorized_keys_create is a method defined in Arvados class.
\r
932 \subsection{Usage}{
\r
933 \if{html}{\out{<div class="r">}}\preformatted{Arvados$authorized_keys_create(
\r
935 ensureUniqueName = "false",
\r
937 )}\if{html}{\out{</div>}}
\r
940 \subsection{Arguments}{
\r
941 \if{html}{\out{<div class="arguments">}}
\r
943 \item{\code{authorizedKey}}{authorizedKey object.}
\r
945 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
947 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
949 \if{html}{\out{</div>}}
\r
952 \if{html}{\out{<hr>}}
\r
953 \if{html}{\out{<a id="method-Arvados-authorized_keys_update"></a>}}
\r
954 \if{latex}{\out{\hypertarget{method-Arvados-authorized_keys_update}{}}}
\r
955 \subsection{Method \code{authorized_keys_update()}}{
\r
956 authorized_keys_update is a method defined in Arvados class.
\r
957 \subsection{Usage}{
\r
958 \if{html}{\out{<div class="r">}}\preformatted{Arvados$authorized_keys_update(authorizedKey, uuid)}\if{html}{\out{</div>}}
\r
961 \subsection{Arguments}{
\r
962 \if{html}{\out{<div class="arguments">}}
\r
964 \item{\code{authorizedKey}}{authorizedKey object.}
\r
966 \item{\code{uuid}}{The UUID of the authorizedKey in question.}
\r
968 \if{html}{\out{</div>}}
\r
971 \if{html}{\out{<hr>}}
\r
972 \if{html}{\out{<a id="method-Arvados-authorized_keys_delete"></a>}}
\r
973 \if{latex}{\out{\hypertarget{method-Arvados-authorized_keys_delete}{}}}
\r
974 \subsection{Method \code{authorized_keys_delete()}}{
\r
975 authorized_keys_delete is a method defined in Arvados class.
\r
976 \subsection{Usage}{
\r
977 \if{html}{\out{<div class="r">}}\preformatted{Arvados$authorized_keys_delete(uuid)}\if{html}{\out{</div>}}
\r
980 \subsection{Arguments}{
\r
981 \if{html}{\out{<div class="arguments">}}
\r
983 \item{\code{uuid}}{The UUID of the authorizedKey in question.}
\r
985 \if{html}{\out{</div>}}
\r
988 \if{html}{\out{<hr>}}
\r
989 \if{html}{\out{<a id="method-Arvados-authorized_keys_list"></a>}}
\r
990 \if{latex}{\out{\hypertarget{method-Arvados-authorized_keys_list}{}}}
\r
991 \subsection{Method \code{authorized_keys_list()}}{
\r
992 authorized_keys_list is a method defined in Arvados class.
\r
993 \subsection{Usage}{
\r
994 \if{html}{\out{<div class="r">}}\preformatted{Arvados$authorized_keys_list(
\r
1004 bypassFederation = NULL
\r
1005 )}\if{html}{\out{</div>}}
\r
1008 \subsection{Arguments}{
\r
1009 \if{html}{\out{<div class="arguments">}}
\r
1011 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
1013 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
1015 \if{html}{\out{</div>}}
\r
1018 \if{html}{\out{<hr>}}
\r
1019 \if{html}{\out{<a id="method-Arvados-collections_get"></a>}}
\r
1020 \if{latex}{\out{\hypertarget{method-Arvados-collections_get}{}}}
\r
1021 \subsection{Method \code{collections_get()}}{
\r
1022 collections_get is a method defined in Arvados class.
\r
1023 \subsection{Usage}{
\r
1024 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_get(uuid)}\if{html}{\out{</div>}}
\r
1027 \subsection{Arguments}{
\r
1028 \if{html}{\out{<div class="arguments">}}
\r
1030 \item{\code{uuid}}{The UUID of the Collection in question.}
\r
1032 \if{html}{\out{</div>}}
\r
1034 \subsection{Examples}{
\r
1035 \if{html}{\out{<div class="r example copy">}}
\r
1036 \preformatted{\dontrun{
\r
1037 collection <- arv$collections_get(uuid = collectionUUID)
\r
1040 \if{html}{\out{</div>}}
\r
1045 \if{html}{\out{<hr>}}
\r
1046 \if{html}{\out{<a id="method-Arvados-collections_create"></a>}}
\r
1047 \if{latex}{\out{\hypertarget{method-Arvados-collections_create}{}}}
\r
1048 \subsection{Method \code{collections_create()}}{
\r
1049 collections_create is a method defined in Arvados class that enables collections creation.
\r
1050 \subsection{Usage}{
\r
1051 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_create(
\r
1055 properties = NULL,
\r
1056 ensureUniqueName = "false",
\r
1058 )}\if{html}{\out{</div>}}
\r
1061 \subsection{Arguments}{
\r
1062 \if{html}{\out{<div class="arguments">}}
\r
1064 \item{\code{name}}{Name of the collection.}
\r
1066 \item{\code{description}}{Description of the collection.}
\r
1068 \item{\code{ownerUUID}}{UUID of the maternal project to created one.}
\r
1070 \item{\code{properties}}{Properties of the collection.}
\r
1072 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
1074 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
1076 \if{html}{\out{</div>}}
\r
1078 \subsection{Examples}{
\r
1079 \if{html}{\out{<div class="r example copy">}}
\r
1080 \preformatted{\dontrun{
\r
1081 Properties <- list() # should contain a list of new properties to be added
\r
1082 arv$collections_create(name = "collectionTitle", description = "collectionDescription", ownerUUID = "collectionOwner", properties = Properties)
\r
1085 \if{html}{\out{</div>}}
\r
1090 \if{html}{\out{<hr>}}
\r
1091 \if{html}{\out{<a id="method-Arvados-collections_update"></a>}}
\r
1092 \if{latex}{\out{\hypertarget{method-Arvados-collections_update}{}}}
\r
1093 \subsection{Method \code{collections_update()}}{
\r
1094 collections_update is a method defined in Arvados class.
\r
1095 \subsection{Usage}{
\r
1096 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_update(
\r
1100 properties = NULL,
\r
1102 )}\if{html}{\out{</div>}}
\r
1105 \subsection{Arguments}{
\r
1106 \if{html}{\out{<div class="arguments">}}
\r
1108 \item{\code{name}}{New name of the collection.}
\r
1110 \item{\code{description}}{New description of the collection.}
\r
1112 \item{\code{ownerUUID}}{UUID of the maternal project to created one.}
\r
1114 \item{\code{properties}}{New list of properties of the collection.}
\r
1116 \item{\code{uuid}}{The UUID of the Collection in question.}
\r
1118 \if{html}{\out{</div>}}
\r
1120 \subsection{Examples}{
\r
1121 \if{html}{\out{<div class="r example copy">}}
\r
1122 \preformatted{\dontrun{
\r
1123 collection <- arv$collections_update(name = "newCollectionTitle", description = "newCollectionDescription", ownerUUID = "collectionOwner", properties = NULL, uuid = "collectionUUID")
\r
1126 \if{html}{\out{</div>}}
\r
1131 \if{html}{\out{<hr>}}
\r
1132 \if{html}{\out{<a id="method-Arvados-collections_delete"></a>}}
\r
1133 \if{latex}{\out{\hypertarget{method-Arvados-collections_delete}{}}}
\r
1134 \subsection{Method \code{collections_delete()}}{
\r
1135 collections_delete is a method defined in Arvados class.
\r
1136 \subsection{Usage}{
\r
1137 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_delete(uuid)}\if{html}{\out{</div>}}
\r
1140 \subsection{Arguments}{
\r
1141 \if{html}{\out{<div class="arguments">}}
\r
1143 \item{\code{uuid}}{The UUID of the Collection in question.}
\r
1145 \if{html}{\out{</div>}}
\r
1147 \subsection{Examples}{
\r
1148 \if{html}{\out{<div class="r example copy">}}
\r
1149 \preformatted{\dontrun{
\r
1150 arv$collection_delete(collectionUUID)
\r
1153 \if{html}{\out{</div>}}
\r
1158 \if{html}{\out{<hr>}}
\r
1159 \if{html}{\out{<a id="method-Arvados-collections_provenance"></a>}}
\r
1160 \if{latex}{\out{\hypertarget{method-Arvados-collections_provenance}{}}}
\r
1161 \subsection{Method \code{collections_provenance()}}{
\r
1162 collections_provenance is a method defined in Arvados class, it returns the collection by uuid.
\r
1163 \subsection{Usage}{
\r
1164 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_provenance(uuid)}\if{html}{\out{</div>}}
\r
1167 \subsection{Arguments}{
\r
1168 \if{html}{\out{<div class="arguments">}}
\r
1170 \item{\code{uuid}}{The UUID of the Collection in question.}
\r
1172 \if{html}{\out{</div>}}
\r
1174 \subsection{Examples}{
\r
1175 \if{html}{\out{<div class="r example copy">}}
\r
1176 \preformatted{\dontrun{
\r
1177 collection <- arv$collections_provenance(collectionUUID)
\r
1180 \if{html}{\out{</div>}}
\r
1185 \if{html}{\out{<hr>}}
\r
1186 \if{html}{\out{<a id="method-Arvados-collections_used_by"></a>}}
\r
1187 \if{latex}{\out{\hypertarget{method-Arvados-collections_used_by}{}}}
\r
1188 \subsection{Method \code{collections_used_by()}}{
\r
1189 collections_used_by is a method defined in Arvados class, it returns collection by portable_data_hash.
\r
1190 \subsection{Usage}{
\r
1191 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_used_by(uuid)}\if{html}{\out{</div>}}
\r
1194 \subsection{Arguments}{
\r
1195 \if{html}{\out{<div class="arguments">}}
\r
1197 \item{\code{uuid}}{The UUID of the Collection in question.}
\r
1199 \if{html}{\out{</div>}}
\r
1202 \if{html}{\out{<hr>}}
\r
1203 \if{html}{\out{<a id="method-Arvados-collections_trash"></a>}}
\r
1204 \if{latex}{\out{\hypertarget{method-Arvados-collections_trash}{}}}
\r
1205 \subsection{Method \code{collections_trash()}}{
\r
1206 collections_trash is a method defined in Arvados class, it moves collection to trash.
\r
1207 \subsection{Usage}{
\r
1208 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_trash(uuid)}\if{html}{\out{</div>}}
\r
1211 \subsection{Arguments}{
\r
1212 \if{html}{\out{<div class="arguments">}}
\r
1214 \item{\code{uuid}}{The UUID of the Collection in question.}
\r
1216 \if{html}{\out{</div>}}
\r
1218 \subsection{Examples}{
\r
1219 \if{html}{\out{<div class="r example copy">}}
\r
1220 \preformatted{\dontrun{
\r
1221 arv$collections_trash(collectionUUID)
\r
1224 \if{html}{\out{</div>}}
\r
1229 \if{html}{\out{<hr>}}
\r
1230 \if{html}{\out{<a id="method-Arvados-collections_untrash"></a>}}
\r
1231 \if{latex}{\out{\hypertarget{method-Arvados-collections_untrash}{}}}
\r
1232 \subsection{Method \code{collections_untrash()}}{
\r
1233 collections_untrash is a method defined in Arvados class, it moves collection from trash to project.
\r
1234 \subsection{Usage}{
\r
1235 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_untrash(uuid)}\if{html}{\out{</div>}}
\r
1238 \subsection{Arguments}{
\r
1239 \if{html}{\out{<div class="arguments">}}
\r
1241 \item{\code{uuid}}{The UUID of the Collection in question.}
\r
1243 \if{html}{\out{</div>}}
\r
1245 \subsection{Examples}{
\r
1246 \if{html}{\out{<div class="r example copy">}}
\r
1247 \preformatted{\dontrun{
\r
1248 arv$collections_untrash(collectionUUID)
\r
1251 \if{html}{\out{</div>}}
\r
1256 \if{html}{\out{<hr>}}
\r
1257 \if{html}{\out{<a id="method-Arvados-collections_list"></a>}}
\r
1258 \if{latex}{\out{\hypertarget{method-Arvados-collections_list}{}}}
\r
1259 \subsection{Method \code{collections_list()}}{
\r
1260 collections_list is a method defined in Arvados class.
\r
1261 \subsection{Usage}{
\r
1262 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_list(
\r
1272 bypassFederation = NULL,
\r
1273 includeTrash = NULL,
\r
1274 includeOldVersions = NULL
\r
1275 )}\if{html}{\out{</div>}}
\r
1278 \subsection{Arguments}{
\r
1279 \if{html}{\out{<div class="arguments">}}
\r
1281 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
1283 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
1285 \item{\code{includeTrash}}{Include collections whose is_trashed attribute is true.}
\r
1287 \item{\code{includeOldVersions}}{Include past collection versions.}
\r
1289 \if{html}{\out{</div>}}
\r
1291 \subsection{Examples}{
\r
1292 \if{html}{\out{<div class="r example copy">}}
\r
1293 \preformatted{\dontrun{
\r
1294 collectionList <- arv$collections_list(list(list("name", "=", "Example")))
\r
1297 \if{html}{\out{</div>}}
\r
1302 \if{html}{\out{<hr>}}
\r
1303 \if{html}{\out{<a id="method-Arvados-containers_get"></a>}}
\r
1304 \if{latex}{\out{\hypertarget{method-Arvados-containers_get}{}}}
\r
1305 \subsection{Method \code{containers_get()}}{
\r
1306 containers_get is a method defined in Arvados class.
\r
1307 \subsection{Usage}{
\r
1308 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_get(uuid)}\if{html}{\out{</div>}}
\r
1311 \subsection{Arguments}{
\r
1312 \if{html}{\out{<div class="arguments">}}
\r
1314 \item{\code{uuid}}{The UUID of the Container in question.}
\r
1316 \if{html}{\out{</div>}}
\r
1319 \if{html}{\out{<hr>}}
\r
1320 \if{html}{\out{<a id="method-Arvados-containers_create"></a>}}
\r
1321 \if{latex}{\out{\hypertarget{method-Arvados-containers_create}{}}}
\r
1322 \subsection{Method \code{containers_create()}}{
\r
1323 containers_create is a method defined in Arvados class.
\r
1324 \subsection{Usage}{
\r
1325 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_create(
\r
1327 ensureUniqueName = "false",
\r
1329 )}\if{html}{\out{</div>}}
\r
1332 \subsection{Arguments}{
\r
1333 \if{html}{\out{<div class="arguments">}}
\r
1335 \item{\code{container}}{Container object.}
\r
1337 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
1339 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
1341 \if{html}{\out{</div>}}
\r
1344 \if{html}{\out{<hr>}}
\r
1345 \if{html}{\out{<a id="method-Arvados-containers_update"></a>}}
\r
1346 \if{latex}{\out{\hypertarget{method-Arvados-containers_update}{}}}
\r
1347 \subsection{Method \code{containers_update()}}{
\r
1348 containers_update is a method defined in Arvados class.
\r
1349 \subsection{Usage}{
\r
1350 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_update(container, uuid)}\if{html}{\out{</div>}}
\r
1353 \subsection{Arguments}{
\r
1354 \if{html}{\out{<div class="arguments">}}
\r
1356 \item{\code{container}}{Container object.}
\r
1358 \item{\code{uuid}}{The UUID of the Container in question.}
\r
1360 \if{html}{\out{</div>}}
\r
1363 \if{html}{\out{<hr>}}
\r
1364 \if{html}{\out{<a id="method-Arvados-containers_delete"></a>}}
\r
1365 \if{latex}{\out{\hypertarget{method-Arvados-containers_delete}{}}}
\r
1366 \subsection{Method \code{containers_delete()}}{
\r
1367 containers_delete is a method defined in Arvados class.
\r
1368 \subsection{Usage}{
\r
1369 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_delete(uuid)}\if{html}{\out{</div>}}
\r
1372 \subsection{Arguments}{
\r
1373 \if{html}{\out{<div class="arguments">}}
\r
1375 \item{\code{uuid}}{The UUID of the Container in question.}
\r
1377 \if{html}{\out{</div>}}
\r
1380 \if{html}{\out{<hr>}}
\r
1381 \if{html}{\out{<a id="method-Arvados-containers_auth"></a>}}
\r
1382 \if{latex}{\out{\hypertarget{method-Arvados-containers_auth}{}}}
\r
1383 \subsection{Method \code{containers_auth()}}{
\r
1384 containers_auth is a method defined in Arvados class.
\r
1385 \subsection{Usage}{
\r
1386 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_auth(uuid)}\if{html}{\out{</div>}}
\r
1389 \subsection{Arguments}{
\r
1390 \if{html}{\out{<div class="arguments">}}
\r
1392 \item{\code{uuid}}{The UUID of the Container in question.}
\r
1394 \if{html}{\out{</div>}}
\r
1397 \if{html}{\out{<hr>}}
\r
1398 \if{html}{\out{<a id="method-Arvados-containers_lock"></a>}}
\r
1399 \if{latex}{\out{\hypertarget{method-Arvados-containers_lock}{}}}
\r
1400 \subsection{Method \code{containers_lock()}}{
\r
1401 containers_lock is a method defined in Arvados class.
\r
1402 \subsection{Usage}{
\r
1403 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_lock(uuid)}\if{html}{\out{</div>}}
\r
1406 \subsection{Arguments}{
\r
1407 \if{html}{\out{<div class="arguments">}}
\r
1409 \item{\code{uuid}}{The UUID of the Container in question.}
\r
1411 \if{html}{\out{</div>}}
\r
1414 \if{html}{\out{<hr>}}
\r
1415 \if{html}{\out{<a id="method-Arvados-containers_unlock"></a>}}
\r
1416 \if{latex}{\out{\hypertarget{method-Arvados-containers_unlock}{}}}
\r
1417 \subsection{Method \code{containers_unlock()}}{
\r
1418 containers_unlock is a method defined in Arvados class.
\r
1419 \subsection{Usage}{
\r
1420 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_unlock(uuid)}\if{html}{\out{</div>}}
\r
1423 \subsection{Arguments}{
\r
1424 \if{html}{\out{<div class="arguments">}}
\r
1426 \item{\code{uuid}}{The UUID of the Container in question.}
\r
1428 \if{html}{\out{</div>}}
\r
1431 \if{html}{\out{<hr>}}
\r
1432 \if{html}{\out{<a id="method-Arvados-containers_secret_mounts"></a>}}
\r
1433 \if{latex}{\out{\hypertarget{method-Arvados-containers_secret_mounts}{}}}
\r
1434 \subsection{Method \code{containers_secret_mounts()}}{
\r
1435 containers_secret_mounts is a method defined in Arvados class.
\r
1436 \subsection{Usage}{
\r
1437 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_secret_mounts(uuid)}\if{html}{\out{</div>}}
\r
1440 \subsection{Arguments}{
\r
1441 \if{html}{\out{<div class="arguments">}}
\r
1443 \item{\code{uuid}}{The UUID of the Container in question.}
\r
1445 \if{html}{\out{</div>}}
\r
1448 \if{html}{\out{<hr>}}
\r
1449 \if{html}{\out{<a id="method-Arvados-containers_current"></a>}}
\r
1450 \if{latex}{\out{\hypertarget{method-Arvados-containers_current}{}}}
\r
1451 \subsection{Method \code{containers_current()}}{
\r
1452 containers_current is a method defined in Arvados class.
\r
1453 \subsection{Usage}{
\r
1454 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_current()}\if{html}{\out{</div>}}
\r
1458 \if{html}{\out{<hr>}}
\r
1459 \if{html}{\out{<a id="method-Arvados-containers_list"></a>}}
\r
1460 \if{latex}{\out{\hypertarget{method-Arvados-containers_list}{}}}
\r
1461 \subsection{Method \code{containers_list()}}{
\r
1462 containers_list is a method defined in Arvados class.
\r
1463 \subsection{Usage}{
\r
1464 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_list(
\r
1474 bypassFederation = NULL
\r
1475 )}\if{html}{\out{</div>}}
\r
1478 \subsection{Arguments}{
\r
1479 \if{html}{\out{<div class="arguments">}}
\r
1481 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
1483 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
1485 \if{html}{\out{</div>}}
\r
1488 \if{html}{\out{<hr>}}
\r
1489 \if{html}{\out{<a id="method-Arvados-container_requests_get"></a>}}
\r
1490 \if{latex}{\out{\hypertarget{method-Arvados-container_requests_get}{}}}
\r
1491 \subsection{Method \code{container_requests_get()}}{
\r
1492 container_requests_get is a method defined in Arvados class.
\r
1493 \subsection{Usage}{
\r
1494 \if{html}{\out{<div class="r">}}\preformatted{Arvados$container_requests_get(uuid)}\if{html}{\out{</div>}}
\r
1497 \subsection{Arguments}{
\r
1498 \if{html}{\out{<div class="arguments">}}
\r
1500 \item{\code{uuid}}{The UUID of the containerRequest in question.}
\r
1502 \if{html}{\out{</div>}}
\r
1505 \if{html}{\out{<hr>}}
\r
1506 \if{html}{\out{<a id="method-Arvados-container_requests_create"></a>}}
\r
1507 \if{latex}{\out{\hypertarget{method-Arvados-container_requests_create}{}}}
\r
1508 \subsection{Method \code{container_requests_create()}}{
\r
1509 container_requests_create is a method defined in Arvados class.
\r
1510 \subsection{Usage}{
\r
1511 \if{html}{\out{<div class="r">}}\preformatted{Arvados$container_requests_create(
\r
1513 ensureUniqueName = "false",
\r
1515 )}\if{html}{\out{</div>}}
\r
1518 \subsection{Arguments}{
\r
1519 \if{html}{\out{<div class="arguments">}}
\r
1521 \item{\code{containerRequest}}{containerRequest object.}
\r
1523 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
1525 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
1527 \if{html}{\out{</div>}}
\r
1530 \if{html}{\out{<hr>}}
\r
1531 \if{html}{\out{<a id="method-Arvados-container_requests_update"></a>}}
\r
1532 \if{latex}{\out{\hypertarget{method-Arvados-container_requests_update}{}}}
\r
1533 \subsection{Method \code{container_requests_update()}}{
\r
1534 container_requests_update is a method defined in Arvados class.
\r
1535 \subsection{Usage}{
\r
1536 \if{html}{\out{<div class="r">}}\preformatted{Arvados$container_requests_update(containerRequest, uuid)}\if{html}{\out{</div>}}
\r
1539 \subsection{Arguments}{
\r
1540 \if{html}{\out{<div class="arguments">}}
\r
1542 \item{\code{containerRequest}}{containerRequest object.}
\r
1544 \item{\code{uuid}}{The UUID of the containerRequest in question.}
\r
1546 \if{html}{\out{</div>}}
\r
1549 \if{html}{\out{<hr>}}
\r
1550 \if{html}{\out{<a id="method-Arvados-container_requests_delete"></a>}}
\r
1551 \if{latex}{\out{\hypertarget{method-Arvados-container_requests_delete}{}}}
\r
1552 \subsection{Method \code{container_requests_delete()}}{
\r
1553 container_requests_delete is a method defined in Arvados class.
\r
1554 \subsection{Usage}{
\r
1555 \if{html}{\out{<div class="r">}}\preformatted{Arvados$container_requests_delete(uuid)}\if{html}{\out{</div>}}
\r
1558 \subsection{Arguments}{
\r
1559 \if{html}{\out{<div class="arguments">}}
\r
1561 \item{\code{uuid}}{The UUID of the containerRequest in question.}
\r
1563 \if{html}{\out{</div>}}
\r
1566 \if{html}{\out{<hr>}}
\r
1567 \if{html}{\out{<a id="method-Arvados-container_requests_list"></a>}}
\r
1568 \if{latex}{\out{\hypertarget{method-Arvados-container_requests_list}{}}}
\r
1569 \subsection{Method \code{container_requests_list()}}{
\r
1570 container_requests_list is a method defined in Arvados class.
\r
1571 \subsection{Usage}{
\r
1572 \if{html}{\out{<div class="r">}}\preformatted{Arvados$container_requests_list(
\r
1582 bypassFederation = NULL,
\r
1583 includeTrash = NULL
\r
1584 )}\if{html}{\out{</div>}}
\r
1587 \subsection{Arguments}{
\r
1588 \if{html}{\out{<div class="arguments">}}
\r
1590 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
1592 \item{\code{bypassFederation}}{bypass federation behavior, list items from local instance database only}
\r
1594 \item{\code{includeTrash}}{Include container requests whose owner project is trashed.}
\r
1596 \if{html}{\out{</div>}}
\r
1599 \if{html}{\out{<hr>}}
\r
1600 \if{html}{\out{<a id="method-Arvados-groups_get"></a>}}
\r
1601 \if{latex}{\out{\hypertarget{method-Arvados-groups_get}{}}}
\r
1602 \subsection{Method \code{groups_get()}}{
\r
1603 groups_get is a method defined in Arvados class.
\r
1604 \subsection{Usage}{
\r
1605 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_get(uuid)}\if{html}{\out{</div>}}
\r
1608 \subsection{Arguments}{
\r
1609 \if{html}{\out{<div class="arguments">}}
\r
1611 \item{\code{uuid}}{The UUID of the Group in question.}
\r
1613 \if{html}{\out{</div>}}
\r
1616 \if{html}{\out{<hr>}}
\r
1617 \if{html}{\out{<a id="method-Arvados-groups_create"></a>}}
\r
1618 \if{latex}{\out{\hypertarget{method-Arvados-groups_create}{}}}
\r
1619 \subsection{Method \code{groups_create()}}{
\r
1620 groups_create is a method defined in Arvados class that supports project creation.
\r
1621 \subsection{Usage}{
\r
1622 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_create(
\r
1624 ensureUniqueName = "false",
\r
1627 )}\if{html}{\out{</div>}}
\r
1630 \subsection{Arguments}{
\r
1631 \if{html}{\out{<div class="arguments">}}
\r
1633 \item{\code{group}}{Group object.}
\r
1635 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
1637 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
1639 \item{\code{async}}{Defer permissions update.}
\r
1641 \if{html}{\out{</div>}}
\r
1644 \if{html}{\out{<hr>}}
\r
1645 \if{html}{\out{<a id="method-Arvados-groups_update"></a>}}
\r
1646 \if{latex}{\out{\hypertarget{method-Arvados-groups_update}{}}}
\r
1647 \subsection{Method \code{groups_update()}}{
\r
1648 groups_update is a method defined in Arvados class.
\r
1649 \subsection{Usage}{
\r
1650 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_update(group, uuid, async = "false")}\if{html}{\out{</div>}}
\r
1653 \subsection{Arguments}{
\r
1654 \if{html}{\out{<div class="arguments">}}
\r
1656 \item{\code{group}}{Group object.}
\r
1658 \item{\code{uuid}}{The UUID of the Group in question.}
\r
1660 \item{\code{async}}{Defer permissions update.}
\r
1662 \if{html}{\out{</div>}}
\r
1665 \if{html}{\out{<hr>}}
\r
1666 \if{html}{\out{<a id="method-Arvados-groups_delete"></a>}}
\r
1667 \if{latex}{\out{\hypertarget{method-Arvados-groups_delete}{}}}
\r
1668 \subsection{Method \code{groups_delete()}}{
\r
1669 groups_delete is a method defined in Arvados class.
\r
1670 \subsection{Usage}{
\r
1671 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_delete(uuid)}\if{html}{\out{</div>}}
\r
1674 \subsection{Arguments}{
\r
1675 \if{html}{\out{<div class="arguments">}}
\r
1677 \item{\code{uuid}}{The UUID of the Group in question.}
\r
1679 \if{html}{\out{</div>}}
\r
1682 \if{html}{\out{<hr>}}
\r
1683 \if{html}{\out{<a id="method-Arvados-groups_contents"></a>}}
\r
1684 \if{latex}{\out{\hypertarget{method-Arvados-groups_contents}{}}}
\r
1685 \subsection{Method \code{groups_contents()}}{
\r
1686 groups_contents is a method defined in Arvados class.
\r
1687 \subsection{Usage}{
\r
1688 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_contents(
\r
1697 bypassFederation = NULL,
\r
1698 includeTrash = NULL,
\r
1702 )}\if{html}{\out{</div>}}
\r
1705 \subsection{Arguments}{
\r
1706 \if{html}{\out{<div class="arguments">}}
\r
1708 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
1710 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
1712 \item{\code{includeTrash}}{Include items whose is_trashed attribute is true.}
\r
1714 \item{\code{recursive}}{Include contents from child groups recursively.}
\r
1716 \item{\code{include}}{Include objects referred to by listed field in "included" (only ownerUUID).}
\r
1718 \if{html}{\out{</div>}}
\r
1721 \if{html}{\out{<hr>}}
\r
1722 \if{html}{\out{<a id="method-Arvados-groups_shared"></a>}}
\r
1723 \if{latex}{\out{\hypertarget{method-Arvados-groups_shared}{}}}
\r
1724 \subsection{Method \code{groups_shared()}}{
\r
1725 groups_shared is a method defined in Arvados class.
\r
1726 \subsection{Usage}{
\r
1727 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_shared(
\r
1737 bypassFederation = NULL,
\r
1738 includeTrash = NULL,
\r
1740 )}\if{html}{\out{</div>}}
\r
1743 \subsection{Arguments}{
\r
1744 \if{html}{\out{<div class="arguments">}}
\r
1746 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
1748 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
1750 \item{\code{includeTrash}}{Include items whose is_trashed attribute is true.}
\r
1752 \if{html}{\out{</div>}}
\r
1755 \if{html}{\out{<hr>}}
\r
1756 \if{html}{\out{<a id="method-Arvados-groups_trash"></a>}}
\r
1757 \if{latex}{\out{\hypertarget{method-Arvados-groups_trash}{}}}
\r
1758 \subsection{Method \code{groups_trash()}}{
\r
1759 groups_trash is a method defined in Arvados class.
\r
1760 \subsection{Usage}{
\r
1761 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_trash(uuid)}\if{html}{\out{</div>}}
\r
1764 \subsection{Arguments}{
\r
1765 \if{html}{\out{<div class="arguments">}}
\r
1767 \item{\code{uuid}}{The UUID of the Group in question.}
\r
1769 \if{html}{\out{</div>}}
\r
1772 \if{html}{\out{<hr>}}
\r
1773 \if{html}{\out{<a id="method-Arvados-groups_untrash"></a>}}
\r
1774 \if{latex}{\out{\hypertarget{method-Arvados-groups_untrash}{}}}
\r
1775 \subsection{Method \code{groups_untrash()}}{
\r
1776 groups_untrash is a method defined in Arvados class.
\r
1777 \subsection{Usage}{
\r
1778 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_untrash(uuid)}\if{html}{\out{</div>}}
\r
1781 \subsection{Arguments}{
\r
1782 \if{html}{\out{<div class="arguments">}}
\r
1784 \item{\code{uuid}}{The UUID of the Group in question.}
\r
1786 \if{html}{\out{</div>}}
\r
1789 \if{html}{\out{<hr>}}
\r
1790 \if{html}{\out{<a id="method-Arvados-groups_list"></a>}}
\r
1791 \if{latex}{\out{\hypertarget{method-Arvados-groups_list}{}}}
\r
1792 \subsection{Method \code{groups_list()}}{
\r
1793 groups_list is a method defined in Arvados class.
\r
1794 \subsection{Usage}{
\r
1795 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_list(
\r
1805 bypassFederation = NULL,
\r
1806 includeTrash = NULL
\r
1807 )}\if{html}{\out{</div>}}
\r
1810 \subsection{Arguments}{
\r
1811 \if{html}{\out{<div class="arguments">}}
\r
1813 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
1815 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
1817 \item{\code{includeTrash}}{Include items whose is_trashed attribute is true.}
\r
1819 \if{html}{\out{</div>}}
\r
1822 \if{html}{\out{<hr>}}
\r
1823 \if{html}{\out{<a id="method-Arvados-keep_services_get"></a>}}
\r
1824 \if{latex}{\out{\hypertarget{method-Arvados-keep_services_get}{}}}
\r
1825 \subsection{Method \code{keep_services_get()}}{
\r
1826 keep_services_get is a method defined in Arvados class.
\r
1827 \subsection{Usage}{
\r
1828 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_get(uuid)}\if{html}{\out{</div>}}
\r
1831 \subsection{Arguments}{
\r
1832 \if{html}{\out{<div class="arguments">}}
\r
1834 \item{\code{uuid}}{The UUID of the keepService in question.}
\r
1836 \if{html}{\out{</div>}}
\r
1839 \if{html}{\out{<hr>}}
\r
1840 \if{html}{\out{<a id="method-Arvados-keep_services_create"></a>}}
\r
1841 \if{latex}{\out{\hypertarget{method-Arvados-keep_services_create}{}}}
\r
1842 \subsection{Method \code{keep_services_create()}}{
\r
1843 keep_services_create is a method defined in Arvados class.
\r
1844 \subsection{Usage}{
\r
1845 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_create(
\r
1847 ensureUniqueName = "false",
\r
1849 )}\if{html}{\out{</div>}}
\r
1852 \subsection{Arguments}{
\r
1853 \if{html}{\out{<div class="arguments">}}
\r
1855 \item{\code{keepService}}{keepService object.}
\r
1857 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
1859 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
1861 \if{html}{\out{</div>}}
\r
1864 \if{html}{\out{<hr>}}
\r
1865 \if{html}{\out{<a id="method-Arvados-keep_services_update"></a>}}
\r
1866 \if{latex}{\out{\hypertarget{method-Arvados-keep_services_update}{}}}
\r
1867 \subsection{Method \code{keep_services_update()}}{
\r
1868 keep_services_update is a method defined in Arvados class.
\r
1869 \subsection{Usage}{
\r
1870 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_update(keepService, uuid)}\if{html}{\out{</div>}}
\r
1873 \subsection{Arguments}{
\r
1874 \if{html}{\out{<div class="arguments">}}
\r
1876 \item{\code{keepService}}{keepService object.}
\r
1878 \item{\code{uuid}}{The UUID of the keepService in question.}
\r
1880 \if{html}{\out{</div>}}
\r
1883 \if{html}{\out{<hr>}}
\r
1884 \if{html}{\out{<a id="method-Arvados-keep_services_delete"></a>}}
\r
1885 \if{latex}{\out{\hypertarget{method-Arvados-keep_services_delete}{}}}
\r
1886 \subsection{Method \code{keep_services_delete()}}{
\r
1887 keep_services_delete is a method defined in Arvados class.
\r
1888 \subsection{Usage}{
\r
1889 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_delete(uuid)}\if{html}{\out{</div>}}
\r
1892 \subsection{Arguments}{
\r
1893 \if{html}{\out{<div class="arguments">}}
\r
1895 \item{\code{uuid}}{The UUID of the keepService in question.}
\r
1897 \if{html}{\out{</div>}}
\r
1900 \if{html}{\out{<hr>}}
\r
1901 \if{html}{\out{<a id="method-Arvados-keep_services_accessible"></a>}}
\r
1902 \if{latex}{\out{\hypertarget{method-Arvados-keep_services_accessible}{}}}
\r
1903 \subsection{Method \code{keep_services_accessible()}}{
\r
1904 keep_services_accessible is a method defined in Arvados class.
\r
1905 \subsection{Usage}{
\r
1906 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_accessible()}\if{html}{\out{</div>}}
\r
1910 \if{html}{\out{<hr>}}
\r
1911 \if{html}{\out{<a id="method-Arvados-keep_services_list"></a>}}
\r
1912 \if{latex}{\out{\hypertarget{method-Arvados-keep_services_list}{}}}
\r
1913 \subsection{Method \code{keep_services_list()}}{
\r
1914 keep_services_list is a method defined in Arvados class.
\r
1915 \subsection{Usage}{
\r
1916 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_list(
\r
1926 bypassFederation = NULL
\r
1927 )}\if{html}{\out{</div>}}
\r
1930 \subsection{Arguments}{
\r
1931 \if{html}{\out{<div class="arguments">}}
\r
1933 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
1935 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
1937 \if{html}{\out{</div>}}
\r
1940 \if{html}{\out{<hr>}}
\r
1941 \if{html}{\out{<a id="method-Arvados-project_permission_give"></a>}}
\r
1942 \if{latex}{\out{\hypertarget{method-Arvados-project_permission_give}{}}}
\r
1943 \subsection{Method \code{project_permission_give()}}{
\r
1944 project_permission_give is a method defined in Arvados class that enables sharing files with another users.
\r
1945 \subsection{Usage}{
\r
1946 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_permission_give(type, uuid, user)}\if{html}{\out{</div>}}
\r
1949 \subsection{Arguments}{
\r
1950 \if{html}{\out{<div class="arguments">}}
\r
1952 \item{\code{type}}{Possible options are can_read or can_write or can_manage.}
\r
1954 \item{\code{uuid}}{The UUID of a project or a file.}
\r
1956 \item{\code{user}}{The UUID of the person that gets the permission.}
\r
1958 \if{html}{\out{</div>}}
\r
1960 \subsection{Examples}{
\r
1961 \if{html}{\out{<div class="r example copy">}}
\r
1962 \preformatted{\dontrun{
\r
1963 arv$project_permission_give(type = "can_read", uuid = objectUUID, user = userUUID)
\r
1966 \if{html}{\out{</div>}}
\r
1971 \if{html}{\out{<hr>}}
\r
1972 \if{html}{\out{<a id="method-Arvados-project_permission_refuse"></a>}}
\r
1973 \if{latex}{\out{\hypertarget{method-Arvados-project_permission_refuse}{}}}
\r
1974 \subsection{Method \code{project_permission_refuse()}}{
\r
1975 project_permission_refuse is a method defined in Arvados class that unables sharing files with another users.
\r
1976 \subsection{Usage}{
\r
1977 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_permission_refuse(type, uuid, user)}\if{html}{\out{</div>}}
\r
1980 \subsection{Arguments}{
\r
1981 \if{html}{\out{<div class="arguments">}}
\r
1983 \item{\code{type}}{Possible options are can_read or can_write or can_manage.}
\r
1985 \item{\code{uuid}}{The UUID of a project or a file.}
\r
1987 \item{\code{user}}{The UUID of a person that permissions are taken from.}
\r
1989 \if{html}{\out{</div>}}
\r
1991 \subsection{Examples}{
\r
1992 \if{html}{\out{<div class="r example copy">}}
\r
1993 \preformatted{\dontrun{
\r
1994 arv$project_permission_refuse(type = "can_read", uuid = objectUUID, user = userUUID)
\r
1997 \if{html}{\out{</div>}}
\r
2002 \if{html}{\out{<hr>}}
\r
2003 \if{html}{\out{<a id="method-Arvados-project_permission_update"></a>}}
\r
2004 \if{latex}{\out{\hypertarget{method-Arvados-project_permission_update}{}}}
\r
2005 \subsection{Method \code{project_permission_update()}}{
\r
2006 project_permission_update is a method defined in Arvados class that enables updating permissions.
\r
2007 \subsection{Usage}{
\r
2008 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_permission_update(typeOld, typeNew, uuid, user)}\if{html}{\out{</div>}}
\r
2011 \subsection{Arguments}{
\r
2012 \if{html}{\out{<div class="arguments">}}
\r
2014 \item{\code{typeOld}}{Old option.}
\r
2016 \item{\code{typeNew}}{New option like can_read or can_write or can_manage.}
\r
2018 \item{\code{uuid}}{The UUID of a project or a file.}
\r
2020 \item{\code{user}}{The UUID of the person that the permission is being updated.}
\r
2022 \if{html}{\out{</div>}}
\r
2024 \subsection{Examples}{
\r
2025 \if{html}{\out{<div class="r example copy">}}
\r
2026 \preformatted{\dontrun{
\r
2027 arv$project_permission_update(typeOld = "can_read", typeNew = "can_write", uuid = objectUUID, user = userUUID)
\r
2030 \if{html}{\out{</div>}}
\r
2035 \if{html}{\out{<hr>}}
\r
2036 \if{html}{\out{<a id="method-Arvados-project_permission_check"></a>}}
\r
2037 \if{latex}{\out{\hypertarget{method-Arvados-project_permission_check}{}}}
\r
2038 \subsection{Method \code{project_permission_check()}}{
\r
2039 project_permission_check is a method defined in Arvados class that enables checking file permissions.
\r
2040 \subsection{Usage}{
\r
2041 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_permission_check(uuid, user, type = NULL)}\if{html}{\out{</div>}}
\r
2044 \subsection{Arguments}{
\r
2045 \if{html}{\out{<div class="arguments">}}
\r
2047 \item{\code{uuid}}{The UUID of a project or a file.}
\r
2049 \item{\code{user}}{The UUID of the person that the permission is being updated.}
\r
2051 \item{\code{type}}{Possible options are can_read or can_write or can_manage.}
\r
2053 \if{html}{\out{</div>}}
\r
2055 \subsection{Examples}{
\r
2056 \if{html}{\out{<div class="r example copy">}}
\r
2057 \preformatted{\dontrun{
\r
2058 arv$project_permission_check(type = "can_read", uuid = objectUUID, user = userUUID)
\r
2061 \if{html}{\out{</div>}}
\r
2066 \if{html}{\out{<hr>}}
\r
2067 \if{html}{\out{<a id="method-Arvados-links_get"></a>}}
\r
2068 \if{latex}{\out{\hypertarget{method-Arvados-links_get}{}}}
\r
2069 \subsection{Method \code{links_get()}}{
\r
2070 links_get is a method defined in Arvados class.
\r
2071 \subsection{Usage}{
\r
2072 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_get(uuid)}\if{html}{\out{</div>}}
\r
2075 \subsection{Arguments}{
\r
2076 \if{html}{\out{<div class="arguments">}}
\r
2078 \item{\code{uuid}}{The UUID of the Link in question.}
\r
2080 \if{html}{\out{</div>}}
\r
2083 \if{html}{\out{<hr>}}
\r
2084 \if{html}{\out{<a id="method-Arvados-links_create"></a>}}
\r
2085 \if{latex}{\out{\hypertarget{method-Arvados-links_create}{}}}
\r
2086 \subsection{Method \code{links_create()}}{
\r
2087 links_create is a method defined in Arvados class.
\r
2088 \subsection{Usage}{
\r
2089 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_create(link, ensureUniqueName = "false", clusterID = NULL)}\if{html}{\out{</div>}}
\r
2092 \subsection{Arguments}{
\r
2093 \if{html}{\out{<div class="arguments">}}
\r
2095 \item{\code{link}}{Link object.}
\r
2097 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
2099 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
2101 \if{html}{\out{</div>}}
\r
2104 \if{html}{\out{<hr>}}
\r
2105 \if{html}{\out{<a id="method-Arvados-links_update"></a>}}
\r
2106 \if{latex}{\out{\hypertarget{method-Arvados-links_update}{}}}
\r
2107 \subsection{Method \code{links_update()}}{
\r
2108 links_update is a method defined in Arvados class.
\r
2109 \subsection{Usage}{
\r
2110 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_update(link, uuid, async = "false")}\if{html}{\out{</div>}}
\r
2113 \subsection{Arguments}{
\r
2114 \if{html}{\out{<div class="arguments">}}
\r
2116 \item{\code{link}}{Link object.}
\r
2118 \item{\code{uuid}}{The UUID of the Link in question.}
\r
2120 \if{html}{\out{</div>}}
\r
2123 \if{html}{\out{<hr>}}
\r
2124 \if{html}{\out{<a id="method-Arvados-links_delete"></a>}}
\r
2125 \if{latex}{\out{\hypertarget{method-Arvados-links_delete}{}}}
\r
2126 \subsection{Method \code{links_delete()}}{
\r
2127 links_delete is a method defined in Arvados class.
\r
2128 \subsection{Usage}{
\r
2129 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_delete(uuid)}\if{html}{\out{</div>}}
\r
2132 \subsection{Arguments}{
\r
2133 \if{html}{\out{<div class="arguments">}}
\r
2135 \item{\code{uuid}}{The UUID of the Link in question.}
\r
2137 \if{html}{\out{</div>}}
\r
2140 \if{html}{\out{<hr>}}
\r
2141 \if{html}{\out{<a id="method-Arvados-links_list"></a>}}
\r
2142 \if{latex}{\out{\hypertarget{method-Arvados-links_list}{}}}
\r
2143 \subsection{Method \code{links_list()}}{
\r
2144 links_list is a method defined in Arvados class.
\r
2145 \subsection{Usage}{
\r
2146 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_list(
\r
2156 bypassFederation = NULL
\r
2157 )}\if{html}{\out{</div>}}
\r
2160 \subsection{Arguments}{
\r
2161 \if{html}{\out{<div class="arguments">}}
\r
2163 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
2165 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
2167 \if{html}{\out{</div>}}
\r
2170 \if{html}{\out{<hr>}}
\r
2171 \if{html}{\out{<a id="method-Arvados-links_get_permissions"></a>}}
\r
2172 \if{latex}{\out{\hypertarget{method-Arvados-links_get_permissions}{}}}
\r
2173 \subsection{Method \code{links_get_permissions()}}{
\r
2174 links_get_permissions is a method defined in Arvados class.
\r
2175 \subsection{Usage}{
\r
2176 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_get_permissions(uuid)}\if{html}{\out{</div>}}
\r
2179 \subsection{Arguments}{
\r
2180 \if{html}{\out{<div class="arguments">}}
\r
2182 \item{\code{uuid}}{The UUID of the Log in question.}
\r
2184 \if{html}{\out{</div>}}
\r
2187 \if{html}{\out{<hr>}}
\r
2188 \if{html}{\out{<a id="method-Arvados-logs_get"></a>}}
\r
2189 \if{latex}{\out{\hypertarget{method-Arvados-logs_get}{}}}
\r
2190 \subsection{Method \code{logs_get()}}{
\r
2191 logs_get is a method defined in Arvados class.
\r
2192 \subsection{Usage}{
\r
2193 \if{html}{\out{<div class="r">}}\preformatted{Arvados$logs_get(uuid)}\if{html}{\out{</div>}}
\r
2196 \subsection{Arguments}{
\r
2197 \if{html}{\out{<div class="arguments">}}
\r
2199 \item{\code{uuid}}{The UUID of the Log in question.}
\r
2201 \if{html}{\out{</div>}}
\r
2204 \if{html}{\out{<hr>}}
\r
2205 \if{html}{\out{<a id="method-Arvados-logs_create"></a>}}
\r
2206 \if{latex}{\out{\hypertarget{method-Arvados-logs_create}{}}}
\r
2207 \subsection{Method \code{logs_create()}}{
\r
2208 logs_create is a method defined in Arvados class.
\r
2209 \subsection{Usage}{
\r
2210 \if{html}{\out{<div class="r">}}\preformatted{Arvados$logs_create(log, ensureUniqueName = "false", clusterID = NULL)}\if{html}{\out{</div>}}
\r
2213 \subsection{Arguments}{
\r
2214 \if{html}{\out{<div class="arguments">}}
\r
2216 \item{\code{log}}{Log object.}
\r
2218 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
2220 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
2222 \if{html}{\out{</div>}}
\r
2225 \if{html}{\out{<hr>}}
\r
2226 \if{html}{\out{<a id="method-Arvados-logs_update"></a>}}
\r
2227 \if{latex}{\out{\hypertarget{method-Arvados-logs_update}{}}}
\r
2228 \subsection{Method \code{logs_update()}}{
\r
2229 logs_update is a method defined in Arvados class.
\r
2230 \subsection{Usage}{
\r
2231 \if{html}{\out{<div class="r">}}\preformatted{Arvados$logs_update(log, uuid)}\if{html}{\out{</div>}}
\r
2234 \subsection{Arguments}{
\r
2235 \if{html}{\out{<div class="arguments">}}
\r
2237 \item{\code{log}}{Log object.}
\r
2239 \item{\code{uuid}}{The UUID of the Log in question.}
\r
2241 \if{html}{\out{</div>}}
\r
2244 \if{html}{\out{<hr>}}
\r
2245 \if{html}{\out{<a id="method-Arvados-logs_delete"></a>}}
\r
2246 \if{latex}{\out{\hypertarget{method-Arvados-logs_delete}{}}}
\r
2247 \subsection{Method \code{logs_delete()}}{
\r
2248 logs_delete is a method defined in Arvados class.
\r
2249 \subsection{Usage}{
\r
2250 \if{html}{\out{<div class="r">}}\preformatted{Arvados$logs_delete(uuid)}\if{html}{\out{</div>}}
\r
2253 \subsection{Arguments}{
\r
2254 \if{html}{\out{<div class="arguments">}}
\r
2256 \item{\code{uuid}}{The UUID of the Log in question.}
\r
2258 \if{html}{\out{</div>}}
\r
2261 \if{html}{\out{<hr>}}
\r
2262 \if{html}{\out{<a id="method-Arvados-logs_list"></a>}}
\r
2263 \if{latex}{\out{\hypertarget{method-Arvados-logs_list}{}}}
\r
2264 \subsection{Method \code{logs_list()}}{
\r
2265 logs_list is a method defined in Arvados class.
\r
2266 \subsection{Usage}{
\r
2267 \if{html}{\out{<div class="r">}}\preformatted{Arvados$logs_list(
\r
2277 bypassFederation = NULL
\r
2278 )}\if{html}{\out{</div>}}
\r
2281 \subsection{Arguments}{
\r
2282 \if{html}{\out{<div class="arguments">}}
\r
2284 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
2286 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
2288 \if{html}{\out{</div>}}
\r
2291 \if{html}{\out{<hr>}}
\r
2292 \if{html}{\out{<a id="method-Arvados-users_get"></a>}}
\r
2293 \if{latex}{\out{\hypertarget{method-Arvados-users_get}{}}}
\r
2294 \subsection{Method \code{users_get()}}{
\r
2295 users_get is a method defined in Arvados class.
\r
2296 \subsection{Usage}{
\r
2297 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_get(uuid)}\if{html}{\out{</div>}}
\r
2300 \subsection{Arguments}{
\r
2301 \if{html}{\out{<div class="arguments">}}
\r
2303 \item{\code{uuid}}{The UUID of the User in question.}
\r
2305 \if{html}{\out{</div>}}
\r
2308 \if{html}{\out{<hr>}}
\r
2309 \if{html}{\out{<a id="method-Arvados-users_create"></a>}}
\r
2310 \if{latex}{\out{\hypertarget{method-Arvados-users_create}{}}}
\r
2311 \subsection{Method \code{users_create()}}{
\r
2312 users_create is a method defined in Arvados class.
\r
2313 \subsection{Usage}{
\r
2314 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_create(user, ensureUniqueName = "false", clusterID = NULL)}\if{html}{\out{</div>}}
\r
2317 \subsection{Arguments}{
\r
2318 \if{html}{\out{<div class="arguments">}}
\r
2320 \item{\code{user}}{User object.}
\r
2322 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
2324 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
2326 \if{html}{\out{</div>}}
\r
2329 \if{html}{\out{<hr>}}
\r
2330 \if{html}{\out{<a id="method-Arvados-users_update"></a>}}
\r
2331 \if{latex}{\out{\hypertarget{method-Arvados-users_update}{}}}
\r
2332 \subsection{Method \code{users_update()}}{
\r
2333 users_update is a method defined in Arvados class.
\r
2334 \subsection{Usage}{
\r
2335 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_update(user, uuid, bypassFederation = NULL)}\if{html}{\out{</div>}}
\r
2338 \subsection{Arguments}{
\r
2339 \if{html}{\out{<div class="arguments">}}
\r
2341 \item{\code{user}}{User object.}
\r
2343 \item{\code{uuid}}{The UUID of the User in question.}
\r
2345 \if{html}{\out{</div>}}
\r
2348 \if{html}{\out{<hr>}}
\r
2349 \if{html}{\out{<a id="method-Arvados-users_delete"></a>}}
\r
2350 \if{latex}{\out{\hypertarget{method-Arvados-users_delete}{}}}
\r
2351 \subsection{Method \code{users_delete()}}{
\r
2352 users_delete is a method defined in Arvados class.
\r
2353 \subsection{Usage}{
\r
2354 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_delete(uuid)}\if{html}{\out{</div>}}
\r
2357 \subsection{Arguments}{
\r
2358 \if{html}{\out{<div class="arguments">}}
\r
2360 \item{\code{uuid}}{The UUID of the User in question.}
\r
2362 \if{html}{\out{</div>}}
\r
2365 \if{html}{\out{<hr>}}
\r
2366 \if{html}{\out{<a id="method-Arvados-users_current"></a>}}
\r
2367 \if{latex}{\out{\hypertarget{method-Arvados-users_current}{}}}
\r
2368 \subsection{Method \code{users_current()}}{
\r
2369 users_current is a method defined in Arvados class.
\r
2370 \subsection{Usage}{
\r
2371 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_current()}\if{html}{\out{</div>}}
\r
2375 \if{html}{\out{<hr>}}
\r
2376 \if{html}{\out{<a id="method-Arvados-users_system"></a>}}
\r
2377 \if{latex}{\out{\hypertarget{method-Arvados-users_system}{}}}
\r
2378 \subsection{Method \code{users_system()}}{
\r
2379 users_system is a method defined in Arvados class.
\r
2380 \subsection{Usage}{
\r
2381 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_system()}\if{html}{\out{</div>}}
\r
2385 \if{html}{\out{<hr>}}
\r
2386 \if{html}{\out{<a id="method-Arvados-users_activate"></a>}}
\r
2387 \if{latex}{\out{\hypertarget{method-Arvados-users_activate}{}}}
\r
2388 \subsection{Method \code{users_activate()}}{
\r
2389 users_activate is a method defined in Arvados class.
\r
2390 \subsection{Usage}{
\r
2391 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_activate(uuid)}\if{html}{\out{</div>}}
\r
2394 \subsection{Arguments}{
\r
2395 \if{html}{\out{<div class="arguments">}}
\r
2397 \item{\code{uuid}}{The UUID of the User in question.}
\r
2399 \if{html}{\out{</div>}}
\r
2402 \if{html}{\out{<hr>}}
\r
2403 \if{html}{\out{<a id="method-Arvados-users_setup"></a>}}
\r
2404 \if{latex}{\out{\hypertarget{method-Arvados-users_setup}{}}}
\r
2405 \subsection{Method \code{users_setup()}}{
\r
2406 users_setup is a method defined in Arvados class.
\r
2407 \subsection{Usage}{
\r
2408 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_setup(
\r
2413 send_notification_email = "false"
\r
2414 )}\if{html}{\out{</div>}}
\r
2418 \if{html}{\out{<hr>}}
\r
2419 \if{html}{\out{<a id="method-Arvados-users_unsetup"></a>}}
\r
2420 \if{latex}{\out{\hypertarget{method-Arvados-users_unsetup}{}}}
\r
2421 \subsection{Method \code{users_unsetup()}}{
\r
2422 users_unsetup is a method defined in Arvados class.
\r
2423 \subsection{Usage}{
\r
2424 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_unsetup(uuid)}\if{html}{\out{</div>}}
\r
2427 \subsection{Arguments}{
\r
2428 \if{html}{\out{<div class="arguments">}}
\r
2430 \item{\code{uuid}}{The UUID of the User in question.}
\r
2432 \if{html}{\out{</div>}}
\r
2435 \if{html}{\out{<hr>}}
\r
2436 \if{html}{\out{<a id="method-Arvados-users_merge"></a>}}
\r
2437 \if{latex}{\out{\hypertarget{method-Arvados-users_merge}{}}}
\r
2438 \subsection{Method \code{users_merge()}}{
\r
2439 users_merge is a method defined in Arvados class.
\r
2440 \subsection{Usage}{
\r
2441 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_merge(
\r
2443 newUserToken = NULL,
\r
2444 redirectToNewUser = NULL,
\r
2445 oldUserUUID = NULL,
\r
2446 newUserUUID = NULL
\r
2447 )}\if{html}{\out{</div>}}
\r
2451 \if{html}{\out{<hr>}}
\r
2452 \if{html}{\out{<a id="method-Arvados-users_list"></a>}}
\r
2453 \if{latex}{\out{\hypertarget{method-Arvados-users_list}{}}}
\r
2454 \subsection{Method \code{users_list()}}{
\r
2455 users_list is a method defined in Arvados class.
\r
2456 \subsection{Usage}{
\r
2457 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_list(
\r
2467 bypassFederation = NULL
\r
2468 )}\if{html}{\out{</div>}}
\r
2471 \subsection{Arguments}{
\r
2472 \if{html}{\out{<div class="arguments">}}
\r
2474 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
2476 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
2478 \if{html}{\out{</div>}}
\r
2481 \if{html}{\out{<hr>}}
\r
2482 \if{html}{\out{<a id="method-Arvados-repositories_get"></a>}}
\r
2483 \if{latex}{\out{\hypertarget{method-Arvados-repositories_get}{}}}
\r
2484 \subsection{Method \code{repositories_get()}}{
\r
2485 repositories_get is a method defined in Arvados class.
\r
2486 \subsection{Usage}{
\r
2487 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_get(uuid)}\if{html}{\out{</div>}}
\r
2490 \subsection{Arguments}{
\r
2491 \if{html}{\out{<div class="arguments">}}
\r
2493 \item{\code{uuid}}{The UUID of the Repository in question.}
\r
2495 \if{html}{\out{</div>}}
\r
2498 \if{html}{\out{<hr>}}
\r
2499 \if{html}{\out{<a id="method-Arvados-repositories_create"></a>}}
\r
2500 \if{latex}{\out{\hypertarget{method-Arvados-repositories_create}{}}}
\r
2501 \subsection{Method \code{repositories_create()}}{
\r
2502 repositories_create is a method defined in Arvados class.
\r
2503 \subsection{Usage}{
\r
2504 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_create(
\r
2506 ensureUniqueName = "false",
\r
2508 )}\if{html}{\out{</div>}}
\r
2511 \subsection{Arguments}{
\r
2512 \if{html}{\out{<div class="arguments">}}
\r
2514 \item{\code{repository}}{Repository object.}
\r
2516 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
2518 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
2520 \if{html}{\out{</div>}}
\r
2523 \if{html}{\out{<hr>}}
\r
2524 \if{html}{\out{<a id="method-Arvados-repositories_update"></a>}}
\r
2525 \if{latex}{\out{\hypertarget{method-Arvados-repositories_update}{}}}
\r
2526 \subsection{Method \code{repositories_update()}}{
\r
2527 repositories_update is a method defined in Arvados class.
\r
2528 \subsection{Usage}{
\r
2529 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_update(repository, uuid)}\if{html}{\out{</div>}}
\r
2532 \subsection{Arguments}{
\r
2533 \if{html}{\out{<div class="arguments">}}
\r
2535 \item{\code{repository}}{Repository object.}
\r
2537 \item{\code{uuid}}{The UUID of the Repository in question.}
\r
2539 \if{html}{\out{</div>}}
\r
2542 \if{html}{\out{<hr>}}
\r
2543 \if{html}{\out{<a id="method-Arvados-repositories_delete"></a>}}
\r
2544 \if{latex}{\out{\hypertarget{method-Arvados-repositories_delete}{}}}
\r
2545 \subsection{Method \code{repositories_delete()}}{
\r
2546 repositories_delete is a method defined in Arvados class.
\r
2547 \subsection{Usage}{
\r
2548 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_delete(uuid)}\if{html}{\out{</div>}}
\r
2551 \subsection{Arguments}{
\r
2552 \if{html}{\out{<div class="arguments">}}
\r
2554 \item{\code{uuid}}{The UUID of the Repository in question.}
\r
2556 \if{html}{\out{</div>}}
\r
2559 \if{html}{\out{<hr>}}
\r
2560 \if{html}{\out{<a id="method-Arvados-repositories_get_all_permissions"></a>}}
\r
2561 \if{latex}{\out{\hypertarget{method-Arvados-repositories_get_all_permissions}{}}}
\r
2562 \subsection{Method \code{repositories_get_all_permissions()}}{
\r
2563 repositories_get_all_permissions is a method defined in Arvados class.
\r
2564 \subsection{Usage}{
\r
2565 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_get_all_permissions()}\if{html}{\out{</div>}}
\r
2569 \if{html}{\out{<hr>}}
\r
2570 \if{html}{\out{<a id="method-Arvados-repositories_list"></a>}}
\r
2571 \if{latex}{\out{\hypertarget{method-Arvados-repositories_list}{}}}
\r
2572 \subsection{Method \code{repositories_list()}}{
\r
2573 repositories_list is a method defined in Arvados class.
\r
2574 \subsection{Usage}{
\r
2575 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_list(
\r
2585 bypassFederation = NULL
\r
2586 )}\if{html}{\out{</div>}}
\r
2589 \subsection{Arguments}{
\r
2590 \if{html}{\out{<div class="arguments">}}
\r
2592 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
2594 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
2596 \if{html}{\out{</div>}}
\r
2599 \if{html}{\out{<hr>}}
\r
2600 \if{html}{\out{<a id="method-Arvados-virtual_machines_get"></a>}}
\r
2601 \if{latex}{\out{\hypertarget{method-Arvados-virtual_machines_get}{}}}
\r
2602 \subsection{Method \code{virtual_machines_get()}}{
\r
2603 virtual_machines_get is a method defined in Arvados class.
\r
2604 \subsection{Usage}{
\r
2605 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_get(uuid)}\if{html}{\out{</div>}}
\r
2608 \subsection{Arguments}{
\r
2609 \if{html}{\out{<div class="arguments">}}
\r
2611 \item{\code{uuid}}{The UUID of the virtualMachine in question.}
\r
2613 \if{html}{\out{</div>}}
\r
2616 \if{html}{\out{<hr>}}
\r
2617 \if{html}{\out{<a id="method-Arvados-virtual_machines_create"></a>}}
\r
2618 \if{latex}{\out{\hypertarget{method-Arvados-virtual_machines_create}{}}}
\r
2619 \subsection{Method \code{virtual_machines_create()}}{
\r
2620 virtual_machines_create is a method defined in Arvados class.
\r
2621 \subsection{Usage}{
\r
2622 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_create(
\r
2624 ensureUniqueName = "false",
\r
2626 )}\if{html}{\out{</div>}}
\r
2629 \subsection{Arguments}{
\r
2630 \if{html}{\out{<div class="arguments">}}
\r
2632 \item{\code{virtualMachine}}{virtualMachine object.}
\r
2634 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
2636 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
2638 \if{html}{\out{</div>}}
\r
2641 \if{html}{\out{<hr>}}
\r
2642 \if{html}{\out{<a id="method-Arvados-virtual_machines_update"></a>}}
\r
2643 \if{latex}{\out{\hypertarget{method-Arvados-virtual_machines_update}{}}}
\r
2644 \subsection{Method \code{virtual_machines_update()}}{
\r
2645 virtual_machines_update is a method defined in Arvados class.
\r
2646 \subsection{Usage}{
\r
2647 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_update(virtualMachine, uuid)}\if{html}{\out{</div>}}
\r
2650 \subsection{Arguments}{
\r
2651 \if{html}{\out{<div class="arguments">}}
\r
2653 \item{\code{virtualMachine}}{virtualMachine object.}
\r
2655 \item{\code{uuid}}{The UUID of the virtualMachine in question.}
\r
2657 \if{html}{\out{</div>}}
\r
2660 \if{html}{\out{<hr>}}
\r
2661 \if{html}{\out{<a id="method-Arvados-virtual_machines_delete"></a>}}
\r
2662 \if{latex}{\out{\hypertarget{method-Arvados-virtual_machines_delete}{}}}
\r
2663 \subsection{Method \code{virtual_machines_delete()}}{
\r
2664 virtual_machines_delete is a method defined in Arvados class.
\r
2665 \subsection{Usage}{
\r
2666 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_delete(uuid)}\if{html}{\out{</div>}}
\r
2669 \subsection{Arguments}{
\r
2670 \if{html}{\out{<div class="arguments">}}
\r
2672 \item{\code{uuid}}{The UUID of the virtualMachine in question.}
\r
2674 \if{html}{\out{</div>}}
\r
2677 \if{html}{\out{<hr>}}
\r
2678 \if{html}{\out{<a id="method-Arvados-virtual_machines_logins"></a>}}
\r
2679 \if{latex}{\out{\hypertarget{method-Arvados-virtual_machines_logins}{}}}
\r
2680 \subsection{Method \code{virtual_machines_logins()}}{
\r
2681 virtual_machines_logins is a method defined in Arvados class.
\r
2682 \subsection{Usage}{
\r
2683 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_logins(uuid)}\if{html}{\out{</div>}}
\r
2686 \subsection{Arguments}{
\r
2687 \if{html}{\out{<div class="arguments">}}
\r
2689 \item{\code{uuid}}{The UUID of the virtualMachine in question.}
\r
2691 \if{html}{\out{</div>}}
\r
2694 \if{html}{\out{<hr>}}
\r
2695 \if{html}{\out{<a id="method-Arvados-virtual_machines_get_all_logins"></a>}}
\r
2696 \if{latex}{\out{\hypertarget{method-Arvados-virtual_machines_get_all_logins}{}}}
\r
2697 \subsection{Method \code{virtual_machines_get_all_logins()}}{
\r
2698 virtual_machines_get_all_logins is a method defined in Arvados class.
\r
2699 \subsection{Usage}{
\r
2700 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_get_all_logins()}\if{html}{\out{</div>}}
\r
2704 \if{html}{\out{<hr>}}
\r
2705 \if{html}{\out{<a id="method-Arvados-virtual_machines_list"></a>}}
\r
2706 \if{latex}{\out{\hypertarget{method-Arvados-virtual_machines_list}{}}}
\r
2707 \subsection{Method \code{virtual_machines_list()}}{
\r
2708 virtual_machines_list is a method defined in Arvados class.
\r
2709 \subsection{Usage}{
\r
2710 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_list(
\r
2720 bypassFederation = NULL
\r
2721 )}\if{html}{\out{</div>}}
\r
2724 \subsection{Arguments}{
\r
2725 \if{html}{\out{<div class="arguments">}}
\r
2727 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
2729 \item{\code{bypassFederation}}{bypass federation behavior, list items from local instance database only}
\r
2731 \if{html}{\out{</div>}}
\r
2734 \if{html}{\out{<hr>}}
\r
2735 \if{html}{\out{<a id="method-Arvados-workflows_get"></a>}}
\r
2736 \if{latex}{\out{\hypertarget{method-Arvados-workflows_get}{}}}
\r
2737 \subsection{Method \code{workflows_get()}}{
\r
2738 workflows_get is a method defined in Arvados class.
\r
2739 \subsection{Usage}{
\r
2740 \if{html}{\out{<div class="r">}}\preformatted{Arvados$workflows_get(uuid)}\if{html}{\out{</div>}}
\r
2743 \subsection{Arguments}{
\r
2744 \if{html}{\out{<div class="arguments">}}
\r
2746 \item{\code{uuid}}{The UUID of the Workflow in question.}
\r
2748 \if{html}{\out{</div>}}
\r
2751 \if{html}{\out{<hr>}}
\r
2752 \if{html}{\out{<a id="method-Arvados-workflows_create"></a>}}
\r
2753 \if{latex}{\out{\hypertarget{method-Arvados-workflows_create}{}}}
\r
2754 \subsection{Method \code{workflows_create()}}{
\r
2755 workflows_create is a method defined in Arvados class.
\r
2756 \subsection{Usage}{
\r
2757 \if{html}{\out{<div class="r">}}\preformatted{Arvados$workflows_create(
\r
2759 ensureUniqueName = "false",
\r
2761 )}\if{html}{\out{</div>}}
\r
2764 \subsection{Arguments}{
\r
2765 \if{html}{\out{<div class="arguments">}}
\r
2767 \item{\code{workflow}}{Workflow object.}
\r
2769 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
2771 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
2773 \if{html}{\out{</div>}}
\r
2776 \if{html}{\out{<hr>}}
\r
2777 \if{html}{\out{<a id="method-Arvados-workflows_update"></a>}}
\r
2778 \if{latex}{\out{\hypertarget{method-Arvados-workflows_update}{}}}
\r
2779 \subsection{Method \code{workflows_update()}}{
\r
2780 workflows_update is a method defined in Arvados class.
\r
2781 \subsection{Usage}{
\r
2782 \if{html}{\out{<div class="r">}}\preformatted{Arvados$workflows_update(workflow, uuid)}\if{html}{\out{</div>}}
\r
2785 \subsection{Arguments}{
\r
2786 \if{html}{\out{<div class="arguments">}}
\r
2788 \item{\code{workflow}}{Workflow object.}
\r
2790 \item{\code{uuid}}{The UUID of the Workflow in question.}
\r
2792 \if{html}{\out{</div>}}
\r
2795 \if{html}{\out{<hr>}}
\r
2796 \if{html}{\out{<a id="method-Arvados-workflows_delete"></a>}}
\r
2797 \if{latex}{\out{\hypertarget{method-Arvados-workflows_delete}{}}}
\r
2798 \subsection{Method \code{workflows_delete()}}{
\r
2799 workflows_delete is a method defined in Arvados class.
\r
2800 \subsection{Usage}{
\r
2801 \if{html}{\out{<div class="r">}}\preformatted{Arvados$workflows_delete(uuid)}\if{html}{\out{</div>}}
\r
2804 \subsection{Arguments}{
\r
2805 \if{html}{\out{<div class="arguments">}}
\r
2807 \item{\code{uuid}}{The UUID of the Workflow in question.}
\r
2809 \if{html}{\out{</div>}}
\r
2812 \if{html}{\out{<hr>}}
\r
2813 \if{html}{\out{<a id="method-Arvados-workflows_list"></a>}}
\r
2814 \if{latex}{\out{\hypertarget{method-Arvados-workflows_list}{}}}
\r
2815 \subsection{Method \code{workflows_list()}}{
\r
2816 workflows_list is a method defined in Arvados class.
\r
2817 \subsection{Usage}{
\r
2818 \if{html}{\out{<div class="r">}}\preformatted{Arvados$workflows_list(
\r
2828 bypassFederation = NULL
\r
2829 )}\if{html}{\out{</div>}}
\r
2832 \subsection{Arguments}{
\r
2833 \if{html}{\out{<div class="arguments">}}
\r
2835 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
2837 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
2839 \if{html}{\out{</div>}}
\r
2842 \if{html}{\out{<hr>}}
\r
2843 \if{html}{\out{<a id="method-Arvados-user_agreements_get"></a>}}
\r
2844 \if{latex}{\out{\hypertarget{method-Arvados-user_agreements_get}{}}}
\r
2845 \subsection{Method \code{user_agreements_get()}}{
\r
2846 user_agreements_get is a method defined in Arvados class.
\r
2847 \subsection{Usage}{
\r
2848 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_get(uuid)}\if{html}{\out{</div>}}
\r
2851 \subsection{Arguments}{
\r
2852 \if{html}{\out{<div class="arguments">}}
\r
2854 \item{\code{uuid}}{The UUID of the userAgreement in question.}
\r
2856 \if{html}{\out{</div>}}
\r
2859 \if{html}{\out{<hr>}}
\r
2860 \if{html}{\out{<a id="method-Arvados-user_agreements_create"></a>}}
\r
2861 \if{latex}{\out{\hypertarget{method-Arvados-user_agreements_create}{}}}
\r
2862 \subsection{Method \code{user_agreements_create()}}{
\r
2863 user_agreements_create is a method defined in Arvados class.
\r
2864 \subsection{Usage}{
\r
2865 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_create(
\r
2867 ensureUniqueName = "false",
\r
2869 )}\if{html}{\out{</div>}}
\r
2872 \subsection{Arguments}{
\r
2873 \if{html}{\out{<div class="arguments">}}
\r
2875 \item{\code{userAgreement}}{userAgreement object.}
\r
2877 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
2879 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
2881 \if{html}{\out{</div>}}
\r
2884 \if{html}{\out{<hr>}}
\r
2885 \if{html}{\out{<a id="method-Arvados-user_agreements_update"></a>}}
\r
2886 \if{latex}{\out{\hypertarget{method-Arvados-user_agreements_update}{}}}
\r
2887 \subsection{Method \code{user_agreements_update()}}{
\r
2888 user_agreements_update is a method defined in Arvados class.
\r
2889 \subsection{Usage}{
\r
2890 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_update(userAgreement, uuid)}\if{html}{\out{</div>}}
\r
2893 \subsection{Arguments}{
\r
2894 \if{html}{\out{<div class="arguments">}}
\r
2896 \item{\code{userAgreement}}{userAgreement object.}
\r
2898 \item{\code{uuid}}{The UUID of the userAgreement in question.}
\r
2900 \if{html}{\out{</div>}}
\r
2903 \if{html}{\out{<hr>}}
\r
2904 \if{html}{\out{<a id="method-Arvados-user_agreements_delete"></a>}}
\r
2905 \if{latex}{\out{\hypertarget{method-Arvados-user_agreements_delete}{}}}
\r
2906 \subsection{Method \code{user_agreements_delete()}}{
\r
2907 user_agreements_delete is a method defined in Arvados class.
\r
2908 \subsection{Usage}{
\r
2909 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_delete(uuid)}\if{html}{\out{</div>}}
\r
2912 \subsection{Arguments}{
\r
2913 \if{html}{\out{<div class="arguments">}}
\r
2915 \item{\code{uuid}}{The UUID of the userAgreement in question.}
\r
2917 \if{html}{\out{</div>}}
\r
2920 \if{html}{\out{<hr>}}
\r
2921 \if{html}{\out{<a id="method-Arvados-user_agreements_signatures"></a>}}
\r
2922 \if{latex}{\out{\hypertarget{method-Arvados-user_agreements_signatures}{}}}
\r
2923 \subsection{Method \code{user_agreements_signatures()}}{
\r
2924 user_agreements_signatures is a method defined in Arvados class.
\r
2925 \subsection{Usage}{
\r
2926 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_signatures()}\if{html}{\out{</div>}}
\r
2930 \if{html}{\out{<hr>}}
\r
2931 \if{html}{\out{<a id="method-Arvados-user_agreements_sign"></a>}}
\r
2932 \if{latex}{\out{\hypertarget{method-Arvados-user_agreements_sign}{}}}
\r
2933 \subsection{Method \code{user_agreements_sign()}}{
\r
2934 user_agreements_sign is a method defined in Arvados class.
\r
2935 \subsection{Usage}{
\r
2936 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_sign()}\if{html}{\out{</div>}}
\r
2940 \if{html}{\out{<hr>}}
\r
2941 \if{html}{\out{<a id="method-Arvados-user_agreements_list"></a>}}
\r
2942 \if{latex}{\out{\hypertarget{method-Arvados-user_agreements_list}{}}}
\r
2943 \subsection{Method \code{user_agreements_list()}}{
\r
2944 user_agreements_list is a method defined in Arvados class.
\r
2945 \subsection{Usage}{
\r
2946 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_list(
\r
2956 bypassFederation = NULL
\r
2957 )}\if{html}{\out{</div>}}
\r
2960 \subsection{Arguments}{
\r
2961 \if{html}{\out{<div class="arguments">}}
\r
2963 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
2965 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
2967 \if{html}{\out{</div>}}
\r
2970 \if{html}{\out{<hr>}}
\r
2971 \if{html}{\out{<a id="method-Arvados-user_agreements_new"></a>}}
\r
2972 \if{latex}{\out{\hypertarget{method-Arvados-user_agreements_new}{}}}
\r
2973 \subsection{Method \code{user_agreements_new()}}{
\r
2974 user_agreements_new is a method defined in Arvados class.
\r
2975 \subsection{Usage}{
\r
2976 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_new()}\if{html}{\out{</div>}}
\r
2980 \if{html}{\out{<hr>}}
\r
2981 \if{html}{\out{<a id="method-Arvados-configs_get"></a>}}
\r
2982 \if{latex}{\out{\hypertarget{method-Arvados-configs_get}{}}}
\r
2983 \subsection{Method \code{configs_get()}}{
\r
2984 configs_get is a method defined in Arvados class.
\r
2985 \subsection{Usage}{
\r
2986 \if{html}{\out{<div class="r">}}\preformatted{Arvados$configs_get()}\if{html}{\out{</div>}}
\r
2990 \if{html}{\out{<hr>}}
\r
2991 \if{html}{\out{<a id="method-Arvados-getHostName"></a>}}
\r
2992 \if{latex}{\out{\hypertarget{method-Arvados-getHostName}{}}}
\r
2993 \subsection{Method \code{getHostName()}}{
\r
2994 \subsection{Usage}{
\r
2995 \if{html}{\out{<div class="r">}}\preformatted{Arvados$getHostName()}\if{html}{\out{</div>}}
\r
2999 \if{html}{\out{<hr>}}
\r
3000 \if{html}{\out{<a id="method-Arvados-getToken"></a>}}
\r
3001 \if{latex}{\out{\hypertarget{method-Arvados-getToken}{}}}
\r
3002 \subsection{Method \code{getToken()}}{
\r
3003 \subsection{Usage}{
\r
3004 \if{html}{\out{<div class="r">}}\preformatted{Arvados$getToken()}\if{html}{\out{</div>}}
\r
3008 \if{html}{\out{<hr>}}
\r
3009 \if{html}{\out{<a id="method-Arvados-setRESTService"></a>}}
\r
3010 \if{latex}{\out{\hypertarget{method-Arvados-setRESTService}{}}}
\r
3011 \subsection{Method \code{setRESTService()}}{
\r
3012 \subsection{Usage}{
\r
3013 \if{html}{\out{<div class="r">}}\preformatted{Arvados$setRESTService(newREST)}\if{html}{\out{</div>}}
\r
3017 \if{html}{\out{<hr>}}
\r
3018 \if{html}{\out{<a id="method-Arvados-getRESTService"></a>}}
\r
3019 \if{latex}{\out{\hypertarget{method-Arvados-getRESTService}{}}}
\r
3020 \subsection{Method \code{getRESTService()}}{
\r
3021 \subsection{Usage}{
\r
3022 \if{html}{\out{<div class="r">}}\preformatted{Arvados$getRESTService()}\if{html}{\out{</div>}}
\r