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
21 arv$project_exist(uuid = projectUUID)
\r
23 ## ------------------------------------------------
\r
24 ## Method `Arvados$project_get`
\r
25 ## ------------------------------------------------
\r
27 project <- arv$project_get(uuid = projectUUID)
\r
29 ## ------------------------------------------------
\r
30 ## Method `Arvados$project_create`
\r
31 ## ------------------------------------------------
\r
33 Properties <- list() # should contain a list of new properties to be added
\r
34 new_project <- arv$project_create(name = "project name", description = "project description", owner_uuid = "project UUID", properties = NULL, ensureUniqueName = "false")
\r
36 ## ------------------------------------------------
\r
37 ## Method `Arvados$project_properties_set`
\r
38 ## ------------------------------------------------
\r
40 Properties <- list() # should contain a list of new properties to be added
\r
41 arv$project_properties_set(Properties, uuid)
\r
43 ## ------------------------------------------------
\r
44 ## Method `Arvados$project_properties_append`
\r
45 ## ------------------------------------------------
\r
47 newProperties <- list() # should contain a list of new properties to be added
\r
48 arv$project_properties_append(properties = newProperties, uuid)
\r
50 ## ------------------------------------------------
\r
51 ## Method `Arvados$project_properties_get`
\r
52 ## ------------------------------------------------
\r
54 arv$project_properties_get(projectUUID)
\r
56 ## ------------------------------------------------
\r
57 ## Method `Arvados$project_properties_delete`
\r
58 ## ------------------------------------------------
\r
60 Properties <- list() # should contain a list of new properties to be added
\r
61 arv$project_properties_delete(Properties, projectUUID)
\r
63 ## ------------------------------------------------
\r
64 ## Method `Arvados$project_update`
\r
65 ## ------------------------------------------------
\r
67 newProperties <- list() # should contain a list of new properties to be added
\r
68 arv$project_update(name = "new project name", properties = newProperties, uuid = projectUUID)
\r
70 ## ------------------------------------------------
\r
71 ## Method `Arvados$project_list`
\r
72 ## ------------------------------------------------
\r
74 listOfprojects <- arv$project_list(list(list("owner_uuid", "=", projectUUID))) # Sample query which show projects within the project of a given UUID
\r
76 ## ------------------------------------------------
\r
77 ## Method `Arvados$collections_create`
\r
78 ## ------------------------------------------------
\r
80 Properties <- list() # should contain a list of new properties to be added
\r
81 arv$collections_create(name = "collectionTitle", description = "collectionDescription", ownerUUID = "collectionOwner", properties = Properties)
\r
83 ## ------------------------------------------------
\r
84 ## Method `Arvados$collections_update`
\r
85 ## ------------------------------------------------
\r
87 collection <- arv$collections_create(name = "newCollectionTitle", description = "newCollectionDescription", ownerUUID = "collectionOwner", properties = NULL)
\r
89 ## ------------------------------------------------
\r
90 ## Method `Arvados$collections_delete`
\r
91 ## ------------------------------------------------
\r
93 arv$collection_delete(collectionUUID)
\r
95 ## ------------------------------------------------
\r
96 ## Method `Arvados$collections_provenance`
\r
97 ## ------------------------------------------------
\r
99 collection <- arv$collections_provenance(collectionUUID)
\r
101 ## ------------------------------------------------
\r
102 ## Method `Arvados$collections_trash`
\r
103 ## ------------------------------------------------
\r
105 arv$collections_trash(collectionUUID)
\r
107 ## ------------------------------------------------
\r
108 ## Method `Arvados$collections_untrash`
\r
109 ## ------------------------------------------------
\r
111 arv$collections_untrash(collectionUUID)
\r
113 ## ------------------------------------------------
\r
114 ## Method `Arvados$collections_list`
\r
115 ## ------------------------------------------------
\r
117 collectionList <- arv$collections.list(list(list("name", "=", "Example")))
\r
119 ## ------------------------------------------------
\r
120 ## Method `Arvados$project_permission_give`
\r
121 ## ------------------------------------------------
\r
123 arv$project_permission_give(type = "can_read", uuid = objectUUID, user = userUUID)
\r
125 ## ------------------------------------------------
\r
126 ## Method `Arvados$project_permission_refuse`
\r
127 ## ------------------------------------------------
\r
129 arv$project_permission_refuse(type = "can_read", uuid = objectUUID, user = userUUID)
\r
131 ## ------------------------------------------------
\r
132 ## Method `Arvados$project_permission_update`
\r
133 ## ------------------------------------------------
\r
135 arv$project_permission_update(typeOld = "can_read", typeNew = "can_write", uuid = objectUUID, user = userUUID)
\r
137 ## ------------------------------------------------
\r
138 ## Method `Arvados$project_permission_check`
\r
139 ## ------------------------------------------------
\r
141 arv$project_permission_check(type = "can_read", uuid = objectUUID, user = userUUID)
\r
144 \subsection{Public methods}{
\r
146 \item \href{#method-new}{\code{Arvados$new()}}
\r
147 \item \href{#method-project_exist}{\code{Arvados$project_exist()}}
\r
148 \item \href{#method-project_get}{\code{Arvados$project_get()}}
\r
149 \item \href{#method-project_create}{\code{Arvados$project_create()}}
\r
150 \item \href{#method-project_properties_set}{\code{Arvados$project_properties_set()}}
\r
151 \item \href{#method-project_properties_append}{\code{Arvados$project_properties_append()}}
\r
152 \item \href{#method-project_properties_get}{\code{Arvados$project_properties_get()}}
\r
153 \item \href{#method-project_properties_delete}{\code{Arvados$project_properties_delete()}}
\r
154 \item \href{#method-project_update}{\code{Arvados$project_update()}}
\r
155 \item \href{#method-project_list}{\code{Arvados$project_list()}}
\r
156 \item \href{#method-project_delete}{\code{Arvados$project_delete()}}
\r
157 \item \href{#method-api_clients_get}{\code{Arvados$api_clients_get()}}
\r
158 \item \href{#method-api_clients_create}{\code{Arvados$api_clients_create()}}
\r
159 \item \href{#method-api_clients_update}{\code{Arvados$api_clients_update()}}
\r
160 \item \href{#method-api_clients_delete}{\code{Arvados$api_clients_delete()}}
\r
161 \item \href{#method-api_clients_list}{\code{Arvados$api_clients_list()}}
\r
162 \item \href{#method-api_client_authorizations_get}{\code{Arvados$api_client_authorizations_get()}}
\r
163 \item \href{#method-api_client_authorizations_create}{\code{Arvados$api_client_authorizations_create()}}
\r
164 \item \href{#method-api_client_authorizations_update}{\code{Arvados$api_client_authorizations_update()}}
\r
165 \item \href{#method-api_client_authorizations_delete}{\code{Arvados$api_client_authorizations_delete()}}
\r
166 \item \href{#method-api_client_authorizations_create_system_auth}{\code{Arvados$api_client_authorizations_create_system_auth()}}
\r
167 \item \href{#method-api_client_authorizations_current}{\code{Arvados$api_client_authorizations_current()}}
\r
168 \item \href{#method-api_client_authorizations_list}{\code{Arvados$api_client_authorizations_list()}}
\r
169 \item \href{#method-authorized_keys_get}{\code{Arvados$authorized_keys_get()}}
\r
170 \item \href{#method-authorized_keys_create}{\code{Arvados$authorized_keys_create()}}
\r
171 \item \href{#method-authorized_keys_update}{\code{Arvados$authorized_keys_update()}}
\r
172 \item \href{#method-authorized_keys_delete}{\code{Arvados$authorized_keys_delete()}}
\r
173 \item \href{#method-authorized_keys_list}{\code{Arvados$authorized_keys_list()}}
\r
174 \item \href{#method-collections_get}{\code{Arvados$collections_get()}}
\r
175 \item \href{#method-collections_create}{\code{Arvados$collections_create()}}
\r
176 \item \href{#method-collections_update}{\code{Arvados$collections_update()}}
\r
177 \item \href{#method-collections_delete}{\code{Arvados$collections_delete()}}
\r
178 \item \href{#method-collections_provenance}{\code{Arvados$collections_provenance()}}
\r
179 \item \href{#method-collections_used_by}{\code{Arvados$collections_used_by()}}
\r
180 \item \href{#method-collections_trash}{\code{Arvados$collections_trash()}}
\r
181 \item \href{#method-collections_untrash}{\code{Arvados$collections_untrash()}}
\r
182 \item \href{#method-collections_list}{\code{Arvados$collections_list()}}
\r
183 \item \href{#method-containers_get}{\code{Arvados$containers_get()}}
\r
184 \item \href{#method-containers_create}{\code{Arvados$containers_create()}}
\r
185 \item \href{#method-containers_update}{\code{Arvados$containers_update()}}
\r
186 \item \href{#method-containers_delete}{\code{Arvados$containers_delete()}}
\r
187 \item \href{#method-containers_auth}{\code{Arvados$containers_auth()}}
\r
188 \item \href{#method-containers_lock}{\code{Arvados$containers_lock()}}
\r
189 \item \href{#method-containers_unlock}{\code{Arvados$containers_unlock()}}
\r
190 \item \href{#method-containers_secret_mounts}{\code{Arvados$containers_secret_mounts()}}
\r
191 \item \href{#method-containers_current}{\code{Arvados$containers_current()}}
\r
192 \item \href{#method-containers_list}{\code{Arvados$containers_list()}}
\r
193 \item \href{#method-container_requests_get}{\code{Arvados$container_requests_get()}}
\r
194 \item \href{#method-container_requests_create}{\code{Arvados$container_requests_create()}}
\r
195 \item \href{#method-container_requests_update}{\code{Arvados$container_requests_update()}}
\r
196 \item \href{#method-container_requests_delete}{\code{Arvados$container_requests_delete()}}
\r
197 \item \href{#method-container_requests_list}{\code{Arvados$container_requests_list()}}
\r
198 \item \href{#method-groups_get}{\code{Arvados$groups_get()}}
\r
199 \item \href{#method-groups_create}{\code{Arvados$groups_create()}}
\r
200 \item \href{#method-groups_update}{\code{Arvados$groups_update()}}
\r
201 \item \href{#method-groups_delete}{\code{Arvados$groups_delete()}}
\r
202 \item \href{#method-groups_contents}{\code{Arvados$groups_contents()}}
\r
203 \item \href{#method-groups_shared}{\code{Arvados$groups_shared()}}
\r
204 \item \href{#method-groups_trash}{\code{Arvados$groups_trash()}}
\r
205 \item \href{#method-groups_untrash}{\code{Arvados$groups_untrash()}}
\r
206 \item \href{#method-groups_list}{\code{Arvados$groups_list()}}
\r
207 \item \href{#method-keep_services_get}{\code{Arvados$keep_services_get()}}
\r
208 \item \href{#method-keep_services_create}{\code{Arvados$keep_services_create()}}
\r
209 \item \href{#method-keep_services_update}{\code{Arvados$keep_services_update()}}
\r
210 \item \href{#method-keep_services_delete}{\code{Arvados$keep_services_delete()}}
\r
211 \item \href{#method-keep_services_accessible}{\code{Arvados$keep_services_accessible()}}
\r
212 \item \href{#method-keep_services_list}{\code{Arvados$keep_services_list()}}
\r
213 \item \href{#method-project_permission_give}{\code{Arvados$project_permission_give()}}
\r
214 \item \href{#method-project_permission_refuse}{\code{Arvados$project_permission_refuse()}}
\r
215 \item \href{#method-project_permission_update}{\code{Arvados$project_permission_update()}}
\r
216 \item \href{#method-project_permission_check}{\code{Arvados$project_permission_check()}}
\r
217 \item \href{#method-links_get}{\code{Arvados$links_get()}}
\r
218 \item \href{#method-links_create}{\code{Arvados$links_create()}}
\r
219 \item \href{#method-links_update}{\code{Arvados$links_update()}}
\r
220 \item \href{#method-links_delete}{\code{Arvados$links_delete()}}
\r
221 \item \href{#method-links_list}{\code{Arvados$links_list()}}
\r
222 \item \href{#method-links_get_permissions}{\code{Arvados$links_get_permissions()}}
\r
223 \item \href{#method-logs_get}{\code{Arvados$logs_get()}}
\r
224 \item \href{#method-logs_create}{\code{Arvados$logs_create()}}
\r
225 \item \href{#method-logs_update}{\code{Arvados$logs_update()}}
\r
226 \item \href{#method-logs_delete}{\code{Arvados$logs_delete()}}
\r
227 \item \href{#method-logs_list}{\code{Arvados$logs_list()}}
\r
228 \item \href{#method-users_get}{\code{Arvados$users_get()}}
\r
229 \item \href{#method-users_create}{\code{Arvados$users_create()}}
\r
230 \item \href{#method-users_update}{\code{Arvados$users_update()}}
\r
231 \item \href{#method-users_delete}{\code{Arvados$users_delete()}}
\r
232 \item \href{#method-users_current}{\code{Arvados$users_current()}}
\r
233 \item \href{#method-users_system}{\code{Arvados$users_system()}}
\r
234 \item \href{#method-users_activate}{\code{Arvados$users_activate()}}
\r
235 \item \href{#method-users_setup}{\code{Arvados$users_setup()}}
\r
236 \item \href{#method-users_unsetup}{\code{Arvados$users_unsetup()}}
\r
237 \item \href{#method-users_merge}{\code{Arvados$users_merge()}}
\r
238 \item \href{#method-users_list}{\code{Arvados$users_list()}}
\r
239 \item \href{#method-repositories_get}{\code{Arvados$repositories_get()}}
\r
240 \item \href{#method-repositories_create}{\code{Arvados$repositories_create()}}
\r
241 \item \href{#method-repositories_update}{\code{Arvados$repositories_update()}}
\r
242 \item \href{#method-repositories_delete}{\code{Arvados$repositories_delete()}}
\r
243 \item \href{#method-repositories_get_all_permissions}{\code{Arvados$repositories_get_all_permissions()}}
\r
244 \item \href{#method-repositories_list}{\code{Arvados$repositories_list()}}
\r
245 \item \href{#method-virtual_machines_get}{\code{Arvados$virtual_machines_get()}}
\r
246 \item \href{#method-virtual_machines_create}{\code{Arvados$virtual_machines_create()}}
\r
247 \item \href{#method-virtual_machines_update}{\code{Arvados$virtual_machines_update()}}
\r
248 \item \href{#method-virtual_machines_delete}{\code{Arvados$virtual_machines_delete()}}
\r
249 \item \href{#method-virtual_machines_logins}{\code{Arvados$virtual_machines_logins()}}
\r
250 \item \href{#method-virtual_machines_get_all_logins}{\code{Arvados$virtual_machines_get_all_logins()}}
\r
251 \item \href{#method-virtual_machines_list}{\code{Arvados$virtual_machines_list()}}
\r
252 \item \href{#method-workflows_get}{\code{Arvados$workflows_get()}}
\r
253 \item \href{#method-workflows_create}{\code{Arvados$workflows_create()}}
\r
254 \item \href{#method-workflows_update}{\code{Arvados$workflows_update()}}
\r
255 \item \href{#method-workflows_delete}{\code{Arvados$workflows_delete()}}
\r
256 \item \href{#method-workflows_list}{\code{Arvados$workflows_list()}}
\r
257 \item \href{#method-user_agreements_get}{\code{Arvados$user_agreements_get()}}
\r
258 \item \href{#method-user_agreements_create}{\code{Arvados$user_agreements_create()}}
\r
259 \item \href{#method-user_agreements_update}{\code{Arvados$user_agreements_update()}}
\r
260 \item \href{#method-user_agreements_delete}{\code{Arvados$user_agreements_delete()}}
\r
261 \item \href{#method-user_agreements_signatures}{\code{Arvados$user_agreements_signatures()}}
\r
262 \item \href{#method-user_agreements_sign}{\code{Arvados$user_agreements_sign()}}
\r
263 \item \href{#method-user_agreements_list}{\code{Arvados$user_agreements_list()}}
\r
264 \item \href{#method-user_agreements_new}{\code{Arvados$user_agreements_new()}}
\r
265 \item \href{#method-configs_get}{\code{Arvados$configs_get()}}
\r
266 \item \href{#method-getHostName}{\code{Arvados$getHostName()}}
\r
267 \item \href{#method-getToken}{\code{Arvados$getToken()}}
\r
268 \item \href{#method-setRESTService}{\code{Arvados$setRESTService()}}
\r
269 \item \href{#method-getRESTService}{\code{Arvados$getRESTService()}}
\r
272 \if{html}{\out{<hr>}}
\r
273 \if{html}{\out{<a id="method-new"></a>}}
\r
274 \if{latex}{\out{\hypertarget{method-new}{}}}
\r
275 \subsection{Method \code{new()}}{
\r
276 Initialize new enviroment.
\r
277 \subsection{Usage}{
\r
278 \if{html}{\out{<div class="r">}}\preformatted{Arvados$new(authToken = NULL, hostName = NULL, numRetries = 0)}\if{html}{\out{</div>}}
\r
281 \subsection{Arguments}{
\r
282 \if{html}{\out{<div class="arguments">}}
\r
284 \item{\code{authToken}}{ARVADOS_API_TOKEN from 'Get API Token' on Arvados.}
\r
286 \item{\code{hostName}}{ARVADOS_API_HOST from 'Get API Token' on Arvados.}
\r
288 \item{\code{numRetries}}{Specify number of times to retry failed service requests.}
\r
290 \if{html}{\out{</div>}}
\r
292 \subsection{Returns}{
\r
293 A new `Arvados` object.
\r
295 \subsection{Examples}{
\r
296 \if{html}{\out{<div class="r example copy">}}
\r
297 \preformatted{arv <- Arvados$new(authToken = "ARVADOS_API_TOKEN", hostName = "ARVADOS_API_HOST", numRetries = 3)
\r
299 \if{html}{\out{</div>}}
\r
304 \if{html}{\out{<hr>}}
\r
305 \if{html}{\out{<a id="method-project_exist"></a>}}
\r
306 \if{latex}{\out{\hypertarget{method-project_exist}{}}}
\r
307 \subsection{Method \code{project_exist()}}{
\r
308 project_exist enables checking if the project with such a UUID exist.
\r
309 \subsection{Usage}{
\r
310 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_exist(uuid)}\if{html}{\out{</div>}}
\r
313 \subsection{Arguments}{
\r
314 \if{html}{\out{<div class="arguments">}}
\r
316 \item{\code{uuid}}{The UUID of a project or a file.}
\r
318 \if{html}{\out{</div>}}
\r
320 \subsection{Examples}{
\r
321 \if{html}{\out{<div class="r example copy">}}
\r
322 \preformatted{arv$project_exist(uuid = projectUUID)
\r
324 \if{html}{\out{</div>}}
\r
329 \if{html}{\out{<hr>}}
\r
330 \if{html}{\out{<a id="method-project_get"></a>}}
\r
331 \if{latex}{\out{\hypertarget{method-project_get}{}}}
\r
332 \subsection{Method \code{project_get()}}{
\r
333 project_get returns the demanded project.
\r
334 \subsection{Usage}{
\r
335 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_get(uuid)}\if{html}{\out{</div>}}
\r
338 \subsection{Arguments}{
\r
339 \if{html}{\out{<div class="arguments">}}
\r
341 \item{\code{uuid}}{The UUID of the Group in question.}
\r
343 \if{html}{\out{</div>}}
\r
345 \subsection{Examples}{
\r
346 \if{html}{\out{<div class="r example copy">}}
\r
347 \preformatted{project <- arv$project_get(uuid = projectUUID)
\r
349 \if{html}{\out{</div>}}
\r
354 \if{html}{\out{<hr>}}
\r
355 \if{html}{\out{<a id="method-project_create"></a>}}
\r
356 \if{latex}{\out{\hypertarget{method-project_create}{}}}
\r
357 \subsection{Method \code{project_create()}}{
\r
358 project_create creates a new project of a given name and description.
\r
359 \subsection{Usage}{
\r
360 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_create(
\r
365 ensureUniqueName = "false"
\r
366 )}\if{html}{\out{</div>}}
\r
369 \subsection{Arguments}{
\r
370 \if{html}{\out{<div class="arguments">}}
\r
372 \item{\code{name}}{Name of the project.}
\r
374 \item{\code{description}}{Description of the project.}
\r
376 \item{\code{ownerUUID}}{The UUID of the maternal project to created one.}
\r
378 \item{\code{properties}}{List of the properties of the project.}
\r
380 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
382 \if{html}{\out{</div>}}
\r
384 \subsection{Examples}{
\r
385 \if{html}{\out{<div class="r example copy">}}
\r
386 \preformatted{Properties <- list() # should contain a list of new properties to be added
\r
387 new_project <- arv$project_create(name = "project name", description = "project description", owner_uuid = "project UUID", properties = NULL, ensureUniqueName = "false")
\r
389 \if{html}{\out{</div>}}
\r
394 \if{html}{\out{<hr>}}
\r
395 \if{html}{\out{<a id="method-project_properties_set"></a>}}
\r
396 \if{latex}{\out{\hypertarget{method-project_properties_set}{}}}
\r
397 \subsection{Method \code{project_properties_set()}}{
\r
398 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
399 \subsection{Usage}{
\r
400 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_properties_set(listProperties, uuid)}\if{html}{\out{</div>}}
\r
403 \subsection{Arguments}{
\r
404 \if{html}{\out{<div class="arguments">}}
\r
406 \item{\code{listProperties}}{List of new properties.}
\r
408 \item{\code{uuid}}{The UUID of a project or a file.}
\r
410 \if{html}{\out{</div>}}
\r
412 \subsection{Examples}{
\r
413 \if{html}{\out{<div class="r example copy">}}
\r
414 \preformatted{Properties <- list() # should contain a list of new properties to be added
\r
415 arv$project_properties_set(Properties, uuid)
\r
417 \if{html}{\out{</div>}}
\r
422 \if{html}{\out{<hr>}}
\r
423 \if{html}{\out{<a id="method-project_properties_append"></a>}}
\r
424 \if{latex}{\out{\hypertarget{method-project_properties_append}{}}}
\r
425 \subsection{Method \code{project_properties_append()}}{
\r
426 project_properties_append is a method defined in Arvados class that enables appending properties. Allows to add new properties.
\r
427 \subsection{Usage}{
\r
428 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_properties_append(properties, uuid)}\if{html}{\out{</div>}}
\r
431 \subsection{Arguments}{
\r
432 \if{html}{\out{<div class="arguments">}}
\r
434 \item{\code{uuid}}{The UUID of a project or a file.}
\r
436 \item{\code{listOfNewProperties}}{List of new properties.}
\r
438 \if{html}{\out{</div>}}
\r
440 \subsection{Examples}{
\r
441 \if{html}{\out{<div class="r example copy">}}
\r
442 \preformatted{newProperties <- list() # should contain a list of new properties to be added
\r
443 arv$project_properties_append(properties = newProperties, uuid)
\r
445 \if{html}{\out{</div>}}
\r
450 \if{html}{\out{<hr>}}
\r
451 \if{html}{\out{<a id="method-project_properties_get"></a>}}
\r
452 \if{latex}{\out{\hypertarget{method-project_properties_get}{}}}
\r
453 \subsection{Method \code{project_properties_get()}}{
\r
454 project_properties_get is a method defined in Arvados class that returns properties.
\r
455 \subsection{Usage}{
\r
456 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_properties_get(uuid)}\if{html}{\out{</div>}}
\r
459 \subsection{Arguments}{
\r
460 \if{html}{\out{<div class="arguments">}}
\r
462 \item{\code{uuid}}{The UUID of a project or a file.}
\r
464 \if{html}{\out{</div>}}
\r
466 \subsection{Examples}{
\r
467 \if{html}{\out{<div class="r example copy">}}
\r
468 \preformatted{arv$project_properties_get(projectUUID)
\r
470 \if{html}{\out{</div>}}
\r
475 \if{html}{\out{<hr>}}
\r
476 \if{html}{\out{<a id="method-project_properties_delete"></a>}}
\r
477 \if{latex}{\out{\hypertarget{method-project_properties_delete}{}}}
\r
478 \subsection{Method \code{project_properties_delete()}}{
\r
479 project_properties_delete is a method defined in Arvados class that deletes list of properties.
\r
480 \subsection{Usage}{
\r
481 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_properties_delete(oneProp, uuid)}\if{html}{\out{</div>}}
\r
484 \subsection{Arguments}{
\r
485 \if{html}{\out{<div class="arguments">}}
\r
487 \item{\code{oneProp}}{Property to be deleted.}
\r
489 \item{\code{uuid}}{The UUID of a project or a file.}
\r
491 \if{html}{\out{</div>}}
\r
493 \subsection{Examples}{
\r
494 \if{html}{\out{<div class="r example copy">}}
\r
495 \preformatted{Properties <- list() # should contain a list of new properties to be added
\r
496 arv$project_properties_delete(Properties, projectUUID)
\r
498 \if{html}{\out{</div>}}
\r
503 \if{html}{\out{<hr>}}
\r
504 \if{html}{\out{<a id="method-project_update"></a>}}
\r
505 \if{latex}{\out{\hypertarget{method-project_update}{}}}
\r
506 \subsection{Method \code{project_update()}}{
\r
507 project_update enables updating project. New name, description and properties may be given.
\r
508 \subsection{Usage}{
\r
509 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_update(..., uuid)}\if{html}{\out{</div>}}
\r
512 \subsection{Arguments}{
\r
513 \if{html}{\out{<div class="arguments">}}
\r
515 \item{\code{...}}{Feature to be updated (name, description, properties).}
\r
517 \item{\code{uuid}}{The UUID of a project in question.}
\r
519 \if{html}{\out{</div>}}
\r
521 \subsection{Examples}{
\r
522 \if{html}{\out{<div class="r example copy">}}
\r
523 \preformatted{newProperties <- list() # should contain a list of new properties to be added
\r
524 arv$project_update(name = "new project name", properties = newProperties, uuid = projectUUID)
\r
526 \if{html}{\out{</div>}}
\r
531 \if{html}{\out{<hr>}}
\r
532 \if{html}{\out{<a id="method-project_list"></a>}}
\r
533 \if{latex}{\out{\hypertarget{method-project_list}{}}}
\r
534 \subsection{Method \code{project_list()}}{
\r
535 project_list enables listing project by its name, uuid, properties, permissions.
\r
536 \subsection{Usage}{
\r
537 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_list(
\r
546 includeTrash = NULL
\r
547 )}\if{html}{\out{</div>}}
\r
550 \subsection{Arguments}{
\r
551 \if{html}{\out{<div class="arguments">}}
\r
553 \item{\code{includeTrash}}{Include items whose is_trashed attribute is true.}
\r
555 \item{\code{uuid}}{The UUID of a project in question.}
\r
557 \item{\code{recursive}}{Include contents from child groups recursively.}
\r
559 \if{html}{\out{</div>}}
\r
561 \subsection{Examples}{
\r
562 \if{html}{\out{<div class="r example copy">}}
\r
563 \preformatted{listOfprojects <- arv$project_list(list(list("owner_uuid", "=", projectUUID))) # Sample query which show projects within the project of a given UUID
\r
565 \if{html}{\out{</div>}}
\r
570 \if{html}{\out{<hr>}}
\r
571 \if{html}{\out{<a id="method-project_delete"></a>}}
\r
572 \if{latex}{\out{\hypertarget{method-project_delete}{}}}
\r
573 \subsection{Method \code{project_delete()}}{
\r
574 project_delete trashes project of a given uuid. It can be restored from trash or deleted permanently.
\r
575 \subsection{Usage}{
\r
576 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_delete(uuid)}\if{html}{\out{</div>}}
\r
579 \subsection{Arguments}{
\r
580 \if{html}{\out{<div class="arguments">}}
\r
582 \item{\code{uuid}}{The UUID of the Group in question.}
\r
584 \if{html}{\out{</div>}}
\r
587 \if{html}{\out{<hr>}}
\r
588 \if{html}{\out{<a id="method-api_clients_get"></a>}}
\r
589 \if{latex}{\out{\hypertarget{method-api_clients_get}{}}}
\r
590 \subsection{Method \code{api_clients_get()}}{
\r
591 api_clients_get is a method defined in Arvados class.
\r
592 \subsection{Usage}{
\r
593 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_clients_get(uuid)}\if{html}{\out{</div>}}
\r
596 \subsection{Arguments}{
\r
597 \if{html}{\out{<div class="arguments">}}
\r
599 \item{\code{uuid}}{The UUID of the apiClient in question.}
\r
601 \if{html}{\out{</div>}}
\r
604 \if{html}{\out{<hr>}}
\r
605 \if{html}{\out{<a id="method-api_clients_create"></a>}}
\r
606 \if{latex}{\out{\hypertarget{method-api_clients_create}{}}}
\r
607 \subsection{Method \code{api_clients_create()}}{
\r
608 api_clients_create is a method defined in Arvados class.
\r
609 \subsection{Usage}{
\r
610 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_clients_create(
\r
612 ensureUniqueName = "false",
\r
614 )}\if{html}{\out{</div>}}
\r
617 \subsection{Arguments}{
\r
618 \if{html}{\out{<div class="arguments">}}
\r
620 \item{\code{apiClient}}{apiClient object.}
\r
622 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
624 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
626 \if{html}{\out{</div>}}
\r
629 \if{html}{\out{<hr>}}
\r
630 \if{html}{\out{<a id="method-api_clients_update"></a>}}
\r
631 \if{latex}{\out{\hypertarget{method-api_clients_update}{}}}
\r
632 \subsection{Method \code{api_clients_update()}}{
\r
633 api_clients_update is a method defined in Arvados class.
\r
634 \subsection{Usage}{
\r
635 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_clients_update(apiClient, uuid)}\if{html}{\out{</div>}}
\r
638 \subsection{Arguments}{
\r
639 \if{html}{\out{<div class="arguments">}}
\r
641 \item{\code{apiClient}}{apiClient object.}
\r
643 \item{\code{uuid}}{The UUID of the apiClient in question.}
\r
645 \if{html}{\out{</div>}}
\r
648 \if{html}{\out{<hr>}}
\r
649 \if{html}{\out{<a id="method-api_clients_delete"></a>}}
\r
650 \if{latex}{\out{\hypertarget{method-api_clients_delete}{}}}
\r
651 \subsection{Method \code{api_clients_delete()}}{
\r
652 api_clients_delete is a method defined in Arvados class.
\r
653 \subsection{Usage}{
\r
654 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_clients_delete(uuid)}\if{html}{\out{</div>}}
\r
657 \subsection{Arguments}{
\r
658 \if{html}{\out{<div class="arguments">}}
\r
660 \item{\code{uuid}}{The UUID of the apiClient in question.}
\r
662 \if{html}{\out{</div>}}
\r
665 \if{html}{\out{<hr>}}
\r
666 \if{html}{\out{<a id="method-api_clients_list"></a>}}
\r
667 \if{latex}{\out{\hypertarget{method-api_clients_list}{}}}
\r
668 \subsection{Method \code{api_clients_list()}}{
\r
669 api_clients_list is a method defined in Arvados class.
\r
670 \subsection{Usage}{
\r
671 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_clients_list(
\r
681 bypassFederation = NULL
\r
682 )}\if{html}{\out{</div>}}
\r
685 \subsection{Arguments}{
\r
686 \if{html}{\out{<div class="arguments">}}
\r
688 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
690 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
692 \if{html}{\out{</div>}}
\r
695 \if{html}{\out{<hr>}}
\r
696 \if{html}{\out{<a id="method-api_client_authorizations_get"></a>}}
\r
697 \if{latex}{\out{\hypertarget{method-api_client_authorizations_get}{}}}
\r
698 \subsection{Method \code{api_client_authorizations_get()}}{
\r
699 api_client_authorizations_get is a method defined in Arvados class.
\r
700 \subsection{Usage}{
\r
701 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_get(uuid)}\if{html}{\out{</div>}}
\r
704 \subsection{Arguments}{
\r
705 \if{html}{\out{<div class="arguments">}}
\r
707 \item{\code{uuid}}{The UUID of the apiClientAuthorization in question.}
\r
709 \if{html}{\out{</div>}}
\r
712 \if{html}{\out{<hr>}}
\r
713 \if{html}{\out{<a id="method-api_client_authorizations_create"></a>}}
\r
714 \if{latex}{\out{\hypertarget{method-api_client_authorizations_create}{}}}
\r
715 \subsection{Method \code{api_client_authorizations_create()}}{
\r
716 api_client_authorizations_create is a method defined in Arvados class.
\r
717 \subsection{Usage}{
\r
718 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_create(
\r
719 apiClientAuthorization,
\r
720 ensureUniqueName = "false",
\r
722 )}\if{html}{\out{</div>}}
\r
725 \subsection{Arguments}{
\r
726 \if{html}{\out{<div class="arguments">}}
\r
728 \item{\code{apiClientAuthorization}}{apiClientAuthorization object.}
\r
730 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error on (ownerUUID, name) collision_}
\r
732 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
734 \if{html}{\out{</div>}}
\r
737 \if{html}{\out{<hr>}}
\r
738 \if{html}{\out{<a id="method-api_client_authorizations_update"></a>}}
\r
739 \if{latex}{\out{\hypertarget{method-api_client_authorizations_update}{}}}
\r
740 \subsection{Method \code{api_client_authorizations_update()}}{
\r
741 api_client_authorizations_update is a method defined in Arvados class.
\r
742 \subsection{Usage}{
\r
743 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_update(apiClientAuthorization, uuid)}\if{html}{\out{</div>}}
\r
746 \subsection{Arguments}{
\r
747 \if{html}{\out{<div class="arguments">}}
\r
749 \item{\code{apiClientAuthorization}}{apiClientAuthorization object.}
\r
751 \item{\code{uuid}}{The UUID of the apiClientAuthorization in question.}
\r
753 \if{html}{\out{</div>}}
\r
756 \if{html}{\out{<hr>}}
\r
757 \if{html}{\out{<a id="method-api_client_authorizations_delete"></a>}}
\r
758 \if{latex}{\out{\hypertarget{method-api_client_authorizations_delete}{}}}
\r
759 \subsection{Method \code{api_client_authorizations_delete()}}{
\r
760 api_client_authorizations_delete is a method defined in Arvados class.
\r
761 \subsection{Usage}{
\r
762 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_delete(uuid)}\if{html}{\out{</div>}}
\r
765 \subsection{Arguments}{
\r
766 \if{html}{\out{<div class="arguments">}}
\r
768 \item{\code{uuid}}{The UUID of the apiClientAuthorization in question.}
\r
770 \if{html}{\out{</div>}}
\r
773 \if{html}{\out{<hr>}}
\r
774 \if{html}{\out{<a id="method-api_client_authorizations_create_system_auth"></a>}}
\r
775 \if{latex}{\out{\hypertarget{method-api_client_authorizations_create_system_auth}{}}}
\r
776 \subsection{Method \code{api_client_authorizations_create_system_auth()}}{
\r
777 api_client_authorizations_create_system_auth is a method defined in Arvados class.
\r
778 \subsection{Usage}{
\r
779 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_create_system_auth(
\r
780 apiClientID = NULL,
\r
782 )}\if{html}{\out{</div>}}
\r
786 \if{html}{\out{<hr>}}
\r
787 \if{html}{\out{<a id="method-api_client_authorizations_current"></a>}}
\r
788 \if{latex}{\out{\hypertarget{method-api_client_authorizations_current}{}}}
\r
789 \subsection{Method \code{api_client_authorizations_current()}}{
\r
790 api_client_authorizations_current is a method defined in Arvados class.
\r
791 \subsection{Usage}{
\r
792 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_current()}\if{html}{\out{</div>}}
\r
796 \if{html}{\out{<hr>}}
\r
797 \if{html}{\out{<a id="method-api_client_authorizations_list"></a>}}
\r
798 \if{latex}{\out{\hypertarget{method-api_client_authorizations_list}{}}}
\r
799 \subsection{Method \code{api_client_authorizations_list()}}{
\r
800 api_client_authorizations_list is a method defined in Arvados class.
\r
801 \subsection{Usage}{
\r
802 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_list(
\r
812 bypassFederation = NULL
\r
813 )}\if{html}{\out{</div>}}
\r
816 \subsection{Arguments}{
\r
817 \if{html}{\out{<div class="arguments">}}
\r
819 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
821 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
823 \if{html}{\out{</div>}}
\r
826 \if{html}{\out{<hr>}}
\r
827 \if{html}{\out{<a id="method-authorized_keys_get"></a>}}
\r
828 \if{latex}{\out{\hypertarget{method-authorized_keys_get}{}}}
\r
829 \subsection{Method \code{authorized_keys_get()}}{
\r
830 authorized_keys_get is a method defined in Arvados class.
\r
831 \subsection{Usage}{
\r
832 \if{html}{\out{<div class="r">}}\preformatted{Arvados$authorized_keys_get(uuid)}\if{html}{\out{</div>}}
\r
835 \subsection{Arguments}{
\r
836 \if{html}{\out{<div class="arguments">}}
\r
838 \item{\code{uuid}}{The UUID of the authorizedKey in question.}
\r
840 \if{html}{\out{</div>}}
\r
843 \if{html}{\out{<hr>}}
\r
844 \if{html}{\out{<a id="method-authorized_keys_create"></a>}}
\r
845 \if{latex}{\out{\hypertarget{method-authorized_keys_create}{}}}
\r
846 \subsection{Method \code{authorized_keys_create()}}{
\r
847 authorized_keys_create is a method defined in Arvados class.
\r
848 \subsection{Usage}{
\r
849 \if{html}{\out{<div class="r">}}\preformatted{Arvados$authorized_keys_create(
\r
851 ensureUniqueName = "false",
\r
853 )}\if{html}{\out{</div>}}
\r
856 \subsection{Arguments}{
\r
857 \if{html}{\out{<div class="arguments">}}
\r
859 \item{\code{authorizedKey}}{authorizedKey object.}
\r
861 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
863 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
865 \if{html}{\out{</div>}}
\r
868 \if{html}{\out{<hr>}}
\r
869 \if{html}{\out{<a id="method-authorized_keys_update"></a>}}
\r
870 \if{latex}{\out{\hypertarget{method-authorized_keys_update}{}}}
\r
871 \subsection{Method \code{authorized_keys_update()}}{
\r
872 authorized_keys_update is a method defined in Arvados class.
\r
873 \subsection{Usage}{
\r
874 \if{html}{\out{<div class="r">}}\preformatted{Arvados$authorized_keys_update(authorizedKey, uuid)}\if{html}{\out{</div>}}
\r
877 \subsection{Arguments}{
\r
878 \if{html}{\out{<div class="arguments">}}
\r
880 \item{\code{authorizedKey}}{authorizedKey object.}
\r
882 \item{\code{uuid}}{The UUID of the authorizedKey in question.}
\r
884 \if{html}{\out{</div>}}
\r
887 \if{html}{\out{<hr>}}
\r
888 \if{html}{\out{<a id="method-authorized_keys_delete"></a>}}
\r
889 \if{latex}{\out{\hypertarget{method-authorized_keys_delete}{}}}
\r
890 \subsection{Method \code{authorized_keys_delete()}}{
\r
891 authorized_keys_delete is a method defined in Arvados class.
\r
892 \subsection{Usage}{
\r
893 \if{html}{\out{<div class="r">}}\preformatted{Arvados$authorized_keys_delete(uuid)}\if{html}{\out{</div>}}
\r
896 \subsection{Arguments}{
\r
897 \if{html}{\out{<div class="arguments">}}
\r
899 \item{\code{uuid}}{The UUID of the authorizedKey in question.}
\r
901 \if{html}{\out{</div>}}
\r
904 \if{html}{\out{<hr>}}
\r
905 \if{html}{\out{<a id="method-authorized_keys_list"></a>}}
\r
906 \if{latex}{\out{\hypertarget{method-authorized_keys_list}{}}}
\r
907 \subsection{Method \code{authorized_keys_list()}}{
\r
908 authorized_keys_list is a method defined in Arvados class.
\r
909 \subsection{Usage}{
\r
910 \if{html}{\out{<div class="r">}}\preformatted{Arvados$authorized_keys_list(
\r
920 bypassFederation = NULL
\r
921 )}\if{html}{\out{</div>}}
\r
924 \subsection{Arguments}{
\r
925 \if{html}{\out{<div class="arguments">}}
\r
927 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
929 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
931 \if{html}{\out{</div>}}
\r
934 \if{html}{\out{<hr>}}
\r
935 \if{html}{\out{<a id="method-collections_get"></a>}}
\r
936 \if{latex}{\out{\hypertarget{method-collections_get}{}}}
\r
937 \subsection{Method \code{collections_get()}}{
\r
938 collections_get is a method defined in Arvados class.
\r
939 \subsection{Usage}{
\r
940 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_get(uuid)}\if{html}{\out{</div>}}
\r
943 \subsection{Arguments}{
\r
944 \if{html}{\out{<div class="arguments">}}
\r
946 \item{\code{uuid}}{The UUID of the Collection in question.
\r
947 collection <- arv$collections_get(uuid = collectionUUID)}
\r
949 \if{html}{\out{</div>}}
\r
952 \if{html}{\out{<hr>}}
\r
953 \if{html}{\out{<a id="method-collections_create"></a>}}
\r
954 \if{latex}{\out{\hypertarget{method-collections_create}{}}}
\r
955 \subsection{Method \code{collections_create()}}{
\r
956 collections_create is a method defined in Arvados class that enables collections creation.
\r
957 \subsection{Usage}{
\r
958 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_create(
\r
963 ensureUniqueName = "false",
\r
965 )}\if{html}{\out{</div>}}
\r
968 \subsection{Arguments}{
\r
969 \if{html}{\out{<div class="arguments">}}
\r
971 \item{\code{name}}{Name of the collection.}
\r
973 \item{\code{description}}{Description of the collection.}
\r
975 \item{\code{ownerUUID}}{UUID of the maternal project to created one.}
\r
977 \item{\code{properties}}{Properties of the collection.}
\r
979 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
981 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
983 \if{html}{\out{</div>}}
\r
985 \subsection{Examples}{
\r
986 \if{html}{\out{<div class="r example copy">}}
\r
987 \preformatted{Properties <- list() # should contain a list of new properties to be added
\r
988 arv$collections_create(name = "collectionTitle", description = "collectionDescription", ownerUUID = "collectionOwner", properties = Properties)
\r
990 \if{html}{\out{</div>}}
\r
995 \if{html}{\out{<hr>}}
\r
996 \if{html}{\out{<a id="method-collections_update"></a>}}
\r
997 \if{latex}{\out{\hypertarget{method-collections_update}{}}}
\r
998 \subsection{Method \code{collections_update()}}{
\r
999 collections_update is a method defined in Arvados class.
\r
1000 \subsection{Usage}{
\r
1001 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_update(
\r
1005 properties = NULL,
\r
1007 )}\if{html}{\out{</div>}}
\r
1010 \subsection{Arguments}{
\r
1011 \if{html}{\out{<div class="arguments">}}
\r
1013 \item{\code{name}}{New name of the collection.}
\r
1015 \item{\code{description}}{New description of the collection.}
\r
1017 \item{\code{ownerUUID}}{UUID of the maternal project to created one.}
\r
1019 \item{\code{properties}}{New list of properties of the collection.}
\r
1021 \item{\code{uuid}}{The UUID of the Collection in question.}
\r
1023 \if{html}{\out{</div>}}
\r
1025 \subsection{Examples}{
\r
1026 \if{html}{\out{<div class="r example copy">}}
\r
1027 \preformatted{collection <- arv$collections_create(name = "newCollectionTitle", description = "newCollectionDescription", ownerUUID = "collectionOwner", properties = NULL)
\r
1029 \if{html}{\out{</div>}}
\r
1034 \if{html}{\out{<hr>}}
\r
1035 \if{html}{\out{<a id="method-collections_delete"></a>}}
\r
1036 \if{latex}{\out{\hypertarget{method-collections_delete}{}}}
\r
1037 \subsection{Method \code{collections_delete()}}{
\r
1038 collections_delete is a method defined in Arvados class.
\r
1039 \subsection{Usage}{
\r
1040 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_delete(uuid)}\if{html}{\out{</div>}}
\r
1043 \subsection{Arguments}{
\r
1044 \if{html}{\out{<div class="arguments">}}
\r
1046 \item{\code{uuid}}{The UUID of the Collection in question.}
\r
1048 \if{html}{\out{</div>}}
\r
1050 \subsection{Examples}{
\r
1051 \if{html}{\out{<div class="r example copy">}}
\r
1052 \preformatted{arv$collection_delete(collectionUUID)
\r
1054 \if{html}{\out{</div>}}
\r
1059 \if{html}{\out{<hr>}}
\r
1060 \if{html}{\out{<a id="method-collections_provenance"></a>}}
\r
1061 \if{latex}{\out{\hypertarget{method-collections_provenance}{}}}
\r
1062 \subsection{Method \code{collections_provenance()}}{
\r
1063 collections_provenance is a method defined in Arvados class, it returns the collection by uuid.
\r
1064 \subsection{Usage}{
\r
1065 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_provenance(uuid)}\if{html}{\out{</div>}}
\r
1068 \subsection{Arguments}{
\r
1069 \if{html}{\out{<div class="arguments">}}
\r
1071 \item{\code{uuid}}{The UUID of the Collection in question.}
\r
1073 \if{html}{\out{</div>}}
\r
1075 \subsection{Examples}{
\r
1076 \if{html}{\out{<div class="r example copy">}}
\r
1077 \preformatted{collection <- arv$collections_provenance(collectionUUID)
\r
1079 \if{html}{\out{</div>}}
\r
1084 \if{html}{\out{<hr>}}
\r
1085 \if{html}{\out{<a id="method-collections_used_by"></a>}}
\r
1086 \if{latex}{\out{\hypertarget{method-collections_used_by}{}}}
\r
1087 \subsection{Method \code{collections_used_by()}}{
\r
1088 collections_used_by is a method defined in Arvados class, it returns collection by portable_data_hash.
\r
1089 \subsection{Usage}{
\r
1090 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_used_by(uuid)}\if{html}{\out{</div>}}
\r
1093 \subsection{Arguments}{
\r
1094 \if{html}{\out{<div class="arguments">}}
\r
1096 \item{\code{uuid}}{The UUID of the Collection in question.}
\r
1098 \if{html}{\out{</div>}}
\r
1101 \if{html}{\out{<hr>}}
\r
1102 \if{html}{\out{<a id="method-collections_trash"></a>}}
\r
1103 \if{latex}{\out{\hypertarget{method-collections_trash}{}}}
\r
1104 \subsection{Method \code{collections_trash()}}{
\r
1105 collections_trash is a method defined in Arvados class, it moves collection to trash.
\r
1106 \subsection{Usage}{
\r
1107 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_trash(uuid)}\if{html}{\out{</div>}}
\r
1110 \subsection{Arguments}{
\r
1111 \if{html}{\out{<div class="arguments">}}
\r
1113 \item{\code{uuid}}{The UUID of the Collection in question.}
\r
1115 \if{html}{\out{</div>}}
\r
1117 \subsection{Examples}{
\r
1118 \if{html}{\out{<div class="r example copy">}}
\r
1119 \preformatted{arv$collections_trash(collectionUUID)
\r
1121 \if{html}{\out{</div>}}
\r
1126 \if{html}{\out{<hr>}}
\r
1127 \if{html}{\out{<a id="method-collections_untrash"></a>}}
\r
1128 \if{latex}{\out{\hypertarget{method-collections_untrash}{}}}
\r
1129 \subsection{Method \code{collections_untrash()}}{
\r
1130 collections_untrash is a method defined in Arvados class, it moves collection from trash to project.
\r
1131 \subsection{Usage}{
\r
1132 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_untrash(uuid)}\if{html}{\out{</div>}}
\r
1135 \subsection{Arguments}{
\r
1136 \if{html}{\out{<div class="arguments">}}
\r
1138 \item{\code{uuid}}{The UUID of the Collection in question.}
\r
1140 \if{html}{\out{</div>}}
\r
1142 \subsection{Examples}{
\r
1143 \if{html}{\out{<div class="r example copy">}}
\r
1144 \preformatted{arv$collections_untrash(collectionUUID)
\r
1146 \if{html}{\out{</div>}}
\r
1151 \if{html}{\out{<hr>}}
\r
1152 \if{html}{\out{<a id="method-collections_list"></a>}}
\r
1153 \if{latex}{\out{\hypertarget{method-collections_list}{}}}
\r
1154 \subsection{Method \code{collections_list()}}{
\r
1155 collections_list is a method defined in Arvados class.
\r
1156 \subsection{Usage}{
\r
1157 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_list(
\r
1167 bypassFederation = NULL,
\r
1168 includeTrash = NULL,
\r
1169 includeOldVersions = NULL
\r
1170 )}\if{html}{\out{</div>}}
\r
1173 \subsection{Arguments}{
\r
1174 \if{html}{\out{<div class="arguments">}}
\r
1176 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
1178 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
1180 \item{\code{includeTrash}}{Include collections whose is_trashed attribute is true.}
\r
1182 \item{\code{includeOldVersions}}{Include past collection versions.}
\r
1184 \if{html}{\out{</div>}}
\r
1186 \subsection{Examples}{
\r
1187 \if{html}{\out{<div class="r example copy">}}
\r
1188 \preformatted{collectionList <- arv$collections.list(list(list("name", "=", "Example")))
\r
1190 \if{html}{\out{</div>}}
\r
1195 \if{html}{\out{<hr>}}
\r
1196 \if{html}{\out{<a id="method-containers_get"></a>}}
\r
1197 \if{latex}{\out{\hypertarget{method-containers_get}{}}}
\r
1198 \subsection{Method \code{containers_get()}}{
\r
1199 containers_get is a method defined in Arvados class.
\r
1200 \subsection{Usage}{
\r
1201 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_get(uuid)}\if{html}{\out{</div>}}
\r
1204 \subsection{Arguments}{
\r
1205 \if{html}{\out{<div class="arguments">}}
\r
1207 \item{\code{uuid}}{The UUID of the Container in question.}
\r
1209 \if{html}{\out{</div>}}
\r
1212 \if{html}{\out{<hr>}}
\r
1213 \if{html}{\out{<a id="method-containers_create"></a>}}
\r
1214 \if{latex}{\out{\hypertarget{method-containers_create}{}}}
\r
1215 \subsection{Method \code{containers_create()}}{
\r
1216 containers_create is a method defined in Arvados class.
\r
1217 \subsection{Usage}{
\r
1218 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_create(
\r
1220 ensureUniqueName = "false",
\r
1222 )}\if{html}{\out{</div>}}
\r
1225 \subsection{Arguments}{
\r
1226 \if{html}{\out{<div class="arguments">}}
\r
1228 \item{\code{container}}{Container object.}
\r
1230 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
1232 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
1234 \if{html}{\out{</div>}}
\r
1237 \if{html}{\out{<hr>}}
\r
1238 \if{html}{\out{<a id="method-containers_update"></a>}}
\r
1239 \if{latex}{\out{\hypertarget{method-containers_update}{}}}
\r
1240 \subsection{Method \code{containers_update()}}{
\r
1241 containers_update is a method defined in Arvados class.
\r
1242 \subsection{Usage}{
\r
1243 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_update(container, uuid)}\if{html}{\out{</div>}}
\r
1246 \subsection{Arguments}{
\r
1247 \if{html}{\out{<div class="arguments">}}
\r
1249 \item{\code{container}}{Container object.}
\r
1251 \item{\code{uuid}}{The UUID of the Container in question.}
\r
1253 \if{html}{\out{</div>}}
\r
1256 \if{html}{\out{<hr>}}
\r
1257 \if{html}{\out{<a id="method-containers_delete"></a>}}
\r
1258 \if{latex}{\out{\hypertarget{method-containers_delete}{}}}
\r
1259 \subsection{Method \code{containers_delete()}}{
\r
1260 containers_delete is a method defined in Arvados class.
\r
1261 \subsection{Usage}{
\r
1262 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_delete(uuid)}\if{html}{\out{</div>}}
\r
1265 \subsection{Arguments}{
\r
1266 \if{html}{\out{<div class="arguments">}}
\r
1268 \item{\code{uuid}}{The UUID of the Container in question.}
\r
1270 \if{html}{\out{</div>}}
\r
1273 \if{html}{\out{<hr>}}
\r
1274 \if{html}{\out{<a id="method-containers_auth"></a>}}
\r
1275 \if{latex}{\out{\hypertarget{method-containers_auth}{}}}
\r
1276 \subsection{Method \code{containers_auth()}}{
\r
1277 containers_auth is a method defined in Arvados class.
\r
1278 \subsection{Usage}{
\r
1279 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_auth(uuid)}\if{html}{\out{</div>}}
\r
1282 \subsection{Arguments}{
\r
1283 \if{html}{\out{<div class="arguments">}}
\r
1285 \item{\code{uuid}}{The UUID of the Container in question.}
\r
1287 \if{html}{\out{</div>}}
\r
1290 \if{html}{\out{<hr>}}
\r
1291 \if{html}{\out{<a id="method-containers_lock"></a>}}
\r
1292 \if{latex}{\out{\hypertarget{method-containers_lock}{}}}
\r
1293 \subsection{Method \code{containers_lock()}}{
\r
1294 containers_lock is a method defined in Arvados class.
\r
1295 \subsection{Usage}{
\r
1296 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_lock(uuid)}\if{html}{\out{</div>}}
\r
1299 \subsection{Arguments}{
\r
1300 \if{html}{\out{<div class="arguments">}}
\r
1302 \item{\code{uuid}}{The UUID of the Container in question.}
\r
1304 \if{html}{\out{</div>}}
\r
1307 \if{html}{\out{<hr>}}
\r
1308 \if{html}{\out{<a id="method-containers_unlock"></a>}}
\r
1309 \if{latex}{\out{\hypertarget{method-containers_unlock}{}}}
\r
1310 \subsection{Method \code{containers_unlock()}}{
\r
1311 containers_unlock is a method defined in Arvados class.
\r
1312 \subsection{Usage}{
\r
1313 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_unlock(uuid)}\if{html}{\out{</div>}}
\r
1316 \subsection{Arguments}{
\r
1317 \if{html}{\out{<div class="arguments">}}
\r
1319 \item{\code{uuid}}{The UUID of the Container in question.}
\r
1321 \if{html}{\out{</div>}}
\r
1324 \if{html}{\out{<hr>}}
\r
1325 \if{html}{\out{<a id="method-containers_secret_mounts"></a>}}
\r
1326 \if{latex}{\out{\hypertarget{method-containers_secret_mounts}{}}}
\r
1327 \subsection{Method \code{containers_secret_mounts()}}{
\r
1328 containers_secret_mounts is a method defined in Arvados class.
\r
1329 \subsection{Usage}{
\r
1330 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_secret_mounts(uuid)}\if{html}{\out{</div>}}
\r
1333 \subsection{Arguments}{
\r
1334 \if{html}{\out{<div class="arguments">}}
\r
1336 \item{\code{uuid}}{The UUID of the Container in question.}
\r
1338 \if{html}{\out{</div>}}
\r
1341 \if{html}{\out{<hr>}}
\r
1342 \if{html}{\out{<a id="method-containers_current"></a>}}
\r
1343 \if{latex}{\out{\hypertarget{method-containers_current}{}}}
\r
1344 \subsection{Method \code{containers_current()}}{
\r
1345 containers_current is a method defined in Arvados class.
\r
1346 \subsection{Usage}{
\r
1347 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_current()}\if{html}{\out{</div>}}
\r
1351 \if{html}{\out{<hr>}}
\r
1352 \if{html}{\out{<a id="method-containers_list"></a>}}
\r
1353 \if{latex}{\out{\hypertarget{method-containers_list}{}}}
\r
1354 \subsection{Method \code{containers_list()}}{
\r
1355 containers_list is a method defined in Arvados class.
\r
1356 \subsection{Usage}{
\r
1357 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_list(
\r
1367 bypassFederation = NULL
\r
1368 )}\if{html}{\out{</div>}}
\r
1371 \subsection{Arguments}{
\r
1372 \if{html}{\out{<div class="arguments">}}
\r
1374 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
1376 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
1378 \if{html}{\out{</div>}}
\r
1381 \if{html}{\out{<hr>}}
\r
1382 \if{html}{\out{<a id="method-container_requests_get"></a>}}
\r
1383 \if{latex}{\out{\hypertarget{method-container_requests_get}{}}}
\r
1384 \subsection{Method \code{container_requests_get()}}{
\r
1385 container_requests_get is a method defined in Arvados class.
\r
1386 \subsection{Usage}{
\r
1387 \if{html}{\out{<div class="r">}}\preformatted{Arvados$container_requests_get(uuid)}\if{html}{\out{</div>}}
\r
1390 \subsection{Arguments}{
\r
1391 \if{html}{\out{<div class="arguments">}}
\r
1393 \item{\code{uuid}}{The UUID of the containerRequest in question.}
\r
1395 \if{html}{\out{</div>}}
\r
1398 \if{html}{\out{<hr>}}
\r
1399 \if{html}{\out{<a id="method-container_requests_create"></a>}}
\r
1400 \if{latex}{\out{\hypertarget{method-container_requests_create}{}}}
\r
1401 \subsection{Method \code{container_requests_create()}}{
\r
1402 container_requests_create is a method defined in Arvados class.
\r
1403 \subsection{Usage}{
\r
1404 \if{html}{\out{<div class="r">}}\preformatted{Arvados$container_requests_create(
\r
1406 ensureUniqueName = "false",
\r
1408 )}\if{html}{\out{</div>}}
\r
1411 \subsection{Arguments}{
\r
1412 \if{html}{\out{<div class="arguments">}}
\r
1414 \item{\code{containerRequest}}{containerRequest object.}
\r
1416 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
1418 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
1420 \if{html}{\out{</div>}}
\r
1423 \if{html}{\out{<hr>}}
\r
1424 \if{html}{\out{<a id="method-container_requests_update"></a>}}
\r
1425 \if{latex}{\out{\hypertarget{method-container_requests_update}{}}}
\r
1426 \subsection{Method \code{container_requests_update()}}{
\r
1427 container_requests_update is a method defined in Arvados class.
\r
1428 \subsection{Usage}{
\r
1429 \if{html}{\out{<div class="r">}}\preformatted{Arvados$container_requests_update(containerRequest, uuid)}\if{html}{\out{</div>}}
\r
1432 \subsection{Arguments}{
\r
1433 \if{html}{\out{<div class="arguments">}}
\r
1435 \item{\code{containerRequest}}{containerRequest object.}
\r
1437 \item{\code{uuid}}{The UUID of the containerRequest in question.}
\r
1439 \if{html}{\out{</div>}}
\r
1442 \if{html}{\out{<hr>}}
\r
1443 \if{html}{\out{<a id="method-container_requests_delete"></a>}}
\r
1444 \if{latex}{\out{\hypertarget{method-container_requests_delete}{}}}
\r
1445 \subsection{Method \code{container_requests_delete()}}{
\r
1446 container_requests_delete is a method defined in Arvados class.
\r
1447 \subsection{Usage}{
\r
1448 \if{html}{\out{<div class="r">}}\preformatted{Arvados$container_requests_delete(uuid)}\if{html}{\out{</div>}}
\r
1451 \subsection{Arguments}{
\r
1452 \if{html}{\out{<div class="arguments">}}
\r
1454 \item{\code{uuid}}{The UUID of the containerRequest in question.}
\r
1456 \if{html}{\out{</div>}}
\r
1459 \if{html}{\out{<hr>}}
\r
1460 \if{html}{\out{<a id="method-container_requests_list"></a>}}
\r
1461 \if{latex}{\out{\hypertarget{method-container_requests_list}{}}}
\r
1462 \subsection{Method \code{container_requests_list()}}{
\r
1463 container_requests_list is a method defined in Arvados class.
\r
1464 \subsection{Usage}{
\r
1465 \if{html}{\out{<div class="r">}}\preformatted{Arvados$container_requests_list(
\r
1475 bypassFederation = NULL,
\r
1476 includeTrash = NULL
\r
1477 )}\if{html}{\out{</div>}}
\r
1480 \subsection{Arguments}{
\r
1481 \if{html}{\out{<div class="arguments">}}
\r
1483 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
1485 \item{\code{bypassFederation}}{bypass federation behavior, list items from local instance database only}
\r
1487 \item{\code{includeTrash}}{Include container requests whose owner project is trashed.}
\r
1489 \if{html}{\out{</div>}}
\r
1492 \if{html}{\out{<hr>}}
\r
1493 \if{html}{\out{<a id="method-groups_get"></a>}}
\r
1494 \if{latex}{\out{\hypertarget{method-groups_get}{}}}
\r
1495 \subsection{Method \code{groups_get()}}{
\r
1496 groups_get is a method defined in Arvados class.
\r
1497 \subsection{Usage}{
\r
1498 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_get(uuid)}\if{html}{\out{</div>}}
\r
1501 \subsection{Arguments}{
\r
1502 \if{html}{\out{<div class="arguments">}}
\r
1504 \item{\code{uuid}}{The UUID of the Group in question.}
\r
1506 \if{html}{\out{</div>}}
\r
1509 \if{html}{\out{<hr>}}
\r
1510 \if{html}{\out{<a id="method-groups_create"></a>}}
\r
1511 \if{latex}{\out{\hypertarget{method-groups_create}{}}}
\r
1512 \subsection{Method \code{groups_create()}}{
\r
1513 groups_create is a method defined in Arvados class that supports project creation.
\r
1514 \subsection{Usage}{
\r
1515 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_create(
\r
1517 ensureUniqueName = "false",
\r
1520 )}\if{html}{\out{</div>}}
\r
1523 \subsection{Arguments}{
\r
1524 \if{html}{\out{<div class="arguments">}}
\r
1526 \item{\code{group}}{Group object.}
\r
1528 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
1530 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
1532 \item{\code{async}}{Defer permissions update.}
\r
1534 \if{html}{\out{</div>}}
\r
1537 \if{html}{\out{<hr>}}
\r
1538 \if{html}{\out{<a id="method-groups_update"></a>}}
\r
1539 \if{latex}{\out{\hypertarget{method-groups_update}{}}}
\r
1540 \subsection{Method \code{groups_update()}}{
\r
1541 groups_update is a method defined in Arvados class.
\r
1542 \subsection{Usage}{
\r
1543 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_update(group, uuid, async = "false")}\if{html}{\out{</div>}}
\r
1546 \subsection{Arguments}{
\r
1547 \if{html}{\out{<div class="arguments">}}
\r
1549 \item{\code{group}}{Group object.}
\r
1551 \item{\code{uuid}}{The UUID of the Group in question.}
\r
1553 \item{\code{async}}{Defer permissions update.}
\r
1555 \if{html}{\out{</div>}}
\r
1558 \if{html}{\out{<hr>}}
\r
1559 \if{html}{\out{<a id="method-groups_delete"></a>}}
\r
1560 \if{latex}{\out{\hypertarget{method-groups_delete}{}}}
\r
1561 \subsection{Method \code{groups_delete()}}{
\r
1562 groups_delete is a method defined in Arvados class.
\r
1563 \subsection{Usage}{
\r
1564 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_delete(uuid)}\if{html}{\out{</div>}}
\r
1567 \subsection{Arguments}{
\r
1568 \if{html}{\out{<div class="arguments">}}
\r
1570 \item{\code{uuid}}{The UUID of the Group in question.}
\r
1572 \if{html}{\out{</div>}}
\r
1575 \if{html}{\out{<hr>}}
\r
1576 \if{html}{\out{<a id="method-groups_contents"></a>}}
\r
1577 \if{latex}{\out{\hypertarget{method-groups_contents}{}}}
\r
1578 \subsection{Method \code{groups_contents()}}{
\r
1579 groups_contents is a method defined in Arvados class.
\r
1580 \subsection{Usage}{
\r
1581 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_contents(
\r
1590 bypassFederation = NULL,
\r
1591 includeTrash = NULL,
\r
1595 )}\if{html}{\out{</div>}}
\r
1598 \subsection{Arguments}{
\r
1599 \if{html}{\out{<div class="arguments">}}
\r
1601 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
1603 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
1605 \item{\code{includeTrash}}{Include items whose is_trashed attribute is true.}
\r
1607 \item{\code{recursive}}{Include contents from child groups recursively.}
\r
1609 \item{\code{include}}{Include objects referred to by listed field in "included" (only ownerUUID).}
\r
1611 \if{html}{\out{</div>}}
\r
1614 \if{html}{\out{<hr>}}
\r
1615 \if{html}{\out{<a id="method-groups_shared"></a>}}
\r
1616 \if{latex}{\out{\hypertarget{method-groups_shared}{}}}
\r
1617 \subsection{Method \code{groups_shared()}}{
\r
1618 groups_shared is a method defined in Arvados class.
\r
1619 \subsection{Usage}{
\r
1620 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_shared(
\r
1630 bypassFederation = NULL,
\r
1631 includeTrash = NULL,
\r
1633 )}\if{html}{\out{</div>}}
\r
1636 \subsection{Arguments}{
\r
1637 \if{html}{\out{<div class="arguments">}}
\r
1639 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
1641 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
1643 \item{\code{includeTrash}}{Include items whose is_trashed attribute is true.}
\r
1645 \if{html}{\out{</div>}}
\r
1648 \if{html}{\out{<hr>}}
\r
1649 \if{html}{\out{<a id="method-groups_trash"></a>}}
\r
1650 \if{latex}{\out{\hypertarget{method-groups_trash}{}}}
\r
1651 \subsection{Method \code{groups_trash()}}{
\r
1652 groups_trash is a method defined in Arvados class.
\r
1653 \subsection{Usage}{
\r
1654 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_trash(uuid)}\if{html}{\out{</div>}}
\r
1657 \subsection{Arguments}{
\r
1658 \if{html}{\out{<div class="arguments">}}
\r
1660 \item{\code{uuid}}{The UUID of the Group in question.}
\r
1662 \if{html}{\out{</div>}}
\r
1665 \if{html}{\out{<hr>}}
\r
1666 \if{html}{\out{<a id="method-groups_untrash"></a>}}
\r
1667 \if{latex}{\out{\hypertarget{method-groups_untrash}{}}}
\r
1668 \subsection{Method \code{groups_untrash()}}{
\r
1669 groups_untrash is a method defined in Arvados class.
\r
1670 \subsection{Usage}{
\r
1671 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_untrash(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-groups_list"></a>}}
\r
1684 \if{latex}{\out{\hypertarget{method-groups_list}{}}}
\r
1685 \subsection{Method \code{groups_list()}}{
\r
1686 groups_list is a method defined in Arvados class.
\r
1687 \subsection{Usage}{
\r
1688 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_list(
\r
1698 bypassFederation = NULL,
\r
1699 includeTrash = NULL
\r
1700 )}\if{html}{\out{</div>}}
\r
1703 \subsection{Arguments}{
\r
1704 \if{html}{\out{<div class="arguments">}}
\r
1706 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
1708 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
1710 \item{\code{includeTrash}}{Include items whose is_trashed attribute is true.}
\r
1712 \if{html}{\out{</div>}}
\r
1715 \if{html}{\out{<hr>}}
\r
1716 \if{html}{\out{<a id="method-keep_services_get"></a>}}
\r
1717 \if{latex}{\out{\hypertarget{method-keep_services_get}{}}}
\r
1718 \subsection{Method \code{keep_services_get()}}{
\r
1719 keep_services_get is a method defined in Arvados class.
\r
1720 \subsection{Usage}{
\r
1721 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_get(uuid)}\if{html}{\out{</div>}}
\r
1724 \subsection{Arguments}{
\r
1725 \if{html}{\out{<div class="arguments">}}
\r
1727 \item{\code{uuid}}{The UUID of the keepService in question.}
\r
1729 \if{html}{\out{</div>}}
\r
1732 \if{html}{\out{<hr>}}
\r
1733 \if{html}{\out{<a id="method-keep_services_create"></a>}}
\r
1734 \if{latex}{\out{\hypertarget{method-keep_services_create}{}}}
\r
1735 \subsection{Method \code{keep_services_create()}}{
\r
1736 keep_services_create is a method defined in Arvados class.
\r
1737 \subsection{Usage}{
\r
1738 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_create(
\r
1740 ensureUniqueName = "false",
\r
1742 )}\if{html}{\out{</div>}}
\r
1745 \subsection{Arguments}{
\r
1746 \if{html}{\out{<div class="arguments">}}
\r
1748 \item{\code{keepService}}{keepService object.}
\r
1750 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
1752 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
1754 \if{html}{\out{</div>}}
\r
1757 \if{html}{\out{<hr>}}
\r
1758 \if{html}{\out{<a id="method-keep_services_update"></a>}}
\r
1759 \if{latex}{\out{\hypertarget{method-keep_services_update}{}}}
\r
1760 \subsection{Method \code{keep_services_update()}}{
\r
1761 keep_services_update is a method defined in Arvados class.
\r
1762 \subsection{Usage}{
\r
1763 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_update(keepService, uuid)}\if{html}{\out{</div>}}
\r
1766 \subsection{Arguments}{
\r
1767 \if{html}{\out{<div class="arguments">}}
\r
1769 \item{\code{keepService}}{keepService object.}
\r
1771 \item{\code{uuid}}{The UUID of the keepService in question.}
\r
1773 \if{html}{\out{</div>}}
\r
1776 \if{html}{\out{<hr>}}
\r
1777 \if{html}{\out{<a id="method-keep_services_delete"></a>}}
\r
1778 \if{latex}{\out{\hypertarget{method-keep_services_delete}{}}}
\r
1779 \subsection{Method \code{keep_services_delete()}}{
\r
1780 keep_services_delete is a method defined in Arvados class.
\r
1781 \subsection{Usage}{
\r
1782 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_delete(uuid)}\if{html}{\out{</div>}}
\r
1785 \subsection{Arguments}{
\r
1786 \if{html}{\out{<div class="arguments">}}
\r
1788 \item{\code{uuid}}{The UUID of the keepService in question.}
\r
1790 \if{html}{\out{</div>}}
\r
1793 \if{html}{\out{<hr>}}
\r
1794 \if{html}{\out{<a id="method-keep_services_accessible"></a>}}
\r
1795 \if{latex}{\out{\hypertarget{method-keep_services_accessible}{}}}
\r
1796 \subsection{Method \code{keep_services_accessible()}}{
\r
1797 keep_services_accessible is a method defined in Arvados class.
\r
1798 \subsection{Usage}{
\r
1799 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_accessible()}\if{html}{\out{</div>}}
\r
1803 \if{html}{\out{<hr>}}
\r
1804 \if{html}{\out{<a id="method-keep_services_list"></a>}}
\r
1805 \if{latex}{\out{\hypertarget{method-keep_services_list}{}}}
\r
1806 \subsection{Method \code{keep_services_list()}}{
\r
1807 keep_services_list is a method defined in Arvados class.
\r
1808 \subsection{Usage}{
\r
1809 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_list(
\r
1819 bypassFederation = NULL
\r
1820 )}\if{html}{\out{</div>}}
\r
1823 \subsection{Arguments}{
\r
1824 \if{html}{\out{<div class="arguments">}}
\r
1826 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
1828 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
1830 \if{html}{\out{</div>}}
\r
1833 \if{html}{\out{<hr>}}
\r
1834 \if{html}{\out{<a id="method-project_permission_give"></a>}}
\r
1835 \if{latex}{\out{\hypertarget{method-project_permission_give}{}}}
\r
1836 \subsection{Method \code{project_permission_give()}}{
\r
1837 project_permission_give is a method defined in Arvados class that enables sharing files with another users.
\r
1838 \subsection{Usage}{
\r
1839 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_permission_give(type, uuid, user)}\if{html}{\out{</div>}}
\r
1842 \subsection{Arguments}{
\r
1843 \if{html}{\out{<div class="arguments">}}
\r
1845 \item{\code{type}}{Possible options are can_read or can_write or can_manage.}
\r
1847 \item{\code{uuid}}{The UUID of a project or a file.}
\r
1849 \item{\code{user}}{The UUID of the person that gets the permission.}
\r
1851 \if{html}{\out{</div>}}
\r
1853 \subsection{Examples}{
\r
1854 \if{html}{\out{<div class="r example copy">}}
\r
1855 \preformatted{arv$project_permission_give(type = "can_read", uuid = objectUUID, user = userUUID)
\r
1857 \if{html}{\out{</div>}}
\r
1862 \if{html}{\out{<hr>}}
\r
1863 \if{html}{\out{<a id="method-project_permission_refuse"></a>}}
\r
1864 \if{latex}{\out{\hypertarget{method-project_permission_refuse}{}}}
\r
1865 \subsection{Method \code{project_permission_refuse()}}{
\r
1866 project_permission_refuse is a method defined in Arvados class that unables sharing files with another users.
\r
1867 \subsection{Usage}{
\r
1868 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_permission_refuse(type, uuid, user)}\if{html}{\out{</div>}}
\r
1871 \subsection{Arguments}{
\r
1872 \if{html}{\out{<div class="arguments">}}
\r
1874 \item{\code{type}}{Possible options are can_read or can_write or can_manage.}
\r
1876 \item{\code{uuid}}{The UUID of a project or a file.}
\r
1878 \item{\code{user}}{The UUID of a person that permissions are taken from.}
\r
1880 \if{html}{\out{</div>}}
\r
1882 \subsection{Examples}{
\r
1883 \if{html}{\out{<div class="r example copy">}}
\r
1884 \preformatted{arv$project_permission_refuse(type = "can_read", uuid = objectUUID, user = userUUID)
\r
1886 \if{html}{\out{</div>}}
\r
1891 \if{html}{\out{<hr>}}
\r
1892 \if{html}{\out{<a id="method-project_permission_update"></a>}}
\r
1893 \if{latex}{\out{\hypertarget{method-project_permission_update}{}}}
\r
1894 \subsection{Method \code{project_permission_update()}}{
\r
1895 project_permission_update is a method defined in Arvados class that enables updating permissions.
\r
1896 \subsection{Usage}{
\r
1897 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_permission_update(typeOld, typeNew, uuid, user)}\if{html}{\out{</div>}}
\r
1900 \subsection{Arguments}{
\r
1901 \if{html}{\out{<div class="arguments">}}
\r
1903 \item{\code{typeOld}}{Old option.}
\r
1905 \item{\code{typeNew}}{New option like can_read or can_write or can_manage.}
\r
1907 \item{\code{uuid}}{The UUID of a project or a file.}
\r
1909 \item{\code{user}}{The UUID of the person that the permission is being updated.}
\r
1911 \if{html}{\out{</div>}}
\r
1913 \subsection{Examples}{
\r
1914 \if{html}{\out{<div class="r example copy">}}
\r
1915 \preformatted{arv$project_permission_update(typeOld = "can_read", typeNew = "can_write", uuid = objectUUID, user = userUUID)
\r
1917 \if{html}{\out{</div>}}
\r
1922 \if{html}{\out{<hr>}}
\r
1923 \if{html}{\out{<a id="method-project_permission_check"></a>}}
\r
1924 \if{latex}{\out{\hypertarget{method-project_permission_check}{}}}
\r
1925 \subsection{Method \code{project_permission_check()}}{
\r
1926 project_permission_check is a method defined in Arvados class that enables checking file permissions.
\r
1927 \subsection{Usage}{
\r
1928 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_permission_check(uuid, user, type = NULL)}\if{html}{\out{</div>}}
\r
1931 \subsection{Arguments}{
\r
1932 \if{html}{\out{<div class="arguments">}}
\r
1934 \item{\code{uuid}}{The UUID of a project or a file.}
\r
1936 \item{\code{user}}{The UUID of the person that the permission is being updated.}
\r
1938 \item{\code{type}}{Possible options are can_read or can_write or can_manage.}
\r
1940 \if{html}{\out{</div>}}
\r
1942 \subsection{Examples}{
\r
1943 \if{html}{\out{<div class="r example copy">}}
\r
1944 \preformatted{arv$project_permission_check(type = "can_read", uuid = objectUUID, user = userUUID)
\r
1946 \if{html}{\out{</div>}}
\r
1951 \if{html}{\out{<hr>}}
\r
1952 \if{html}{\out{<a id="method-links_get"></a>}}
\r
1953 \if{latex}{\out{\hypertarget{method-links_get}{}}}
\r
1954 \subsection{Method \code{links_get()}}{
\r
1955 links_get is a method defined in Arvados class.
\r
1956 \subsection{Usage}{
\r
1957 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_get(uuid)}\if{html}{\out{</div>}}
\r
1960 \subsection{Arguments}{
\r
1961 \if{html}{\out{<div class="arguments">}}
\r
1963 \item{\code{uuid}}{The UUID of the Link in question.}
\r
1965 \if{html}{\out{</div>}}
\r
1968 \if{html}{\out{<hr>}}
\r
1969 \if{html}{\out{<a id="method-links_create"></a>}}
\r
1970 \if{latex}{\out{\hypertarget{method-links_create}{}}}
\r
1971 \subsection{Method \code{links_create()}}{
\r
1972 links_create is a method defined in Arvados class.
\r
1973 \subsection{Usage}{
\r
1974 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_create(link, ensureUniqueName = "false", clusterID = NULL)}\if{html}{\out{</div>}}
\r
1977 \subsection{Arguments}{
\r
1978 \if{html}{\out{<div class="arguments">}}
\r
1980 \item{\code{link}}{Link object.}
\r
1982 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
1984 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
1986 \if{html}{\out{</div>}}
\r
1989 \if{html}{\out{<hr>}}
\r
1990 \if{html}{\out{<a id="method-links_update"></a>}}
\r
1991 \if{latex}{\out{\hypertarget{method-links_update}{}}}
\r
1992 \subsection{Method \code{links_update()}}{
\r
1993 links_update is a method defined in Arvados class.
\r
1994 \subsection{Usage}{
\r
1995 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_update(link, uuid, async = "false")}\if{html}{\out{</div>}}
\r
1998 \subsection{Arguments}{
\r
1999 \if{html}{\out{<div class="arguments">}}
\r
2001 \item{\code{link}}{Link object.}
\r
2003 \item{\code{uuid}}{The UUID of the Link in question.}
\r
2005 \if{html}{\out{</div>}}
\r
2008 \if{html}{\out{<hr>}}
\r
2009 \if{html}{\out{<a id="method-links_delete"></a>}}
\r
2010 \if{latex}{\out{\hypertarget{method-links_delete}{}}}
\r
2011 \subsection{Method \code{links_delete()}}{
\r
2012 links_delete is a method defined in Arvados class.
\r
2013 \subsection{Usage}{
\r
2014 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_delete(uuid)}\if{html}{\out{</div>}}
\r
2017 \subsection{Arguments}{
\r
2018 \if{html}{\out{<div class="arguments">}}
\r
2020 \item{\code{uuid}}{The UUID of the Link in question.}
\r
2022 \if{html}{\out{</div>}}
\r
2025 \if{html}{\out{<hr>}}
\r
2026 \if{html}{\out{<a id="method-links_list"></a>}}
\r
2027 \if{latex}{\out{\hypertarget{method-links_list}{}}}
\r
2028 \subsection{Method \code{links_list()}}{
\r
2029 links_list is a method defined in Arvados class.
\r
2030 \subsection{Usage}{
\r
2031 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_list(
\r
2041 bypassFederation = NULL
\r
2042 )}\if{html}{\out{</div>}}
\r
2045 \subsection{Arguments}{
\r
2046 \if{html}{\out{<div class="arguments">}}
\r
2048 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
2050 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
2052 \if{html}{\out{</div>}}
\r
2055 \if{html}{\out{<hr>}}
\r
2056 \if{html}{\out{<a id="method-links_get_permissions"></a>}}
\r
2057 \if{latex}{\out{\hypertarget{method-links_get_permissions}{}}}
\r
2058 \subsection{Method \code{links_get_permissions()}}{
\r
2059 links_get_permissions is a method defined in Arvados class.
\r
2060 \subsection{Usage}{
\r
2061 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_get_permissions(uuid)}\if{html}{\out{</div>}}
\r
2064 \subsection{Arguments}{
\r
2065 \if{html}{\out{<div class="arguments">}}
\r
2067 \item{\code{uuid}}{The UUID of the Log in question.}
\r
2069 \if{html}{\out{</div>}}
\r
2072 \if{html}{\out{<hr>}}
\r
2073 \if{html}{\out{<a id="method-logs_get"></a>}}
\r
2074 \if{latex}{\out{\hypertarget{method-logs_get}{}}}
\r
2075 \subsection{Method \code{logs_get()}}{
\r
2076 logs_get is a method defined in Arvados class.
\r
2077 \subsection{Usage}{
\r
2078 \if{html}{\out{<div class="r">}}\preformatted{Arvados$logs_get(uuid)}\if{html}{\out{</div>}}
\r
2081 \subsection{Arguments}{
\r
2082 \if{html}{\out{<div class="arguments">}}
\r
2084 \item{\code{uuid}}{The UUID of the Log in question.}
\r
2086 \if{html}{\out{</div>}}
\r
2089 \if{html}{\out{<hr>}}
\r
2090 \if{html}{\out{<a id="method-logs_create"></a>}}
\r
2091 \if{latex}{\out{\hypertarget{method-logs_create}{}}}
\r
2092 \subsection{Method \code{logs_create()}}{
\r
2093 logs_create is a method defined in Arvados class.
\r
2094 \subsection{Usage}{
\r
2095 \if{html}{\out{<div class="r">}}\preformatted{Arvados$logs_create(log, ensureUniqueName = "false", clusterID = NULL)}\if{html}{\out{</div>}}
\r
2098 \subsection{Arguments}{
\r
2099 \if{html}{\out{<div class="arguments">}}
\r
2101 \item{\code{log}}{Log object.}
\r
2103 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
2105 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
2107 \if{html}{\out{</div>}}
\r
2110 \if{html}{\out{<hr>}}
\r
2111 \if{html}{\out{<a id="method-logs_update"></a>}}
\r
2112 \if{latex}{\out{\hypertarget{method-logs_update}{}}}
\r
2113 \subsection{Method \code{logs_update()}}{
\r
2114 logs_update is a method defined in Arvados class.
\r
2115 \subsection{Usage}{
\r
2116 \if{html}{\out{<div class="r">}}\preformatted{Arvados$logs_update(log, uuid)}\if{html}{\out{</div>}}
\r
2119 \subsection{Arguments}{
\r
2120 \if{html}{\out{<div class="arguments">}}
\r
2122 \item{\code{log}}{Log object.}
\r
2124 \item{\code{uuid}}{The UUID of the Log in question.}
\r
2126 \if{html}{\out{</div>}}
\r
2129 \if{html}{\out{<hr>}}
\r
2130 \if{html}{\out{<a id="method-logs_delete"></a>}}
\r
2131 \if{latex}{\out{\hypertarget{method-logs_delete}{}}}
\r
2132 \subsection{Method \code{logs_delete()}}{
\r
2133 logs_delete is a method defined in Arvados class.
\r
2134 \subsection{Usage}{
\r
2135 \if{html}{\out{<div class="r">}}\preformatted{Arvados$logs_delete(uuid)}\if{html}{\out{</div>}}
\r
2138 \subsection{Arguments}{
\r
2139 \if{html}{\out{<div class="arguments">}}
\r
2141 \item{\code{uuid}}{The UUID of the Log in question.}
\r
2143 \if{html}{\out{</div>}}
\r
2146 \if{html}{\out{<hr>}}
\r
2147 \if{html}{\out{<a id="method-logs_list"></a>}}
\r
2148 \if{latex}{\out{\hypertarget{method-logs_list}{}}}
\r
2149 \subsection{Method \code{logs_list()}}{
\r
2150 logs_list is a method defined in Arvados class.
\r
2151 \subsection{Usage}{
\r
2152 \if{html}{\out{<div class="r">}}\preformatted{Arvados$logs_list(
\r
2162 bypassFederation = NULL
\r
2163 )}\if{html}{\out{</div>}}
\r
2166 \subsection{Arguments}{
\r
2167 \if{html}{\out{<div class="arguments">}}
\r
2169 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
2171 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
2173 \if{html}{\out{</div>}}
\r
2176 \if{html}{\out{<hr>}}
\r
2177 \if{html}{\out{<a id="method-users_get"></a>}}
\r
2178 \if{latex}{\out{\hypertarget{method-users_get}{}}}
\r
2179 \subsection{Method \code{users_get()}}{
\r
2180 users_get is a method defined in Arvados class.
\r
2181 \subsection{Usage}{
\r
2182 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_get(uuid)}\if{html}{\out{</div>}}
\r
2185 \subsection{Arguments}{
\r
2186 \if{html}{\out{<div class="arguments">}}
\r
2188 \item{\code{uuid}}{The UUID of the User in question.}
\r
2190 \if{html}{\out{</div>}}
\r
2193 \if{html}{\out{<hr>}}
\r
2194 \if{html}{\out{<a id="method-users_create"></a>}}
\r
2195 \if{latex}{\out{\hypertarget{method-users_create}{}}}
\r
2196 \subsection{Method \code{users_create()}}{
\r
2197 users_create is a method defined in Arvados class.
\r
2198 \subsection{Usage}{
\r
2199 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_create(user, ensureUniqueName = "false", clusterID = NULL)}\if{html}{\out{</div>}}
\r
2202 \subsection{Arguments}{
\r
2203 \if{html}{\out{<div class="arguments">}}
\r
2205 \item{\code{user}}{User object.}
\r
2207 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
2209 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
2211 \if{html}{\out{</div>}}
\r
2214 \if{html}{\out{<hr>}}
\r
2215 \if{html}{\out{<a id="method-users_update"></a>}}
\r
2216 \if{latex}{\out{\hypertarget{method-users_update}{}}}
\r
2217 \subsection{Method \code{users_update()}}{
\r
2218 users_update is a method defined in Arvados class.
\r
2219 \subsection{Usage}{
\r
2220 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_update(user, uuid, bypassFederation = NULL)}\if{html}{\out{</div>}}
\r
2223 \subsection{Arguments}{
\r
2224 \if{html}{\out{<div class="arguments">}}
\r
2226 \item{\code{user}}{User object.}
\r
2228 \item{\code{uuid}}{The UUID of the User in question.}
\r
2230 \if{html}{\out{</div>}}
\r
2233 \if{html}{\out{<hr>}}
\r
2234 \if{html}{\out{<a id="method-users_delete"></a>}}
\r
2235 \if{latex}{\out{\hypertarget{method-users_delete}{}}}
\r
2236 \subsection{Method \code{users_delete()}}{
\r
2237 users_delete is a method defined in Arvados class.
\r
2238 \subsection{Usage}{
\r
2239 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_delete(uuid)}\if{html}{\out{</div>}}
\r
2242 \subsection{Arguments}{
\r
2243 \if{html}{\out{<div class="arguments">}}
\r
2245 \item{\code{uuid}}{The UUID of the User in question.}
\r
2247 \if{html}{\out{</div>}}
\r
2250 \if{html}{\out{<hr>}}
\r
2251 \if{html}{\out{<a id="method-users_current"></a>}}
\r
2252 \if{latex}{\out{\hypertarget{method-users_current}{}}}
\r
2253 \subsection{Method \code{users_current()}}{
\r
2254 users_current is a method defined in Arvados class.
\r
2255 \subsection{Usage}{
\r
2256 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_current()}\if{html}{\out{</div>}}
\r
2260 \if{html}{\out{<hr>}}
\r
2261 \if{html}{\out{<a id="method-users_system"></a>}}
\r
2262 \if{latex}{\out{\hypertarget{method-users_system}{}}}
\r
2263 \subsection{Method \code{users_system()}}{
\r
2264 users_system is a method defined in Arvados class.
\r
2265 \subsection{Usage}{
\r
2266 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_system()}\if{html}{\out{</div>}}
\r
2270 \if{html}{\out{<hr>}}
\r
2271 \if{html}{\out{<a id="method-users_activate"></a>}}
\r
2272 \if{latex}{\out{\hypertarget{method-users_activate}{}}}
\r
2273 \subsection{Method \code{users_activate()}}{
\r
2274 users_activate is a method defined in Arvados class.
\r
2275 \subsection{Usage}{
\r
2276 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_activate(uuid)}\if{html}{\out{</div>}}
\r
2279 \subsection{Arguments}{
\r
2280 \if{html}{\out{<div class="arguments">}}
\r
2282 \item{\code{uuid}}{The UUID of the User in question.}
\r
2284 \if{html}{\out{</div>}}
\r
2287 \if{html}{\out{<hr>}}
\r
2288 \if{html}{\out{<a id="method-users_setup"></a>}}
\r
2289 \if{latex}{\out{\hypertarget{method-users_setup}{}}}
\r
2290 \subsection{Method \code{users_setup()}}{
\r
2291 users_setup is a method defined in Arvados class.
\r
2292 \subsection{Usage}{
\r
2293 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_setup(
\r
2298 send_notification_email = "false"
\r
2299 )}\if{html}{\out{</div>}}
\r
2303 \if{html}{\out{<hr>}}
\r
2304 \if{html}{\out{<a id="method-users_unsetup"></a>}}
\r
2305 \if{latex}{\out{\hypertarget{method-users_unsetup}{}}}
\r
2306 \subsection{Method \code{users_unsetup()}}{
\r
2307 users_unsetup is a method defined in Arvados class.
\r
2308 \subsection{Usage}{
\r
2309 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_unsetup(uuid)}\if{html}{\out{</div>}}
\r
2312 \subsection{Arguments}{
\r
2313 \if{html}{\out{<div class="arguments">}}
\r
2315 \item{\code{uuid}}{The UUID of the User in question.}
\r
2317 \if{html}{\out{</div>}}
\r
2320 \if{html}{\out{<hr>}}
\r
2321 \if{html}{\out{<a id="method-users_merge"></a>}}
\r
2322 \if{latex}{\out{\hypertarget{method-users_merge}{}}}
\r
2323 \subsection{Method \code{users_merge()}}{
\r
2324 users_merge is a method defined in Arvados class.
\r
2325 \subsection{Usage}{
\r
2326 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_merge(
\r
2328 newUserToken = NULL,
\r
2329 redirectToNewUser = NULL,
\r
2330 oldUserUUID = NULL,
\r
2331 newUserUUID = NULL
\r
2332 )}\if{html}{\out{</div>}}
\r
2336 \if{html}{\out{<hr>}}
\r
2337 \if{html}{\out{<a id="method-users_list"></a>}}
\r
2338 \if{latex}{\out{\hypertarget{method-users_list}{}}}
\r
2339 \subsection{Method \code{users_list()}}{
\r
2340 users_list is a method defined in Arvados class.
\r
2341 \subsection{Usage}{
\r
2342 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_list(
\r
2352 bypassFederation = NULL
\r
2353 )}\if{html}{\out{</div>}}
\r
2356 \subsection{Arguments}{
\r
2357 \if{html}{\out{<div class="arguments">}}
\r
2359 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
2361 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
2363 \if{html}{\out{</div>}}
\r
2366 \if{html}{\out{<hr>}}
\r
2367 \if{html}{\out{<a id="method-repositories_get"></a>}}
\r
2368 \if{latex}{\out{\hypertarget{method-repositories_get}{}}}
\r
2369 \subsection{Method \code{repositories_get()}}{
\r
2370 repositories_get is a method defined in Arvados class.
\r
2371 \subsection{Usage}{
\r
2372 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_get(uuid)}\if{html}{\out{</div>}}
\r
2375 \subsection{Arguments}{
\r
2376 \if{html}{\out{<div class="arguments">}}
\r
2378 \item{\code{uuid}}{The UUID of the Repository in question.}
\r
2380 \if{html}{\out{</div>}}
\r
2383 \if{html}{\out{<hr>}}
\r
2384 \if{html}{\out{<a id="method-repositories_create"></a>}}
\r
2385 \if{latex}{\out{\hypertarget{method-repositories_create}{}}}
\r
2386 \subsection{Method \code{repositories_create()}}{
\r
2387 repositories_create is a method defined in Arvados class.
\r
2388 \subsection{Usage}{
\r
2389 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_create(
\r
2391 ensureUniqueName = "false",
\r
2393 )}\if{html}{\out{</div>}}
\r
2396 \subsection{Arguments}{
\r
2397 \if{html}{\out{<div class="arguments">}}
\r
2399 \item{\code{repository}}{Repository object.}
\r
2401 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
2403 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
2405 \if{html}{\out{</div>}}
\r
2408 \if{html}{\out{<hr>}}
\r
2409 \if{html}{\out{<a id="method-repositories_update"></a>}}
\r
2410 \if{latex}{\out{\hypertarget{method-repositories_update}{}}}
\r
2411 \subsection{Method \code{repositories_update()}}{
\r
2412 repositories_update is a method defined in Arvados class.
\r
2413 \subsection{Usage}{
\r
2414 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_update(repository, uuid)}\if{html}{\out{</div>}}
\r
2417 \subsection{Arguments}{
\r
2418 \if{html}{\out{<div class="arguments">}}
\r
2420 \item{\code{repository}}{Repository object.}
\r
2422 \item{\code{uuid}}{The UUID of the Repository in question.}
\r
2424 \if{html}{\out{</div>}}
\r
2427 \if{html}{\out{<hr>}}
\r
2428 \if{html}{\out{<a id="method-repositories_delete"></a>}}
\r
2429 \if{latex}{\out{\hypertarget{method-repositories_delete}{}}}
\r
2430 \subsection{Method \code{repositories_delete()}}{
\r
2431 repositories_delete is a method defined in Arvados class.
\r
2432 \subsection{Usage}{
\r
2433 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_delete(uuid)}\if{html}{\out{</div>}}
\r
2436 \subsection{Arguments}{
\r
2437 \if{html}{\out{<div class="arguments">}}
\r
2439 \item{\code{uuid}}{The UUID of the Repository in question.}
\r
2441 \if{html}{\out{</div>}}
\r
2444 \if{html}{\out{<hr>}}
\r
2445 \if{html}{\out{<a id="method-repositories_get_all_permissions"></a>}}
\r
2446 \if{latex}{\out{\hypertarget{method-repositories_get_all_permissions}{}}}
\r
2447 \subsection{Method \code{repositories_get_all_permissions()}}{
\r
2448 repositories_get_all_permissions is a method defined in Arvados class.
\r
2449 \subsection{Usage}{
\r
2450 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_get_all_permissions()}\if{html}{\out{</div>}}
\r
2454 \if{html}{\out{<hr>}}
\r
2455 \if{html}{\out{<a id="method-repositories_list"></a>}}
\r
2456 \if{latex}{\out{\hypertarget{method-repositories_list}{}}}
\r
2457 \subsection{Method \code{repositories_list()}}{
\r
2458 repositories_list is a method defined in Arvados class.
\r
2459 \subsection{Usage}{
\r
2460 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_list(
\r
2470 bypassFederation = NULL
\r
2471 )}\if{html}{\out{</div>}}
\r
2474 \subsection{Arguments}{
\r
2475 \if{html}{\out{<div class="arguments">}}
\r
2477 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
2479 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
2481 \if{html}{\out{</div>}}
\r
2484 \if{html}{\out{<hr>}}
\r
2485 \if{html}{\out{<a id="method-virtual_machines_get"></a>}}
\r
2486 \if{latex}{\out{\hypertarget{method-virtual_machines_get}{}}}
\r
2487 \subsection{Method \code{virtual_machines_get()}}{
\r
2488 virtual_machines_get is a method defined in Arvados class.
\r
2489 \subsection{Usage}{
\r
2490 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_get(uuid)}\if{html}{\out{</div>}}
\r
2493 \subsection{Arguments}{
\r
2494 \if{html}{\out{<div class="arguments">}}
\r
2496 \item{\code{uuid}}{The UUID of the virtualMachine in question.}
\r
2498 \if{html}{\out{</div>}}
\r
2501 \if{html}{\out{<hr>}}
\r
2502 \if{html}{\out{<a id="method-virtual_machines_create"></a>}}
\r
2503 \if{latex}{\out{\hypertarget{method-virtual_machines_create}{}}}
\r
2504 \subsection{Method \code{virtual_machines_create()}}{
\r
2505 virtual_machines_create is a method defined in Arvados class.
\r
2506 \subsection{Usage}{
\r
2507 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_create(
\r
2509 ensureUniqueName = "false",
\r
2511 )}\if{html}{\out{</div>}}
\r
2514 \subsection{Arguments}{
\r
2515 \if{html}{\out{<div class="arguments">}}
\r
2517 \item{\code{virtualMachine}}{virtualMachine object.}
\r
2519 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
2521 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
2523 \if{html}{\out{</div>}}
\r
2526 \if{html}{\out{<hr>}}
\r
2527 \if{html}{\out{<a id="method-virtual_machines_update"></a>}}
\r
2528 \if{latex}{\out{\hypertarget{method-virtual_machines_update}{}}}
\r
2529 \subsection{Method \code{virtual_machines_update()}}{
\r
2530 virtual_machines_update is a method defined in Arvados class.
\r
2531 \subsection{Usage}{
\r
2532 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_update(virtualMachine, uuid)}\if{html}{\out{</div>}}
\r
2535 \subsection{Arguments}{
\r
2536 \if{html}{\out{<div class="arguments">}}
\r
2538 \item{\code{virtualMachine}}{virtualMachine object.}
\r
2540 \item{\code{uuid}}{The UUID of the virtualMachine in question.}
\r
2542 \if{html}{\out{</div>}}
\r
2545 \if{html}{\out{<hr>}}
\r
2546 \if{html}{\out{<a id="method-virtual_machines_delete"></a>}}
\r
2547 \if{latex}{\out{\hypertarget{method-virtual_machines_delete}{}}}
\r
2548 \subsection{Method \code{virtual_machines_delete()}}{
\r
2549 virtual_machines_delete is a method defined in Arvados class.
\r
2550 \subsection{Usage}{
\r
2551 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_delete(uuid)}\if{html}{\out{</div>}}
\r
2554 \subsection{Arguments}{
\r
2555 \if{html}{\out{<div class="arguments">}}
\r
2557 \item{\code{uuid}}{The UUID of the virtualMachine in question.}
\r
2559 \if{html}{\out{</div>}}
\r
2562 \if{html}{\out{<hr>}}
\r
2563 \if{html}{\out{<a id="method-virtual_machines_logins"></a>}}
\r
2564 \if{latex}{\out{\hypertarget{method-virtual_machines_logins}{}}}
\r
2565 \subsection{Method \code{virtual_machines_logins()}}{
\r
2566 virtual_machines_logins is a method defined in Arvados class.
\r
2567 \subsection{Usage}{
\r
2568 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_logins(uuid)}\if{html}{\out{</div>}}
\r
2571 \subsection{Arguments}{
\r
2572 \if{html}{\out{<div class="arguments">}}
\r
2574 \item{\code{uuid}}{The UUID of the virtualMachine in question.}
\r
2576 \if{html}{\out{</div>}}
\r
2579 \if{html}{\out{<hr>}}
\r
2580 \if{html}{\out{<a id="method-virtual_machines_get_all_logins"></a>}}
\r
2581 \if{latex}{\out{\hypertarget{method-virtual_machines_get_all_logins}{}}}
\r
2582 \subsection{Method \code{virtual_machines_get_all_logins()}}{
\r
2583 virtual_machines_get_all_logins is a method defined in Arvados class.
\r
2584 \subsection{Usage}{
\r
2585 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_get_all_logins()}\if{html}{\out{</div>}}
\r
2589 \if{html}{\out{<hr>}}
\r
2590 \if{html}{\out{<a id="method-virtual_machines_list"></a>}}
\r
2591 \if{latex}{\out{\hypertarget{method-virtual_machines_list}{}}}
\r
2592 \subsection{Method \code{virtual_machines_list()}}{
\r
2593 virtual_machines_list is a method defined in Arvados class.
\r
2594 \subsection{Usage}{
\r
2595 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_list(
\r
2605 bypassFederation = NULL
\r
2606 )}\if{html}{\out{</div>}}
\r
2609 \subsection{Arguments}{
\r
2610 \if{html}{\out{<div class="arguments">}}
\r
2612 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
2614 \item{\code{bypassFederation}}{bypass federation behavior, list items from local instance database only}
\r
2616 \if{html}{\out{</div>}}
\r
2619 \if{html}{\out{<hr>}}
\r
2620 \if{html}{\out{<a id="method-workflows_get"></a>}}
\r
2621 \if{latex}{\out{\hypertarget{method-workflows_get}{}}}
\r
2622 \subsection{Method \code{workflows_get()}}{
\r
2623 workflows_get is a method defined in Arvados class.
\r
2624 \subsection{Usage}{
\r
2625 \if{html}{\out{<div class="r">}}\preformatted{Arvados$workflows_get(uuid)}\if{html}{\out{</div>}}
\r
2628 \subsection{Arguments}{
\r
2629 \if{html}{\out{<div class="arguments">}}
\r
2631 \item{\code{uuid}}{The UUID of the Workflow in question.}
\r
2633 \if{html}{\out{</div>}}
\r
2636 \if{html}{\out{<hr>}}
\r
2637 \if{html}{\out{<a id="method-workflows_create"></a>}}
\r
2638 \if{latex}{\out{\hypertarget{method-workflows_create}{}}}
\r
2639 \subsection{Method \code{workflows_create()}}{
\r
2640 workflows_create is a method defined in Arvados class.
\r
2641 \subsection{Usage}{
\r
2642 \if{html}{\out{<div class="r">}}\preformatted{Arvados$workflows_create(
\r
2644 ensureUniqueName = "false",
\r
2646 )}\if{html}{\out{</div>}}
\r
2649 \subsection{Arguments}{
\r
2650 \if{html}{\out{<div class="arguments">}}
\r
2652 \item{\code{workflow}}{Workflow object.}
\r
2654 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
2656 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
2658 \if{html}{\out{</div>}}
\r
2661 \if{html}{\out{<hr>}}
\r
2662 \if{html}{\out{<a id="method-workflows_update"></a>}}
\r
2663 \if{latex}{\out{\hypertarget{method-workflows_update}{}}}
\r
2664 \subsection{Method \code{workflows_update()}}{
\r
2665 workflows_update is a method defined in Arvados class.
\r
2666 \subsection{Usage}{
\r
2667 \if{html}{\out{<div class="r">}}\preformatted{Arvados$workflows_update(workflow, uuid)}\if{html}{\out{</div>}}
\r
2670 \subsection{Arguments}{
\r
2671 \if{html}{\out{<div class="arguments">}}
\r
2673 \item{\code{workflow}}{Workflow object.}
\r
2675 \item{\code{uuid}}{The UUID of the Workflow in question.}
\r
2677 \if{html}{\out{</div>}}
\r
2680 \if{html}{\out{<hr>}}
\r
2681 \if{html}{\out{<a id="method-workflows_delete"></a>}}
\r
2682 \if{latex}{\out{\hypertarget{method-workflows_delete}{}}}
\r
2683 \subsection{Method \code{workflows_delete()}}{
\r
2684 workflows_delete is a method defined in Arvados class.
\r
2685 \subsection{Usage}{
\r
2686 \if{html}{\out{<div class="r">}}\preformatted{Arvados$workflows_delete(uuid)}\if{html}{\out{</div>}}
\r
2689 \subsection{Arguments}{
\r
2690 \if{html}{\out{<div class="arguments">}}
\r
2692 \item{\code{uuid}}{The UUID of the Workflow in question.}
\r
2694 \if{html}{\out{</div>}}
\r
2697 \if{html}{\out{<hr>}}
\r
2698 \if{html}{\out{<a id="method-workflows_list"></a>}}
\r
2699 \if{latex}{\out{\hypertarget{method-workflows_list}{}}}
\r
2700 \subsection{Method \code{workflows_list()}}{
\r
2701 workflows_list is a method defined in Arvados class.
\r
2702 \subsection{Usage}{
\r
2703 \if{html}{\out{<div class="r">}}\preformatted{Arvados$workflows_list(
\r
2713 bypassFederation = NULL
\r
2714 )}\if{html}{\out{</div>}}
\r
2717 \subsection{Arguments}{
\r
2718 \if{html}{\out{<div class="arguments">}}
\r
2720 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
2722 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
2724 \if{html}{\out{</div>}}
\r
2727 \if{html}{\out{<hr>}}
\r
2728 \if{html}{\out{<a id="method-user_agreements_get"></a>}}
\r
2729 \if{latex}{\out{\hypertarget{method-user_agreements_get}{}}}
\r
2730 \subsection{Method \code{user_agreements_get()}}{
\r
2731 user_agreements_get is a method defined in Arvados class.
\r
2732 \subsection{Usage}{
\r
2733 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_get(uuid)}\if{html}{\out{</div>}}
\r
2736 \subsection{Arguments}{
\r
2737 \if{html}{\out{<div class="arguments">}}
\r
2739 \item{\code{uuid}}{The UUID of the userAgreement in question.}
\r
2741 \if{html}{\out{</div>}}
\r
2744 \if{html}{\out{<hr>}}
\r
2745 \if{html}{\out{<a id="method-user_agreements_create"></a>}}
\r
2746 \if{latex}{\out{\hypertarget{method-user_agreements_create}{}}}
\r
2747 \subsection{Method \code{user_agreements_create()}}{
\r
2748 user_agreements_create is a method defined in Arvados class.
\r
2749 \subsection{Usage}{
\r
2750 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_create(
\r
2752 ensureUniqueName = "false",
\r
2754 )}\if{html}{\out{</div>}}
\r
2757 \subsection{Arguments}{
\r
2758 \if{html}{\out{<div class="arguments">}}
\r
2760 \item{\code{userAgreement}}{userAgreement object.}
\r
2762 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}
\r
2764 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}
\r
2766 \if{html}{\out{</div>}}
\r
2769 \if{html}{\out{<hr>}}
\r
2770 \if{html}{\out{<a id="method-user_agreements_update"></a>}}
\r
2771 \if{latex}{\out{\hypertarget{method-user_agreements_update}{}}}
\r
2772 \subsection{Method \code{user_agreements_update()}}{
\r
2773 user_agreements_update is a method defined in Arvados class.
\r
2774 \subsection{Usage}{
\r
2775 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_update(userAgreement, uuid)}\if{html}{\out{</div>}}
\r
2778 \subsection{Arguments}{
\r
2779 \if{html}{\out{<div class="arguments">}}
\r
2781 \item{\code{userAgreement}}{userAgreement object.}
\r
2783 \item{\code{uuid}}{The UUID of the userAgreement in question.}
\r
2785 \if{html}{\out{</div>}}
\r
2788 \if{html}{\out{<hr>}}
\r
2789 \if{html}{\out{<a id="method-user_agreements_delete"></a>}}
\r
2790 \if{latex}{\out{\hypertarget{method-user_agreements_delete}{}}}
\r
2791 \subsection{Method \code{user_agreements_delete()}}{
\r
2792 user_agreements_delete is a method defined in Arvados class.
\r
2793 \subsection{Usage}{
\r
2794 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_delete(uuid)}\if{html}{\out{</div>}}
\r
2797 \subsection{Arguments}{
\r
2798 \if{html}{\out{<div class="arguments">}}
\r
2800 \item{\code{uuid}}{The UUID of the userAgreement in question.}
\r
2802 \if{html}{\out{</div>}}
\r
2805 \if{html}{\out{<hr>}}
\r
2806 \if{html}{\out{<a id="method-user_agreements_signatures"></a>}}
\r
2807 \if{latex}{\out{\hypertarget{method-user_agreements_signatures}{}}}
\r
2808 \subsection{Method \code{user_agreements_signatures()}}{
\r
2809 user_agreements_signatures is a method defined in Arvados class.
\r
2810 \subsection{Usage}{
\r
2811 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_signatures()}\if{html}{\out{</div>}}
\r
2815 \if{html}{\out{<hr>}}
\r
2816 \if{html}{\out{<a id="method-user_agreements_sign"></a>}}
\r
2817 \if{latex}{\out{\hypertarget{method-user_agreements_sign}{}}}
\r
2818 \subsection{Method \code{user_agreements_sign()}}{
\r
2819 user_agreements_sign is a method defined in Arvados class.
\r
2820 \subsection{Usage}{
\r
2821 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_sign()}\if{html}{\out{</div>}}
\r
2825 \if{html}{\out{<hr>}}
\r
2826 \if{html}{\out{<a id="method-user_agreements_list"></a>}}
\r
2827 \if{latex}{\out{\hypertarget{method-user_agreements_list}{}}}
\r
2828 \subsection{Method \code{user_agreements_list()}}{
\r
2829 user_agreements_list is a method defined in Arvados class.
\r
2830 \subsection{Usage}{
\r
2831 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_list(
\r
2841 bypassFederation = NULL
\r
2842 )}\if{html}{\out{</div>}}
\r
2845 \subsection{Arguments}{
\r
2846 \if{html}{\out{<div class="arguments">}}
\r
2848 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}
\r
2850 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}
\r
2852 \if{html}{\out{</div>}}
\r
2855 \if{html}{\out{<hr>}}
\r
2856 \if{html}{\out{<a id="method-user_agreements_new"></a>}}
\r
2857 \if{latex}{\out{\hypertarget{method-user_agreements_new}{}}}
\r
2858 \subsection{Method \code{user_agreements_new()}}{
\r
2859 user_agreements_new is a method defined in Arvados class.
\r
2860 \subsection{Usage}{
\r
2861 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_new()}\if{html}{\out{</div>}}
\r
2865 \if{html}{\out{<hr>}}
\r
2866 \if{html}{\out{<a id="method-configs_get"></a>}}
\r
2867 \if{latex}{\out{\hypertarget{method-configs_get}{}}}
\r
2868 \subsection{Method \code{configs_get()}}{
\r
2869 configs_get is a method defined in Arvados class.
\r
2870 \subsection{Usage}{
\r
2871 \if{html}{\out{<div class="r">}}\preformatted{Arvados$configs_get()}\if{html}{\out{</div>}}
\r
2875 \if{html}{\out{<hr>}}
\r
2876 \if{html}{\out{<a id="method-getHostName"></a>}}
\r
2877 \if{latex}{\out{\hypertarget{method-getHostName}{}}}
\r
2878 \subsection{Method \code{getHostName()}}{
\r
2879 \subsection{Usage}{
\r
2880 \if{html}{\out{<div class="r">}}\preformatted{Arvados$getHostName()}\if{html}{\out{</div>}}
\r
2884 \if{html}{\out{<hr>}}
\r
2885 \if{html}{\out{<a id="method-getToken"></a>}}
\r
2886 \if{latex}{\out{\hypertarget{method-getToken}{}}}
\r
2887 \subsection{Method \code{getToken()}}{
\r
2888 \subsection{Usage}{
\r
2889 \if{html}{\out{<div class="r">}}\preformatted{Arvados$getToken()}\if{html}{\out{</div>}}
\r
2893 \if{html}{\out{<hr>}}
\r
2894 \if{html}{\out{<a id="method-setRESTService"></a>}}
\r
2895 \if{latex}{\out{\hypertarget{method-setRESTService}{}}}
\r
2896 \subsection{Method \code{setRESTService()}}{
\r
2897 \subsection{Usage}{
\r
2898 \if{html}{\out{<div class="r">}}\preformatted{Arvados$setRESTService(newREST)}\if{html}{\out{</div>}}
\r
2902 \if{html}{\out{<hr>}}
\r
2903 \if{html}{\out{<a id="method-getRESTService"></a>}}
\r
2904 \if{latex}{\out{\hypertarget{method-getRESTService}{}}}
\r
2905 \subsection{Method \code{getRESTService()}}{
\r
2906 \subsection{Usage}{
\r
2907 \if{html}{\out{<div class="r">}}\preformatted{Arvados$getRESTService()}\if{html}{\out{</div>}}
\r