sdk/R/man/Arvados.Rd

   1 % Generated by roxygen2: do not edit by hand\r
   2 % Please edit documentation in R/Arvados.R\r
   3 \name{Arvados}\r
   4 \alias{Arvados}\r
   5 \title{R6 Class Representing a Arvados}\r
   6 \description{\r
   7 Arvados class gives users ability to access Arvados REST API. It also allowes user to manipulate collections (and projects?)\r
   8 }\r
   9 \examples{\r
  10 \r
  11 ## ------------------------------------------------\r
  12 ## Method `Arvados$new`\r
  13 ## ------------------------------------------------\r
  14 \r
  15 arv <- Arvados$new(authToken = "ARVADOS_API_TOKEN", hostName = "ARVADOS_API_HOST", numRetries = 3)\r
  16 \r
  17 ## ------------------------------------------------\r
  18 ## Method `Arvados$project_exist`\r
  19 ## ------------------------------------------------\r
  20 \r
  21 \dontrun{\r
  22 arv$project_exist(uuid = "projectUUID")\r
  23 }\r
  24 \r
  25 ## ------------------------------------------------\r
  26 ## Method `Arvados$project_get`\r
  27 ## ------------------------------------------------\r
  28 \r
  29 \dontrun{\r
  30 project <- arv$project_get(uuid = 'projectUUID')\r
  31 }\r
  32 \r
  33 ## ------------------------------------------------\r
  34 ## Method `Arvados$project_create`\r
  35 ## ------------------------------------------------\r
  36 \r
  37 \dontrun{\r
  38 Properties <- list() # should contain a list of new properties to be added\r
  39 new_project <- arv$project_create(name = "project name", description = "project description", owner_uuid = "project UUID", properties = NULL, ensureUniqueName = "false")\r
  40 }\r
  41 \r
  42 ## ------------------------------------------------\r
  43 ## Method `Arvados$project_properties_set`\r
  44 ## ------------------------------------------------\r
  45 \r
  46 \dontrun{\r
  47 Properties <- list() # should contain a list of new properties to be added\r
  48 arv$project_properties_set(Properties, uuid)\r
  49 }\r
  50 \r
  51 ## ------------------------------------------------\r
  52 ## Method `Arvados$project_properties_append`\r
  53 ## ------------------------------------------------\r
  54 \r
  55 \dontrun{\r
  56 newProperties <- list() # should contain a list of new properties to be added\r
  57 arv$project_properties_append(properties = newProperties, uuid)\r
  58 }\r
  59 \r
  60 ## ------------------------------------------------\r
  61 ## Method `Arvados$project_properties_get`\r
  62 ## ------------------------------------------------\r
  63 \r
  64 \dontrun{\r
  65 arv$project_properties_get(projectUUID)\r
  66 }\r
  67 \r
  68 ## ------------------------------------------------\r
  69 ## Method `Arvados$project_properties_delete`\r
  70 ## ------------------------------------------------\r
  71 \r
  72 \dontrun{\r
  73 Properties <- list() # should contain a list of new properties to be added\r
  74 arv$project_properties_delete(Properties,  projectUUID)\r
  75 }\r
  76 \r
  77 ## ------------------------------------------------\r
  78 ## Method `Arvados$project_update`\r
  79 ## ------------------------------------------------\r
  80 \r
  81 \dontrun{\r
  82 newProperties <- list() # should contain a list of new properties to be added\r
  83 arv$project_update(name = "new project name", properties = newProperties, uuid = projectUUID)\r
  84 }\r
  85 \r
  86 ## ------------------------------------------------\r
  87 ## Method `Arvados$project_list`\r
  88 ## ------------------------------------------------\r
  89 \r
  90 \dontrun{\r
  91 listOfprojects <- arv$project_list(list(list("owner_uuid", "=", projectUUID))) # Sample query which show projects within the project of a given UUID\r
  92 }\r
  93 \r
  94 ## ------------------------------------------------\r
  95 ## Method `Arvados$project_delete`\r
  96 ## ------------------------------------------------\r
  97 \r
  98 \dontrun{\r
  99 arv$project_delete(uuid = 'projectUUID')\r
 100 }\r
 101 \r
 102 ## ------------------------------------------------\r
 103 ## Method `Arvados$collections_get`\r
 104 ## ------------------------------------------------\r
 105 \r
 106 \dontrun{\r
 107 collection <- arv$collections_get(uuid = collectionUUID)\r
 108 }\r
 109 \r
 110 ## ------------------------------------------------\r
 111 ## Method `Arvados$collections_create`\r
 112 ## ------------------------------------------------\r
 113 \r
 114 \dontrun{\r
 115 Properties <- list() # should contain a list of new properties to be added\r
 116 arv$collections_create(name = "collectionTitle", description = "collectionDescription", ownerUUID = "collectionOwner", properties = Properties)\r
 117 }\r
 118 \r
 119 ## ------------------------------------------------\r
 120 ## Method `Arvados$collections_update`\r
 121 ## ------------------------------------------------\r
 122 \r
 123 \dontrun{\r
 124 collection <- arv$collections_update(name = "newCollectionTitle", description = "newCollectionDescription", ownerUUID = "collectionOwner", properties = NULL, uuid = "collectionUUID")\r
 125 }\r
 126 \r
 127 ## ------------------------------------------------\r
 128 ## Method `Arvados$collections_delete`\r
 129 ## ------------------------------------------------\r
 130 \r
 131 \dontrun{\r
 132 arv$collection_delete(collectionUUID)\r
 133 }\r
 134 \r
 135 ## ------------------------------------------------\r
 136 ## Method `Arvados$collections_provenance`\r
 137 ## ------------------------------------------------\r
 138 \r
 139 \dontrun{\r
 140 collection <- arv$collections_provenance(collectionUUID)\r
 141 }\r
 142 \r
 143 ## ------------------------------------------------\r
 144 ## Method `Arvados$collections_trash`\r
 145 ## ------------------------------------------------\r
 146 \r
 147 \dontrun{\r
 148 arv$collections_trash(collectionUUID)\r
 149 }\r
 150 \r
 151 ## ------------------------------------------------\r
 152 ## Method `Arvados$collections_untrash`\r
 153 ## ------------------------------------------------\r
 154 \r
 155 \dontrun{\r
 156 arv$collections_untrash(collectionUUID)\r
 157 }\r
 158 \r
 159 ## ------------------------------------------------\r
 160 ## Method `Arvados$collections_list`\r
 161 ## ------------------------------------------------\r
 162 \r
 163 \dontrun{\r
 164 collectionList <- arv$collections_list(list(list("name", "=", "Example")))\r
 165 }\r
 166 \r
 167 ## ------------------------------------------------\r
 168 ## Method `Arvados$project_permission_give`\r
 169 ## ------------------------------------------------\r
 170 \r
 171 \dontrun{\r
 172 arv$project_permission_give(type = "can_read", uuid = objectUUID, user = userUUID)\r
 173 }\r
 174 \r
 175 ## ------------------------------------------------\r
 176 ## Method `Arvados$project_permission_refuse`\r
 177 ## ------------------------------------------------\r
 178 \r
 179 \dontrun{\r
 180 arv$project_permission_refuse(type = "can_read", uuid = objectUUID, user = userUUID)\r
 181 }\r
 182 \r
 183 ## ------------------------------------------------\r
 184 ## Method `Arvados$project_permission_update`\r
 185 ## ------------------------------------------------\r
 186 \r
 187 \dontrun{\r
 188 arv$project_permission_update(typeOld = "can_read", typeNew = "can_write", uuid = objectUUID, user = userUUID)\r
 189 }\r
 190 \r
 191 ## ------------------------------------------------\r
 192 ## Method `Arvados$project_permission_check`\r
 193 ## ------------------------------------------------\r
 194 \r
 195 \dontrun{\r
 196 arv$project_permission_check(type = "can_read", uuid = objectUUID, user = userUUID)\r
 197 }\r
 198 }\r
 199 \section{Methods}{\r
 200 \subsection{Public methods}{\r
 201 \itemize{\r
 202 \item \href{#method-Arvados-new}{\code{Arvados$new()}}\r
 203 \item \href{#method-Arvados-project_exist}{\code{Arvados$project_exist()}}\r
 204 \item \href{#method-Arvados-project_get}{\code{Arvados$project_get()}}\r
 205 \item \href{#method-Arvados-project_create}{\code{Arvados$project_create()}}\r
 206 \item \href{#method-Arvados-project_properties_set}{\code{Arvados$project_properties_set()}}\r
 207 \item \href{#method-Arvados-project_properties_append}{\code{Arvados$project_properties_append()}}\r
 208 \item \href{#method-Arvados-project_properties_get}{\code{Arvados$project_properties_get()}}\r
 209 \item \href{#method-Arvados-project_properties_delete}{\code{Arvados$project_properties_delete()}}\r
 210 \item \href{#method-Arvados-project_update}{\code{Arvados$project_update()}}\r
 211 \item \href{#method-Arvados-project_list}{\code{Arvados$project_list()}}\r
 212 \item \href{#method-Arvados-project_delete}{\code{Arvados$project_delete()}}\r
 213 \item \href{#method-Arvados-api_clients_get}{\code{Arvados$api_clients_get()}}\r
 214 \item \href{#method-Arvados-api_clients_create}{\code{Arvados$api_clients_create()}}\r
 215 \item \href{#method-Arvados-api_clients_update}{\code{Arvados$api_clients_update()}}\r
 216 \item \href{#method-Arvados-api_clients_delete}{\code{Arvados$api_clients_delete()}}\r
 217 \item \href{#method-Arvados-api_clients_list}{\code{Arvados$api_clients_list()}}\r
 218 \item \href{#method-Arvados-api_client_authorizations_get}{\code{Arvados$api_client_authorizations_get()}}\r
 219 \item \href{#method-Arvados-api_client_authorizations_create}{\code{Arvados$api_client_authorizations_create()}}\r
 220 \item \href{#method-Arvados-api_client_authorizations_update}{\code{Arvados$api_client_authorizations_update()}}\r
 221 \item \href{#method-Arvados-api_client_authorizations_delete}{\code{Arvados$api_client_authorizations_delete()}}\r
 222 \item \href{#method-Arvados-api_client_authorizations_create_system_auth}{\code{Arvados$api_client_authorizations_create_system_auth()}}\r
 223 \item \href{#method-Arvados-api_client_authorizations_current}{\code{Arvados$api_client_authorizations_current()}}\r
 224 \item \href{#method-Arvados-api_client_authorizations_list}{\code{Arvados$api_client_authorizations_list()}}\r
 225 \item \href{#method-Arvados-authorized_keys_get}{\code{Arvados$authorized_keys_get()}}\r
 226 \item \href{#method-Arvados-authorized_keys_create}{\code{Arvados$authorized_keys_create()}}\r
 227 \item \href{#method-Arvados-authorized_keys_update}{\code{Arvados$authorized_keys_update()}}\r
 228 \item \href{#method-Arvados-authorized_keys_delete}{\code{Arvados$authorized_keys_delete()}}\r
 229 \item \href{#method-Arvados-authorized_keys_list}{\code{Arvados$authorized_keys_list()}}\r
 230 \item \href{#method-Arvados-collections_get}{\code{Arvados$collections_get()}}\r
 231 \item \href{#method-Arvados-collections_create}{\code{Arvados$collections_create()}}\r
 232 \item \href{#method-Arvados-collections_update}{\code{Arvados$collections_update()}}\r
 233 \item \href{#method-Arvados-collections_delete}{\code{Arvados$collections_delete()}}\r
 234 \item \href{#method-Arvados-collections_provenance}{\code{Arvados$collections_provenance()}}\r
 235 \item \href{#method-Arvados-collections_used_by}{\code{Arvados$collections_used_by()}}\r
 236 \item \href{#method-Arvados-collections_trash}{\code{Arvados$collections_trash()}}\r
 237 \item \href{#method-Arvados-collections_untrash}{\code{Arvados$collections_untrash()}}\r
 238 \item \href{#method-Arvados-collections_list}{\code{Arvados$collections_list()}}\r
 239 \item \href{#method-Arvados-containers_get}{\code{Arvados$containers_get()}}\r
 240 \item \href{#method-Arvados-containers_create}{\code{Arvados$containers_create()}}\r
 241 \item \href{#method-Arvados-containers_update}{\code{Arvados$containers_update()}}\r
 242 \item \href{#method-Arvados-containers_delete}{\code{Arvados$containers_delete()}}\r
 243 \item \href{#method-Arvados-containers_auth}{\code{Arvados$containers_auth()}}\r
 244 \item \href{#method-Arvados-containers_lock}{\code{Arvados$containers_lock()}}\r
 245 \item \href{#method-Arvados-containers_unlock}{\code{Arvados$containers_unlock()}}\r
 246 \item \href{#method-Arvados-containers_secret_mounts}{\code{Arvados$containers_secret_mounts()}}\r
 247 \item \href{#method-Arvados-containers_current}{\code{Arvados$containers_current()}}\r
 248 \item \href{#method-Arvados-containers_list}{\code{Arvados$containers_list()}}\r
 249 \item \href{#method-Arvados-container_requests_get}{\code{Arvados$container_requests_get()}}\r
 250 \item \href{#method-Arvados-container_requests_create}{\code{Arvados$container_requests_create()}}\r
 251 \item \href{#method-Arvados-container_requests_update}{\code{Arvados$container_requests_update()}}\r
 252 \item \href{#method-Arvados-container_requests_delete}{\code{Arvados$container_requests_delete()}}\r
 253 \item \href{#method-Arvados-container_requests_list}{\code{Arvados$container_requests_list()}}\r
 254 \item \href{#method-Arvados-groups_get}{\code{Arvados$groups_get()}}\r
 255 \item \href{#method-Arvados-groups_create}{\code{Arvados$groups_create()}}\r
 256 \item \href{#method-Arvados-groups_update}{\code{Arvados$groups_update()}}\r
 257 \item \href{#method-Arvados-groups_delete}{\code{Arvados$groups_delete()}}\r
 258 \item \href{#method-Arvados-groups_contents}{\code{Arvados$groups_contents()}}\r
 259 \item \href{#method-Arvados-groups_shared}{\code{Arvados$groups_shared()}}\r
 260 \item \href{#method-Arvados-groups_trash}{\code{Arvados$groups_trash()}}\r
 261 \item \href{#method-Arvados-groups_untrash}{\code{Arvados$groups_untrash()}}\r
 262 \item \href{#method-Arvados-groups_list}{\code{Arvados$groups_list()}}\r
 263 \item \href{#method-Arvados-keep_services_get}{\code{Arvados$keep_services_get()}}\r
 264 \item \href{#method-Arvados-keep_services_create}{\code{Arvados$keep_services_create()}}\r
 265 \item \href{#method-Arvados-keep_services_update}{\code{Arvados$keep_services_update()}}\r
 266 \item \href{#method-Arvados-keep_services_delete}{\code{Arvados$keep_services_delete()}}\r
 267 \item \href{#method-Arvados-keep_services_accessible}{\code{Arvados$keep_services_accessible()}}\r
 268 \item \href{#method-Arvados-keep_services_list}{\code{Arvados$keep_services_list()}}\r
 269 \item \href{#method-Arvados-project_permission_give}{\code{Arvados$project_permission_give()}}\r
 270 \item \href{#method-Arvados-project_permission_refuse}{\code{Arvados$project_permission_refuse()}}\r
 271 \item \href{#method-Arvados-project_permission_update}{\code{Arvados$project_permission_update()}}\r
 272 \item \href{#method-Arvados-project_permission_check}{\code{Arvados$project_permission_check()}}\r
 273 \item \href{#method-Arvados-links_get}{\code{Arvados$links_get()}}\r
 274 \item \href{#method-Arvados-links_create}{\code{Arvados$links_create()}}\r
 275 \item \href{#method-Arvados-links_update}{\code{Arvados$links_update()}}\r
 276 \item \href{#method-Arvados-links_delete}{\code{Arvados$links_delete()}}\r
 277 \item \href{#method-Arvados-links_list}{\code{Arvados$links_list()}}\r
 278 \item \href{#method-Arvados-links_get_permissions}{\code{Arvados$links_get_permissions()}}\r
 279 \item \href{#method-Arvados-logs_get}{\code{Arvados$logs_get()}}\r
 280 \item \href{#method-Arvados-logs_create}{\code{Arvados$logs_create()}}\r
 281 \item \href{#method-Arvados-logs_update}{\code{Arvados$logs_update()}}\r
 282 \item \href{#method-Arvados-logs_delete}{\code{Arvados$logs_delete()}}\r
 283 \item \href{#method-Arvados-logs_list}{\code{Arvados$logs_list()}}\r
 284 \item \href{#method-Arvados-users_get}{\code{Arvados$users_get()}}\r
 285 \item \href{#method-Arvados-users_create}{\code{Arvados$users_create()}}\r
 286 \item \href{#method-Arvados-users_update}{\code{Arvados$users_update()}}\r
 287 \item \href{#method-Arvados-users_delete}{\code{Arvados$users_delete()}}\r
 288 \item \href{#method-Arvados-users_current}{\code{Arvados$users_current()}}\r
 289 \item \href{#method-Arvados-users_system}{\code{Arvados$users_system()}}\r
 290 \item \href{#method-Arvados-users_activate}{\code{Arvados$users_activate()}}\r
 291 \item \href{#method-Arvados-users_setup}{\code{Arvados$users_setup()}}\r
 292 \item \href{#method-Arvados-users_unsetup}{\code{Arvados$users_unsetup()}}\r
 293 \item \href{#method-Arvados-users_merge}{\code{Arvados$users_merge()}}\r
 294 \item \href{#method-Arvados-users_list}{\code{Arvados$users_list()}}\r
 295 \item \href{#method-Arvados-repositories_get}{\code{Arvados$repositories_get()}}\r
 296 \item \href{#method-Arvados-repositories_create}{\code{Arvados$repositories_create()}}\r
 297 \item \href{#method-Arvados-repositories_update}{\code{Arvados$repositories_update()}}\r
 298 \item \href{#method-Arvados-repositories_delete}{\code{Arvados$repositories_delete()}}\r
 299 \item \href{#method-Arvados-repositories_get_all_permissions}{\code{Arvados$repositories_get_all_permissions()}}\r
 300 \item \href{#method-Arvados-repositories_list}{\code{Arvados$repositories_list()}}\r
 301 \item \href{#method-Arvados-virtual_machines_get}{\code{Arvados$virtual_machines_get()}}\r
 302 \item \href{#method-Arvados-virtual_machines_create}{\code{Arvados$virtual_machines_create()}}\r
 303 \item \href{#method-Arvados-virtual_machines_update}{\code{Arvados$virtual_machines_update()}}\r
 304 \item \href{#method-Arvados-virtual_machines_delete}{\code{Arvados$virtual_machines_delete()}}\r
 305 \item \href{#method-Arvados-virtual_machines_logins}{\code{Arvados$virtual_machines_logins()}}\r
 306 \item \href{#method-Arvados-virtual_machines_get_all_logins}{\code{Arvados$virtual_machines_get_all_logins()}}\r
 307 \item \href{#method-Arvados-virtual_machines_list}{\code{Arvados$virtual_machines_list()}}\r
 308 \item \href{#method-Arvados-workflows_get}{\code{Arvados$workflows_get()}}\r
 309 \item \href{#method-Arvados-workflows_create}{\code{Arvados$workflows_create()}}\r
 310 \item \href{#method-Arvados-workflows_update}{\code{Arvados$workflows_update()}}\r
 311 \item \href{#method-Arvados-workflows_delete}{\code{Arvados$workflows_delete()}}\r
 312 \item \href{#method-Arvados-workflows_list}{\code{Arvados$workflows_list()}}\r
 313 \item \href{#method-Arvados-user_agreements_get}{\code{Arvados$user_agreements_get()}}\r
 314 \item \href{#method-Arvados-user_agreements_create}{\code{Arvados$user_agreements_create()}}\r
 315 \item \href{#method-Arvados-user_agreements_update}{\code{Arvados$user_agreements_update()}}\r
 316 \item \href{#method-Arvados-user_agreements_delete}{\code{Arvados$user_agreements_delete()}}\r
 317 \item \href{#method-Arvados-user_agreements_signatures}{\code{Arvados$user_agreements_signatures()}}\r
 318 \item \href{#method-Arvados-user_agreements_sign}{\code{Arvados$user_agreements_sign()}}\r
 319 \item \href{#method-Arvados-user_agreements_list}{\code{Arvados$user_agreements_list()}}\r
 320 \item \href{#method-Arvados-user_agreements_new}{\code{Arvados$user_agreements_new()}}\r
 321 \item \href{#method-Arvados-configs_get}{\code{Arvados$configs_get()}}\r
 322 \item \href{#method-Arvados-getHostName}{\code{Arvados$getHostName()}}\r
 323 \item \href{#method-Arvados-getToken}{\code{Arvados$getToken()}}\r
 324 \item \href{#method-Arvados-setRESTService}{\code{Arvados$setRESTService()}}\r
 325 \item \href{#method-Arvados-getRESTService}{\code{Arvados$getRESTService()}}\r
 326 }\r
 327 }\r
 328 \if{html}{\out{<hr>}}\r
 329 \if{html}{\out{<a id="method-Arvados-new"></a>}}\r
 330 \if{latex}{\out{\hypertarget{method-Arvados-new}{}}}\r
 331 \subsection{Method \code{new()}}{\r
 332 Initialize new enviroment.\r
 333 \subsection{Usage}{\r
 334 \if{html}{\out{<div class="r">}}\preformatted{Arvados$new(authToken = NULL, hostName = NULL, numRetries = 0)}\if{html}{\out{</div>}}\r
 335 }\r
 336 \r
 337 \subsection{Arguments}{\r
 338 \if{html}{\out{<div class="arguments">}}\r
 339 \describe{\r
 340 \item{\code{authToken}}{ARVADOS_API_TOKEN from 'Get API Token' on Arvados.}\r
 341 \r
 342 \item{\code{hostName}}{ARVADOS_API_HOST from 'Get API Token' on Arvados.}\r
 343 \r
 344 \item{\code{numRetries}}{Specify number of times to retry failed service requests.}\r
 345 }\r
 346 \if{html}{\out{</div>}}\r
 347 }\r
 348 \subsection{Returns}{\r
 349 A new `Arvados` object.\r
 350 }\r
 351 \subsection{Examples}{\r
 352 \if{html}{\out{<div class="r example copy">}}\r
 353 \preformatted{arv <- Arvados$new(authToken = "ARVADOS_API_TOKEN", hostName = "ARVADOS_API_HOST", numRetries = 3)\r
 354 }\r
 355 \if{html}{\out{</div>}}\r
 356 \r
 357 }\r
 358 \r
 359 }\r
 360 \if{html}{\out{<hr>}}\r
 361 \if{html}{\out{<a id="method-Arvados-project_exist"></a>}}\r
 362 \if{latex}{\out{\hypertarget{method-Arvados-project_exist}{}}}\r
 363 \subsection{Method \code{project_exist()}}{\r
 364 project_exist enables checking if the project with such a UUID exist.\r
 365 \subsection{Usage}{\r
 366 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_exist(uuid)}\if{html}{\out{</div>}}\r
 367 }\r
 368 \r
 369 \subsection{Arguments}{\r
 370 \if{html}{\out{<div class="arguments">}}\r
 371 \describe{\r
 372 \item{\code{uuid}}{The UUID of a project or a file.}\r
 373 }\r
 374 \if{html}{\out{</div>}}\r
 375 }\r
 376 \subsection{Examples}{\r
 377 \if{html}{\out{<div class="r example copy">}}\r
 378 \preformatted{\dontrun{\r
 379 arv$project_exist(uuid = "projectUUID")\r
 380 }\r
 381 }\r
 382 \if{html}{\out{</div>}}\r
 383 \r
 384 }\r
 385 \r
 386 }\r
 387 \if{html}{\out{<hr>}}\r
 388 \if{html}{\out{<a id="method-Arvados-project_get"></a>}}\r
 389 \if{latex}{\out{\hypertarget{method-Arvados-project_get}{}}}\r
 390 \subsection{Method \code{project_get()}}{\r
 391 project_get returns the demanded project.\r
 392 \subsection{Usage}{\r
 393 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_get(uuid)}\if{html}{\out{</div>}}\r
 394 }\r
 395 \r
 396 \subsection{Arguments}{\r
 397 \if{html}{\out{<div class="arguments">}}\r
 398 \describe{\r
 399 \item{\code{uuid}}{The UUID of the Group in question.}\r
 400 }\r
 401 \if{html}{\out{</div>}}\r
 402 }\r
 403 \subsection{Examples}{\r
 404 \if{html}{\out{<div class="r example copy">}}\r
 405 \preformatted{\dontrun{\r
 406 project <- arv$project_get(uuid = 'projectUUID')\r
 407 }\r
 408 }\r
 409 \if{html}{\out{</div>}}\r
 410 \r
 411 }\r
 412 \r
 413 }\r
 414 \if{html}{\out{<hr>}}\r
 415 \if{html}{\out{<a id="method-Arvados-project_create"></a>}}\r
 416 \if{latex}{\out{\hypertarget{method-Arvados-project_create}{}}}\r
 417 \subsection{Method \code{project_create()}}{\r
 418 project_create creates a new project of a given name and description.\r
 419 \subsection{Usage}{\r
 420 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_create(\r
 421   name,\r
 422   description,\r
 423   ownerUUID,\r
 424   properties = NULL,\r
 425   ensureUniqueName = "false"\r
 426 )}\if{html}{\out{</div>}}\r
 427 }\r
 428 \r
 429 \subsection{Arguments}{\r
 430 \if{html}{\out{<div class="arguments">}}\r
 431 \describe{\r
 432 \item{\code{name}}{Name of the project.}\r
 433 \r
 434 \item{\code{description}}{Description of the project.}\r
 435 \r
 436 \item{\code{ownerUUID}}{The UUID of the maternal project to created one.}\r
 437 \r
 438 \item{\code{properties}}{List of the properties of the project.}\r
 439 \r
 440 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}\r
 441 }\r
 442 \if{html}{\out{</div>}}\r
 443 }\r
 444 \subsection{Examples}{\r
 445 \if{html}{\out{<div class="r example copy">}}\r
 446 \preformatted{\dontrun{\r
 447 Properties <- list() # should contain a list of new properties to be added\r
 448 new_project <- arv$project_create(name = "project name", description = "project description", owner_uuid = "project UUID", properties = NULL, ensureUniqueName = "false")\r
 449 }\r
 450 }\r
 451 \if{html}{\out{</div>}}\r
 452 \r
 453 }\r
 454 \r
 455 }\r
 456 \if{html}{\out{<hr>}}\r
 457 \if{html}{\out{<a id="method-Arvados-project_properties_set"></a>}}\r
 458 \if{latex}{\out{\hypertarget{method-Arvados-project_properties_set}{}}}\r
 459 \subsection{Method \code{project_properties_set()}}{\r
 460 project_properties_set is a method defined in Arvados class that enables setting properties. Allows to set or overwrite the properties. In case there are set already it overwrites them.\r
 461 \subsection{Usage}{\r
 462 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_properties_set(listProperties, uuid)}\if{html}{\out{</div>}}\r
 463 }\r
 464 \r
 465 \subsection{Arguments}{\r
 466 \if{html}{\out{<div class="arguments">}}\r
 467 \describe{\r
 468 \item{\code{listProperties}}{List of new properties.}\r
 469 \r
 470 \item{\code{uuid}}{The UUID of a project or a file.}\r
 471 }\r
 472 \if{html}{\out{</div>}}\r
 473 }\r
 474 \subsection{Examples}{\r
 475 \if{html}{\out{<div class="r example copy">}}\r
 476 \preformatted{\dontrun{\r
 477 Properties <- list() # should contain a list of new properties to be added\r
 478 arv$project_properties_set(Properties, uuid)\r
 479 }\r
 480 }\r
 481 \if{html}{\out{</div>}}\r
 482 \r
 483 }\r
 484 \r
 485 }\r
 486 \if{html}{\out{<hr>}}\r
 487 \if{html}{\out{<a id="method-Arvados-project_properties_append"></a>}}\r
 488 \if{latex}{\out{\hypertarget{method-Arvados-project_properties_append}{}}}\r
 489 \subsection{Method \code{project_properties_append()}}{\r
 490 project_properties_append is a method defined in Arvados class that enables appending properties. Allows to add new properties.\r
 491 \subsection{Usage}{\r
 492 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_properties_append(properties, uuid)}\if{html}{\out{</div>}}\r
 493 }\r
 494 \r
 495 \subsection{Arguments}{\r
 496 \if{html}{\out{<div class="arguments">}}\r
 497 \describe{\r
 498 \item{\code{properties}}{List of new properties.}\r
 499 \r
 500 \item{\code{uuid}}{The UUID of a project or a file.}\r
 501 }\r
 502 \if{html}{\out{</div>}}\r
 503 }\r
 504 \subsection{Examples}{\r
 505 \if{html}{\out{<div class="r example copy">}}\r
 506 \preformatted{\dontrun{\r
 507 newProperties <- list() # should contain a list of new properties to be added\r
 508 arv$project_properties_append(properties = newProperties, uuid)\r
 509 }\r
 510 }\r
 511 \if{html}{\out{</div>}}\r
 512 \r
 513 }\r
 514 \r
 515 }\r
 516 \if{html}{\out{<hr>}}\r
 517 \if{html}{\out{<a id="method-Arvados-project_properties_get"></a>}}\r
 518 \if{latex}{\out{\hypertarget{method-Arvados-project_properties_get}{}}}\r
 519 \subsection{Method \code{project_properties_get()}}{\r
 520 project_properties_get is a method defined in Arvados class that returns properties.\r
 521 \subsection{Usage}{\r
 522 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_properties_get(uuid)}\if{html}{\out{</div>}}\r
 523 }\r
 524 \r
 525 \subsection{Arguments}{\r
 526 \if{html}{\out{<div class="arguments">}}\r
 527 \describe{\r
 528 \item{\code{uuid}}{The UUID of a project or a file.}\r
 529 }\r
 530 \if{html}{\out{</div>}}\r
 531 }\r
 532 \subsection{Examples}{\r
 533 \if{html}{\out{<div class="r example copy">}}\r
 534 \preformatted{\dontrun{\r
 535 arv$project_properties_get(projectUUID)\r
 536 }\r
 537 }\r
 538 \if{html}{\out{</div>}}\r
 539 \r
 540 }\r
 541 \r
 542 }\r
 543 \if{html}{\out{<hr>}}\r
 544 \if{html}{\out{<a id="method-Arvados-project_properties_delete"></a>}}\r
 545 \if{latex}{\out{\hypertarget{method-Arvados-project_properties_delete}{}}}\r
 546 \subsection{Method \code{project_properties_delete()}}{\r
 547 project_properties_delete is a method defined in Arvados class that deletes list of properties.\r
 548 \subsection{Usage}{\r
 549 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_properties_delete(oneProp, uuid)}\if{html}{\out{</div>}}\r
 550 }\r
 551 \r
 552 \subsection{Arguments}{\r
 553 \if{html}{\out{<div class="arguments">}}\r
 554 \describe{\r
 555 \item{\code{oneProp}}{Property to be deleted.}\r
 556 \r
 557 \item{\code{uuid}}{The UUID of a project or a file.}\r
 558 }\r
 559 \if{html}{\out{</div>}}\r
 560 }\r
 561 \subsection{Examples}{\r
 562 \if{html}{\out{<div class="r example copy">}}\r
 563 \preformatted{\dontrun{\r
 564 Properties <- list() # should contain a list of new properties to be added\r
 565 arv$project_properties_delete(Properties,  projectUUID)\r
 566 }\r
 567 }\r
 568 \if{html}{\out{</div>}}\r
 569 \r
 570 }\r
 571 \r
 572 }\r
 573 \if{html}{\out{<hr>}}\r
 574 \if{html}{\out{<a id="method-Arvados-project_update"></a>}}\r
 575 \if{latex}{\out{\hypertarget{method-Arvados-project_update}{}}}\r
 576 \subsection{Method \code{project_update()}}{\r
 577 project_update enables updating project. New name, description and properties may be given.\r
 578 \subsection{Usage}{\r
 579 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_update(..., uuid)}\if{html}{\out{</div>}}\r
 580 }\r
 581 \r
 582 \subsection{Arguments}{\r
 583 \if{html}{\out{<div class="arguments">}}\r
 584 \describe{\r
 585 \item{\code{...}}{Feature to be updated (name, description, properties).}\r
 586 \r
 587 \item{\code{uuid}}{The UUID of a project in question.}\r
 588 }\r
 589 \if{html}{\out{</div>}}\r
 590 }\r
 591 \subsection{Examples}{\r
 592 \if{html}{\out{<div class="r example copy">}}\r
 593 \preformatted{\dontrun{\r
 594 newProperties <- list() # should contain a list of new properties to be added\r
 595 arv$project_update(name = "new project name", properties = newProperties, uuid = projectUUID)\r
 596 }\r
 597 }\r
 598 \if{html}{\out{</div>}}\r
 599 \r
 600 }\r
 601 \r
 602 }\r
 603 \if{html}{\out{<hr>}}\r
 604 \if{html}{\out{<a id="method-Arvados-project_list"></a>}}\r
 605 \if{latex}{\out{\hypertarget{method-Arvados-project_list}{}}}\r
 606 \subsection{Method \code{project_list()}}{\r
 607 project_list enables listing project by its name, uuid, properties, permissions.\r
 608 \subsection{Usage}{\r
 609 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_list(\r
 610   filters = NULL,\r
 611   where = NULL,\r
 612   order = NULL,\r
 613   select = NULL,\r
 614   distinct = NULL,\r
 615   limit = "100",\r
 616   offset = "0",\r
 617   count = "exact",\r
 618   includeTrash = NULL\r
 619 )}\if{html}{\out{</div>}}\r
 620 }\r
 621 \r
 622 \subsection{Arguments}{\r
 623 \if{html}{\out{<div class="arguments">}}\r
 624 \describe{\r
 625 \item{\code{includeTrash}}{Include items whose is_trashed attribute is true.}\r
 626 \r
 627 \item{\code{uuid}}{The UUID of a project in question.}\r
 628 \r
 629 \item{\code{recursive}}{Include contents from child groups recursively.}\r
 630 }\r
 631 \if{html}{\out{</div>}}\r
 632 }\r
 633 \subsection{Examples}{\r
 634 \if{html}{\out{<div class="r example copy">}}\r
 635 \preformatted{\dontrun{\r
 636 listOfprojects <- arv$project_list(list(list("owner_uuid", "=", projectUUID))) # Sample query which show projects within the project of a given UUID\r
 637 }\r
 638 }\r
 639 \if{html}{\out{</div>}}\r
 640 \r
 641 }\r
 642 \r
 643 }\r
 644 \if{html}{\out{<hr>}}\r
 645 \if{html}{\out{<a id="method-Arvados-project_delete"></a>}}\r
 646 \if{latex}{\out{\hypertarget{method-Arvados-project_delete}{}}}\r
 647 \subsection{Method \code{project_delete()}}{\r
 648 project_delete trashes project of a given uuid. It can be restored from trash or deleted permanently.\r
 649 \subsection{Usage}{\r
 650 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_delete(uuid)}\if{html}{\out{</div>}}\r
 651 }\r
 652 \r
 653 \subsection{Arguments}{\r
 654 \if{html}{\out{<div class="arguments">}}\r
 655 \describe{\r
 656 \item{\code{uuid}}{The UUID of the Group in question.}\r
 657 }\r
 658 \if{html}{\out{</div>}}\r
 659 }\r
 660 \subsection{Examples}{\r
 661 \if{html}{\out{<div class="r example copy">}}\r
 662 \preformatted{\dontrun{\r
 663 arv$project_delete(uuid = 'projectUUID')\r
 664 }\r
 665 }\r
 666 \if{html}{\out{</div>}}\r
 667 \r
 668 }\r
 669 \r
 670 }\r
 671 \if{html}{\out{<hr>}}\r
 672 \if{html}{\out{<a id="method-Arvados-api_clients_get"></a>}}\r
 673 \if{latex}{\out{\hypertarget{method-Arvados-api_clients_get}{}}}\r
 674 \subsection{Method \code{api_clients_get()}}{\r
 675 api_clients_get is a method defined in Arvados class.\r
 676 \subsection{Usage}{\r
 677 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_clients_get(uuid)}\if{html}{\out{</div>}}\r
 678 }\r
 679 \r
 680 \subsection{Arguments}{\r
 681 \if{html}{\out{<div class="arguments">}}\r
 682 \describe{\r
 683 \item{\code{uuid}}{The UUID of the apiClient in question.}\r
 684 }\r
 685 \if{html}{\out{</div>}}\r
 686 }\r
 687 }\r
 688 \if{html}{\out{<hr>}}\r
 689 \if{html}{\out{<a id="method-Arvados-api_clients_create"></a>}}\r
 690 \if{latex}{\out{\hypertarget{method-Arvados-api_clients_create}{}}}\r
 691 \subsection{Method \code{api_clients_create()}}{\r
 692 api_clients_create is a method defined in Arvados class.\r
 693 \subsection{Usage}{\r
 694 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_clients_create(\r
 695   apiClient,\r
 696   ensureUniqueName = "false",\r
 697   clusterID = NULL\r
 698 )}\if{html}{\out{</div>}}\r
 699 }\r
 700 \r
 701 \subsection{Arguments}{\r
 702 \if{html}{\out{<div class="arguments">}}\r
 703 \describe{\r
 704 \item{\code{apiClient}}{apiClient object.}\r
 705 \r
 706 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}\r
 707 \r
 708 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}\r
 709 }\r
 710 \if{html}{\out{</div>}}\r
 711 }\r
 712 }\r
 713 \if{html}{\out{<hr>}}\r
 714 \if{html}{\out{<a id="method-Arvados-api_clients_update"></a>}}\r
 715 \if{latex}{\out{\hypertarget{method-Arvados-api_clients_update}{}}}\r
 716 \subsection{Method \code{api_clients_update()}}{\r
 717 api_clients_update is a method defined in Arvados class.\r
 718 \subsection{Usage}{\r
 719 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_clients_update(apiClient, uuid)}\if{html}{\out{</div>}}\r
 720 }\r
 721 \r
 722 \subsection{Arguments}{\r
 723 \if{html}{\out{<div class="arguments">}}\r
 724 \describe{\r
 725 \item{\code{apiClient}}{apiClient object.}\r
 726 \r
 727 \item{\code{uuid}}{The UUID of the apiClient in question.}\r
 728 }\r
 729 \if{html}{\out{</div>}}\r
 730 }\r
 731 }\r
 732 \if{html}{\out{<hr>}}\r
 733 \if{html}{\out{<a id="method-Arvados-api_clients_delete"></a>}}\r
 734 \if{latex}{\out{\hypertarget{method-Arvados-api_clients_delete}{}}}\r
 735 \subsection{Method \code{api_clients_delete()}}{\r
 736 api_clients_delete is a method defined in Arvados class.\r
 737 \subsection{Usage}{\r
 738 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_clients_delete(uuid)}\if{html}{\out{</div>}}\r
 739 }\r
 740 \r
 741 \subsection{Arguments}{\r
 742 \if{html}{\out{<div class="arguments">}}\r
 743 \describe{\r
 744 \item{\code{uuid}}{The UUID of the apiClient in question.}\r
 745 }\r
 746 \if{html}{\out{</div>}}\r
 747 }\r
 748 }\r
 749 \if{html}{\out{<hr>}}\r
 750 \if{html}{\out{<a id="method-Arvados-api_clients_list"></a>}}\r
 751 \if{latex}{\out{\hypertarget{method-Arvados-api_clients_list}{}}}\r
 752 \subsection{Method \code{api_clients_list()}}{\r
 753 api_clients_list is a method defined in Arvados class.\r
 754 \subsection{Usage}{\r
 755 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_clients_list(\r
 756   filters = NULL,\r
 757   where = NULL,\r
 758   order = NULL,\r
 759   select = NULL,\r
 760   distinct = NULL,\r
 761   limit = "100",\r
 762   offset = "0",\r
 763   count = "exact",\r
 764   clusterID = NULL,\r
 765   bypassFederation = NULL\r
 766 )}\if{html}{\out{</div>}}\r
 767 }\r
 768 \r
 769 \subsection{Arguments}{\r
 770 \if{html}{\out{<div class="arguments">}}\r
 771 \describe{\r
 772 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}\r
 773 \r
 774 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}\r
 775 }\r
 776 \if{html}{\out{</div>}}\r
 777 }\r
 778 }\r
 779 \if{html}{\out{<hr>}}\r
 780 \if{html}{\out{<a id="method-Arvados-api_client_authorizations_get"></a>}}\r
 781 \if{latex}{\out{\hypertarget{method-Arvados-api_client_authorizations_get}{}}}\r
 782 \subsection{Method \code{api_client_authorizations_get()}}{\r
 783 api_client_authorizations_get is a method defined in Arvados class.\r
 784 \subsection{Usage}{\r
 785 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_get(uuid)}\if{html}{\out{</div>}}\r
 786 }\r
 787 \r
 788 \subsection{Arguments}{\r
 789 \if{html}{\out{<div class="arguments">}}\r
 790 \describe{\r
 791 \item{\code{uuid}}{The UUID of the apiClientAuthorization in question.}\r
 792 }\r
 793 \if{html}{\out{</div>}}\r
 794 }\r
 795 }\r
 796 \if{html}{\out{<hr>}}\r
 797 \if{html}{\out{<a id="method-Arvados-api_client_authorizations_create"></a>}}\r
 798 \if{latex}{\out{\hypertarget{method-Arvados-api_client_authorizations_create}{}}}\r
 799 \subsection{Method \code{api_client_authorizations_create()}}{\r
 800 api_client_authorizations_create is a method defined in Arvados class.\r
 801 \subsection{Usage}{\r
 802 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_create(\r
 803   apiClientAuthorization,\r
 804   ensureUniqueName = "false",\r
 805   clusterID = NULL\r
 806 )}\if{html}{\out{</div>}}\r
 807 }\r
 808 \r
 809 \subsection{Arguments}{\r
 810 \if{html}{\out{<div class="arguments">}}\r
 811 \describe{\r
 812 \item{\code{apiClientAuthorization}}{apiClientAuthorization object.}\r
 813 \r
 814 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error on (ownerUUID, name) collision_}\r
 815 \r
 816 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}\r
 817 }\r
 818 \if{html}{\out{</div>}}\r
 819 }\r
 820 }\r
 821 \if{html}{\out{<hr>}}\r
 822 \if{html}{\out{<a id="method-Arvados-api_client_authorizations_update"></a>}}\r
 823 \if{latex}{\out{\hypertarget{method-Arvados-api_client_authorizations_update}{}}}\r
 824 \subsection{Method \code{api_client_authorizations_update()}}{\r
 825 api_client_authorizations_update is a method defined in Arvados class.\r
 826 \subsection{Usage}{\r
 827 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_update(apiClientAuthorization, uuid)}\if{html}{\out{</div>}}\r
 828 }\r
 829 \r
 830 \subsection{Arguments}{\r
 831 \if{html}{\out{<div class="arguments">}}\r
 832 \describe{\r
 833 \item{\code{apiClientAuthorization}}{apiClientAuthorization object.}\r
 834 \r
 835 \item{\code{uuid}}{The UUID of the apiClientAuthorization in question.}\r
 836 }\r
 837 \if{html}{\out{</div>}}\r
 838 }\r
 839 }\r
 840 \if{html}{\out{<hr>}}\r
 841 \if{html}{\out{<a id="method-Arvados-api_client_authorizations_delete"></a>}}\r
 842 \if{latex}{\out{\hypertarget{method-Arvados-api_client_authorizations_delete}{}}}\r
 843 \subsection{Method \code{api_client_authorizations_delete()}}{\r
 844 api_client_authorizations_delete is a method defined in Arvados class.\r
 845 \subsection{Usage}{\r
 846 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_delete(uuid)}\if{html}{\out{</div>}}\r
 847 }\r
 848 \r
 849 \subsection{Arguments}{\r
 850 \if{html}{\out{<div class="arguments">}}\r
 851 \describe{\r
 852 \item{\code{uuid}}{The UUID of the apiClientAuthorization in question.}\r
 853 }\r
 854 \if{html}{\out{</div>}}\r
 855 }\r
 856 }\r
 857 \if{html}{\out{<hr>}}\r
 858 \if{html}{\out{<a id="method-Arvados-api_client_authorizations_create_system_auth"></a>}}\r
 859 \if{latex}{\out{\hypertarget{method-Arvados-api_client_authorizations_create_system_auth}{}}}\r
 860 \subsection{Method \code{api_client_authorizations_create_system_auth()}}{\r
 861 api_client_authorizations_create_system_auth is a method defined in Arvados class.\r
 862 \subsection{Usage}{\r
 863 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_create_system_auth(\r
 864   apiClientID = NULL,\r
 865   scopes = NULL\r
 866 )}\if{html}{\out{</div>}}\r
 867 }\r
 868 \r
 869 }\r
 870 \if{html}{\out{<hr>}}\r
 871 \if{html}{\out{<a id="method-Arvados-api_client_authorizations_current"></a>}}\r
 872 \if{latex}{\out{\hypertarget{method-Arvados-api_client_authorizations_current}{}}}\r
 873 \subsection{Method \code{api_client_authorizations_current()}}{\r
 874 api_client_authorizations_current is a method defined in Arvados class.\r
 875 \subsection{Usage}{\r
 876 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_current()}\if{html}{\out{</div>}}\r
 877 }\r
 878 \r
 879 }\r
 880 \if{html}{\out{<hr>}}\r
 881 \if{html}{\out{<a id="method-Arvados-api_client_authorizations_list"></a>}}\r
 882 \if{latex}{\out{\hypertarget{method-Arvados-api_client_authorizations_list}{}}}\r
 883 \subsection{Method \code{api_client_authorizations_list()}}{\r
 884 api_client_authorizations_list is a method defined in Arvados class.\r
 885 \subsection{Usage}{\r
 886 \if{html}{\out{<div class="r">}}\preformatted{Arvados$api_client_authorizations_list(\r
 887   filters = NULL,\r
 888   where = NULL,\r
 889   order = NULL,\r
 890   select = NULL,\r
 891   distinct = NULL,\r
 892   limit = "100",\r
 893   offset = "0",\r
 894   count = "exact",\r
 895   clusterID = NULL,\r
 896   bypassFederation = NULL\r
 897 )}\if{html}{\out{</div>}}\r
 898 }\r
 899 \r
 900 \subsection{Arguments}{\r
 901 \if{html}{\out{<div class="arguments">}}\r
 902 \describe{\r
 903 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}\r
 904 \r
 905 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}\r
 906 }\r
 907 \if{html}{\out{</div>}}\r
 908 }\r
 909 }\r
 910 \if{html}{\out{<hr>}}\r
 911 \if{html}{\out{<a id="method-Arvados-authorized_keys_get"></a>}}\r
 912 \if{latex}{\out{\hypertarget{method-Arvados-authorized_keys_get}{}}}\r
 913 \subsection{Method \code{authorized_keys_get()}}{\r
 914 authorized_keys_get is a method defined in Arvados class.\r
 915 \subsection{Usage}{\r
 916 \if{html}{\out{<div class="r">}}\preformatted{Arvados$authorized_keys_get(uuid)}\if{html}{\out{</div>}}\r
 917 }\r
 918 \r
 919 \subsection{Arguments}{\r
 920 \if{html}{\out{<div class="arguments">}}\r
 921 \describe{\r
 922 \item{\code{uuid}}{The UUID of the authorizedKey in question.}\r
 923 }\r
 924 \if{html}{\out{</div>}}\r
 925 }\r
 926 }\r
 927 \if{html}{\out{<hr>}}\r
 928 \if{html}{\out{<a id="method-Arvados-authorized_keys_create"></a>}}\r
 929 \if{latex}{\out{\hypertarget{method-Arvados-authorized_keys_create}{}}}\r
 930 \subsection{Method \code{authorized_keys_create()}}{\r
 931 authorized_keys_create is a method defined in Arvados class.\r
 932 \subsection{Usage}{\r
 933 \if{html}{\out{<div class="r">}}\preformatted{Arvados$authorized_keys_create(\r
 934   authorizedKey,\r
 935   ensureUniqueName = "false",\r
 936   clusterID = NULL\r
 937 )}\if{html}{\out{</div>}}\r
 938 }\r
 939 \r
 940 \subsection{Arguments}{\r
 941 \if{html}{\out{<div class="arguments">}}\r
 942 \describe{\r
 943 \item{\code{authorizedKey}}{authorizedKey object.}\r
 944 \r
 945 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}\r
 946 \r
 947 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}\r
 948 }\r
 949 \if{html}{\out{</div>}}\r
 950 }\r
 951 }\r
 952 \if{html}{\out{<hr>}}\r
 953 \if{html}{\out{<a id="method-Arvados-authorized_keys_update"></a>}}\r
 954 \if{latex}{\out{\hypertarget{method-Arvados-authorized_keys_update}{}}}\r
 955 \subsection{Method \code{authorized_keys_update()}}{\r
 956 authorized_keys_update is a method defined in Arvados class.\r
 957 \subsection{Usage}{\r
 958 \if{html}{\out{<div class="r">}}\preformatted{Arvados$authorized_keys_update(authorizedKey, uuid)}\if{html}{\out{</div>}}\r
 959 }\r
 960 \r
 961 \subsection{Arguments}{\r
 962 \if{html}{\out{<div class="arguments">}}\r
 963 \describe{\r
 964 \item{\code{authorizedKey}}{authorizedKey object.}\r
 965 \r
 966 \item{\code{uuid}}{The UUID of the authorizedKey in question.}\r
 967 }\r
 968 \if{html}{\out{</div>}}\r
 969 }\r
 970 }\r
 971 \if{html}{\out{<hr>}}\r
 972 \if{html}{\out{<a id="method-Arvados-authorized_keys_delete"></a>}}\r
 973 \if{latex}{\out{\hypertarget{method-Arvados-authorized_keys_delete}{}}}\r
 974 \subsection{Method \code{authorized_keys_delete()}}{\r
 975 authorized_keys_delete is a method defined in Arvados class.\r
 976 \subsection{Usage}{\r
 977 \if{html}{\out{<div class="r">}}\preformatted{Arvados$authorized_keys_delete(uuid)}\if{html}{\out{</div>}}\r
 978 }\r
 979 \r
 980 \subsection{Arguments}{\r
 981 \if{html}{\out{<div class="arguments">}}\r
 982 \describe{\r
 983 \item{\code{uuid}}{The UUID of the authorizedKey in question.}\r
 984 }\r
 985 \if{html}{\out{</div>}}\r
 986 }\r
 987 }\r
 988 \if{html}{\out{<hr>}}\r
 989 \if{html}{\out{<a id="method-Arvados-authorized_keys_list"></a>}}\r
 990 \if{latex}{\out{\hypertarget{method-Arvados-authorized_keys_list}{}}}\r
 991 \subsection{Method \code{authorized_keys_list()}}{\r
 992 authorized_keys_list is a method defined in Arvados class.\r
 993 \subsection{Usage}{\r
 994 \if{html}{\out{<div class="r">}}\preformatted{Arvados$authorized_keys_list(\r
 995   filters = NULL,\r
 996   where = NULL,\r
 997   order = NULL,\r
 998   select = NULL,\r
 999   distinct = NULL,\r
1000   limit = "100",\r
1001   offset = "0",\r
1002   count = "exact",\r
1003   clusterID = NULL,\r
1004   bypassFederation = NULL\r
1005 )}\if{html}{\out{</div>}}\r
1006 }\r
1007 \r
1008 \subsection{Arguments}{\r
1009 \if{html}{\out{<div class="arguments">}}\r
1010 \describe{\r
1011 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}\r
1012 \r
1013 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}\r
1014 }\r
1015 \if{html}{\out{</div>}}\r
1016 }\r
1017 }\r
1018 \if{html}{\out{<hr>}}\r
1019 \if{html}{\out{<a id="method-Arvados-collections_get"></a>}}\r
1020 \if{latex}{\out{\hypertarget{method-Arvados-collections_get}{}}}\r
1021 \subsection{Method \code{collections_get()}}{\r
1022 collections_get is a method defined in Arvados class.\r
1023 \subsection{Usage}{\r
1024 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_get(uuid)}\if{html}{\out{</div>}}\r
1025 }\r
1026 \r
1027 \subsection{Arguments}{\r
1028 \if{html}{\out{<div class="arguments">}}\r
1029 \describe{\r
1030 \item{\code{uuid}}{The UUID of the Collection in question.}\r
1031 }\r
1032 \if{html}{\out{</div>}}\r
1033 }\r
1034 \subsection{Examples}{\r
1035 \if{html}{\out{<div class="r example copy">}}\r
1036 \preformatted{\dontrun{\r
1037 collection <- arv$collections_get(uuid = collectionUUID)\r
1038 }\r
1039 }\r
1040 \if{html}{\out{</div>}}\r
1041 \r
1042 }\r
1043 \r
1044 }\r
1045 \if{html}{\out{<hr>}}\r
1046 \if{html}{\out{<a id="method-Arvados-collections_create"></a>}}\r
1047 \if{latex}{\out{\hypertarget{method-Arvados-collections_create}{}}}\r
1048 \subsection{Method \code{collections_create()}}{\r
1049 collections_create is a method defined in Arvados class that enables collections creation.\r
1050 \subsection{Usage}{\r
1051 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_create(\r
1052   name,\r
1053   description,\r
1054   ownerUUID = NULL,\r
1055   properties = NULL,\r
1056   ensureUniqueName = "false",\r
1057   clusterID = NULL\r
1058 )}\if{html}{\out{</div>}}\r
1059 }\r
1060 \r
1061 \subsection{Arguments}{\r
1062 \if{html}{\out{<div class="arguments">}}\r
1063 \describe{\r
1064 \item{\code{name}}{Name of the collection.}\r
1065 \r
1066 \item{\code{description}}{Description of the collection.}\r
1067 \r
1068 \item{\code{ownerUUID}}{UUID of the maternal project to created one.}\r
1069 \r
1070 \item{\code{properties}}{Properties of the collection.}\r
1071 \r
1072 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}\r
1073 \r
1074 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}\r
1075 }\r
1076 \if{html}{\out{</div>}}\r
1077 }\r
1078 \subsection{Examples}{\r
1079 \if{html}{\out{<div class="r example copy">}}\r
1080 \preformatted{\dontrun{\r
1081 Properties <- list() # should contain a list of new properties to be added\r
1082 arv$collections_create(name = "collectionTitle", description = "collectionDescription", ownerUUID = "collectionOwner", properties = Properties)\r
1083 }\r
1084 }\r
1085 \if{html}{\out{</div>}}\r
1086 \r
1087 }\r
1088 \r
1089 }\r
1090 \if{html}{\out{<hr>}}\r
1091 \if{html}{\out{<a id="method-Arvados-collections_update"></a>}}\r
1092 \if{latex}{\out{\hypertarget{method-Arvados-collections_update}{}}}\r
1093 \subsection{Method \code{collections_update()}}{\r
1094 collections_update is a method defined in Arvados class.\r
1095 \subsection{Usage}{\r
1096 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_update(\r
1097   name,\r
1098   description,\r
1099   ownerUUID = NULL,\r
1100   properties = NULL,\r
1101   uuid\r
1102 )}\if{html}{\out{</div>}}\r
1103 }\r
1104 \r
1105 \subsection{Arguments}{\r
1106 \if{html}{\out{<div class="arguments">}}\r
1107 \describe{\r
1108 \item{\code{name}}{New name of the collection.}\r
1109 \r
1110 \item{\code{description}}{New description of the collection.}\r
1111 \r
1112 \item{\code{ownerUUID}}{UUID of the maternal project to created one.}\r
1113 \r
1114 \item{\code{properties}}{New list of properties of the collection.}\r
1115 \r
1116 \item{\code{uuid}}{The UUID of the Collection in question.}\r
1117 }\r
1118 \if{html}{\out{</div>}}\r
1119 }\r
1120 \subsection{Examples}{\r
1121 \if{html}{\out{<div class="r example copy">}}\r
1122 \preformatted{\dontrun{\r
1123 collection <- arv$collections_update(name = "newCollectionTitle", description = "newCollectionDescription", ownerUUID = "collectionOwner", properties = NULL, uuid = "collectionUUID")\r
1124 }\r
1125 }\r
1126 \if{html}{\out{</div>}}\r
1127 \r
1128 }\r
1129 \r
1130 }\r
1131 \if{html}{\out{<hr>}}\r
1132 \if{html}{\out{<a id="method-Arvados-collections_delete"></a>}}\r
1133 \if{latex}{\out{\hypertarget{method-Arvados-collections_delete}{}}}\r
1134 \subsection{Method \code{collections_delete()}}{\r
1135 collections_delete is a method defined in Arvados class.\r
1136 \subsection{Usage}{\r
1137 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_delete(uuid)}\if{html}{\out{</div>}}\r
1138 }\r
1139 \r
1140 \subsection{Arguments}{\r
1141 \if{html}{\out{<div class="arguments">}}\r
1142 \describe{\r
1143 \item{\code{uuid}}{The UUID of the Collection in question.}\r
1144 }\r
1145 \if{html}{\out{</div>}}\r
1146 }\r
1147 \subsection{Examples}{\r
1148 \if{html}{\out{<div class="r example copy">}}\r
1149 \preformatted{\dontrun{\r
1150 arv$collection_delete(collectionUUID)\r
1151 }\r
1152 }\r
1153 \if{html}{\out{</div>}}\r
1154 \r
1155 }\r
1156 \r
1157 }\r
1158 \if{html}{\out{<hr>}}\r
1159 \if{html}{\out{<a id="method-Arvados-collections_provenance"></a>}}\r
1160 \if{latex}{\out{\hypertarget{method-Arvados-collections_provenance}{}}}\r
1161 \subsection{Method \code{collections_provenance()}}{\r
1162 collections_provenance is a method defined in Arvados class, it returns the collection by uuid.\r
1163 \subsection{Usage}{\r
1164 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_provenance(uuid)}\if{html}{\out{</div>}}\r
1165 }\r
1166 \r
1167 \subsection{Arguments}{\r
1168 \if{html}{\out{<div class="arguments">}}\r
1169 \describe{\r
1170 \item{\code{uuid}}{The UUID of the Collection in question.}\r
1171 }\r
1172 \if{html}{\out{</div>}}\r
1173 }\r
1174 \subsection{Examples}{\r
1175 \if{html}{\out{<div class="r example copy">}}\r
1176 \preformatted{\dontrun{\r
1177 collection <- arv$collections_provenance(collectionUUID)\r
1178 }\r
1179 }\r
1180 \if{html}{\out{</div>}}\r
1181 \r
1182 }\r
1183 \r
1184 }\r
1185 \if{html}{\out{<hr>}}\r
1186 \if{html}{\out{<a id="method-Arvados-collections_used_by"></a>}}\r
1187 \if{latex}{\out{\hypertarget{method-Arvados-collections_used_by}{}}}\r
1188 \subsection{Method \code{collections_used_by()}}{\r
1189 collections_used_by is a method defined in Arvados class, it returns collection by portable_data_hash.\r
1190 \subsection{Usage}{\r
1191 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_used_by(uuid)}\if{html}{\out{</div>}}\r
1192 }\r
1193 \r
1194 \subsection{Arguments}{\r
1195 \if{html}{\out{<div class="arguments">}}\r
1196 \describe{\r
1197 \item{\code{uuid}}{The UUID of the Collection in question.}\r
1198 }\r
1199 \if{html}{\out{</div>}}\r
1200 }\r
1201 }\r
1202 \if{html}{\out{<hr>}}\r
1203 \if{html}{\out{<a id="method-Arvados-collections_trash"></a>}}\r
1204 \if{latex}{\out{\hypertarget{method-Arvados-collections_trash}{}}}\r
1205 \subsection{Method \code{collections_trash()}}{\r
1206 collections_trash is a method defined in Arvados class, it moves collection to trash.\r
1207 \subsection{Usage}{\r
1208 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_trash(uuid)}\if{html}{\out{</div>}}\r
1209 }\r
1210 \r
1211 \subsection{Arguments}{\r
1212 \if{html}{\out{<div class="arguments">}}\r
1213 \describe{\r
1214 \item{\code{uuid}}{The UUID of the Collection in question.}\r
1215 }\r
1216 \if{html}{\out{</div>}}\r
1217 }\r
1218 \subsection{Examples}{\r
1219 \if{html}{\out{<div class="r example copy">}}\r
1220 \preformatted{\dontrun{\r
1221 arv$collections_trash(collectionUUID)\r
1222 }\r
1223 }\r
1224 \if{html}{\out{</div>}}\r
1225 \r
1226 }\r
1227 \r
1228 }\r
1229 \if{html}{\out{<hr>}}\r
1230 \if{html}{\out{<a id="method-Arvados-collections_untrash"></a>}}\r
1231 \if{latex}{\out{\hypertarget{method-Arvados-collections_untrash}{}}}\r
1232 \subsection{Method \code{collections_untrash()}}{\r
1233 collections_untrash is a method defined in Arvados class, it moves collection from trash to project.\r
1234 \subsection{Usage}{\r
1235 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_untrash(uuid)}\if{html}{\out{</div>}}\r
1236 }\r
1237 \r
1238 \subsection{Arguments}{\r
1239 \if{html}{\out{<div class="arguments">}}\r
1240 \describe{\r
1241 \item{\code{uuid}}{The UUID of the Collection in question.}\r
1242 }\r
1243 \if{html}{\out{</div>}}\r
1244 }\r
1245 \subsection{Examples}{\r
1246 \if{html}{\out{<div class="r example copy">}}\r
1247 \preformatted{\dontrun{\r
1248 arv$collections_untrash(collectionUUID)\r
1249 }\r
1250 }\r
1251 \if{html}{\out{</div>}}\r
1252 \r
1253 }\r
1254 \r
1255 }\r
1256 \if{html}{\out{<hr>}}\r
1257 \if{html}{\out{<a id="method-Arvados-collections_list"></a>}}\r
1258 \if{latex}{\out{\hypertarget{method-Arvados-collections_list}{}}}\r
1259 \subsection{Method \code{collections_list()}}{\r
1260 collections_list is a method defined in Arvados class.\r
1261 \subsection{Usage}{\r
1262 \if{html}{\out{<div class="r">}}\preformatted{Arvados$collections_list(\r
1263   filters = NULL,\r
1264   where = NULL,\r
1265   order = NULL,\r
1266   select = NULL,\r
1267   distinct = NULL,\r
1268   limit = "100",\r
1269   offset = "0",\r
1270   count = "exact",\r
1271   clusterID = NULL,\r
1272   bypassFederation = NULL,\r
1273   includeTrash = NULL,\r
1274   includeOldVersions = NULL\r
1275 )}\if{html}{\out{</div>}}\r
1276 }\r
1277 \r
1278 \subsection{Arguments}{\r
1279 \if{html}{\out{<div class="arguments">}}\r
1280 \describe{\r
1281 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}\r
1282 \r
1283 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}\r
1284 \r
1285 \item{\code{includeTrash}}{Include collections whose is_trashed attribute is true.}\r
1286 \r
1287 \item{\code{includeOldVersions}}{Include past collection versions.}\r
1288 }\r
1289 \if{html}{\out{</div>}}\r
1290 }\r
1291 \subsection{Examples}{\r
1292 \if{html}{\out{<div class="r example copy">}}\r
1293 \preformatted{\dontrun{\r
1294 collectionList <- arv$collections_list(list(list("name", "=", "Example")))\r
1295 }\r
1296 }\r
1297 \if{html}{\out{</div>}}\r
1298 \r
1299 }\r
1300 \r
1301 }\r
1302 \if{html}{\out{<hr>}}\r
1303 \if{html}{\out{<a id="method-Arvados-containers_get"></a>}}\r
1304 \if{latex}{\out{\hypertarget{method-Arvados-containers_get}{}}}\r
1305 \subsection{Method \code{containers_get()}}{\r
1306 containers_get is a method defined in Arvados class.\r
1307 \subsection{Usage}{\r
1308 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_get(uuid)}\if{html}{\out{</div>}}\r
1309 }\r
1310 \r
1311 \subsection{Arguments}{\r
1312 \if{html}{\out{<div class="arguments">}}\r
1313 \describe{\r
1314 \item{\code{uuid}}{The UUID of the Container in question.}\r
1315 }\r
1316 \if{html}{\out{</div>}}\r
1317 }\r
1318 }\r
1319 \if{html}{\out{<hr>}}\r
1320 \if{html}{\out{<a id="method-Arvados-containers_create"></a>}}\r
1321 \if{latex}{\out{\hypertarget{method-Arvados-containers_create}{}}}\r
1322 \subsection{Method \code{containers_create()}}{\r
1323 containers_create is a method defined in Arvados class.\r
1324 \subsection{Usage}{\r
1325 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_create(\r
1326   container,\r
1327   ensureUniqueName = "false",\r
1328   clusterID = NULL\r
1329 )}\if{html}{\out{</div>}}\r
1330 }\r
1331 \r
1332 \subsection{Arguments}{\r
1333 \if{html}{\out{<div class="arguments">}}\r
1334 \describe{\r
1335 \item{\code{container}}{Container object.}\r
1336 \r
1337 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}\r
1338 \r
1339 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}\r
1340 }\r
1341 \if{html}{\out{</div>}}\r
1342 }\r
1343 }\r
1344 \if{html}{\out{<hr>}}\r
1345 \if{html}{\out{<a id="method-Arvados-containers_update"></a>}}\r
1346 \if{latex}{\out{\hypertarget{method-Arvados-containers_update}{}}}\r
1347 \subsection{Method \code{containers_update()}}{\r
1348 containers_update is a method defined in Arvados class.\r
1349 \subsection{Usage}{\r
1350 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_update(container, uuid)}\if{html}{\out{</div>}}\r
1351 }\r
1352 \r
1353 \subsection{Arguments}{\r
1354 \if{html}{\out{<div class="arguments">}}\r
1355 \describe{\r
1356 \item{\code{container}}{Container object.}\r
1357 \r
1358 \item{\code{uuid}}{The UUID of the Container in question.}\r
1359 }\r
1360 \if{html}{\out{</div>}}\r
1361 }\r
1362 }\r
1363 \if{html}{\out{<hr>}}\r
1364 \if{html}{\out{<a id="method-Arvados-containers_delete"></a>}}\r
1365 \if{latex}{\out{\hypertarget{method-Arvados-containers_delete}{}}}\r
1366 \subsection{Method \code{containers_delete()}}{\r
1367 containers_delete is a method defined in Arvados class.\r
1368 \subsection{Usage}{\r
1369 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_delete(uuid)}\if{html}{\out{</div>}}\r
1370 }\r
1371 \r
1372 \subsection{Arguments}{\r
1373 \if{html}{\out{<div class="arguments">}}\r
1374 \describe{\r
1375 \item{\code{uuid}}{The UUID of the Container in question.}\r
1376 }\r
1377 \if{html}{\out{</div>}}\r
1378 }\r
1379 }\r
1380 \if{html}{\out{<hr>}}\r
1381 \if{html}{\out{<a id="method-Arvados-containers_auth"></a>}}\r
1382 \if{latex}{\out{\hypertarget{method-Arvados-containers_auth}{}}}\r
1383 \subsection{Method \code{containers_auth()}}{\r
1384 containers_auth is a method defined in Arvados class.\r
1385 \subsection{Usage}{\r
1386 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_auth(uuid)}\if{html}{\out{</div>}}\r
1387 }\r
1388 \r
1389 \subsection{Arguments}{\r
1390 \if{html}{\out{<div class="arguments">}}\r
1391 \describe{\r
1392 \item{\code{uuid}}{The UUID of the Container in question.}\r
1393 }\r
1394 \if{html}{\out{</div>}}\r
1395 }\r
1396 }\r
1397 \if{html}{\out{<hr>}}\r
1398 \if{html}{\out{<a id="method-Arvados-containers_lock"></a>}}\r
1399 \if{latex}{\out{\hypertarget{method-Arvados-containers_lock}{}}}\r
1400 \subsection{Method \code{containers_lock()}}{\r
1401 containers_lock is a method defined in Arvados class.\r
1402 \subsection{Usage}{\r
1403 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_lock(uuid)}\if{html}{\out{</div>}}\r
1404 }\r
1405 \r
1406 \subsection{Arguments}{\r
1407 \if{html}{\out{<div class="arguments">}}\r
1408 \describe{\r
1409 \item{\code{uuid}}{The UUID of the Container in question.}\r
1410 }\r
1411 \if{html}{\out{</div>}}\r
1412 }\r
1413 }\r
1414 \if{html}{\out{<hr>}}\r
1415 \if{html}{\out{<a id="method-Arvados-containers_unlock"></a>}}\r
1416 \if{latex}{\out{\hypertarget{method-Arvados-containers_unlock}{}}}\r
1417 \subsection{Method \code{containers_unlock()}}{\r
1418 containers_unlock is a method defined in Arvados class.\r
1419 \subsection{Usage}{\r
1420 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_unlock(uuid)}\if{html}{\out{</div>}}\r
1421 }\r
1422 \r
1423 \subsection{Arguments}{\r
1424 \if{html}{\out{<div class="arguments">}}\r
1425 \describe{\r
1426 \item{\code{uuid}}{The UUID of the Container in question.}\r
1427 }\r
1428 \if{html}{\out{</div>}}\r
1429 }\r
1430 }\r
1431 \if{html}{\out{<hr>}}\r
1432 \if{html}{\out{<a id="method-Arvados-containers_secret_mounts"></a>}}\r
1433 \if{latex}{\out{\hypertarget{method-Arvados-containers_secret_mounts}{}}}\r
1434 \subsection{Method \code{containers_secret_mounts()}}{\r
1435 containers_secret_mounts is a method defined in Arvados class.\r
1436 \subsection{Usage}{\r
1437 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_secret_mounts(uuid)}\if{html}{\out{</div>}}\r
1438 }\r
1439 \r
1440 \subsection{Arguments}{\r
1441 \if{html}{\out{<div class="arguments">}}\r
1442 \describe{\r
1443 \item{\code{uuid}}{The UUID of the Container in question.}\r
1444 }\r
1445 \if{html}{\out{</div>}}\r
1446 }\r
1447 }\r
1448 \if{html}{\out{<hr>}}\r
1449 \if{html}{\out{<a id="method-Arvados-containers_current"></a>}}\r
1450 \if{latex}{\out{\hypertarget{method-Arvados-containers_current}{}}}\r
1451 \subsection{Method \code{containers_current()}}{\r
1452 containers_current is a method defined in Arvados class.\r
1453 \subsection{Usage}{\r
1454 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_current()}\if{html}{\out{</div>}}\r
1455 }\r
1456 \r
1457 }\r
1458 \if{html}{\out{<hr>}}\r
1459 \if{html}{\out{<a id="method-Arvados-containers_list"></a>}}\r
1460 \if{latex}{\out{\hypertarget{method-Arvados-containers_list}{}}}\r
1461 \subsection{Method \code{containers_list()}}{\r
1462 containers_list is a method defined in Arvados class.\r
1463 \subsection{Usage}{\r
1464 \if{html}{\out{<div class="r">}}\preformatted{Arvados$containers_list(\r
1465   filters = NULL,\r
1466   where = NULL,\r
1467   order = NULL,\r
1468   select = NULL,\r
1469   distinct = NULL,\r
1470   limit = "100",\r
1471   offset = "0",\r
1472   count = "exact",\r
1473   clusterID = NULL,\r
1474   bypassFederation = NULL\r
1475 )}\if{html}{\out{</div>}}\r
1476 }\r
1477 \r
1478 \subsection{Arguments}{\r
1479 \if{html}{\out{<div class="arguments">}}\r
1480 \describe{\r
1481 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}\r
1482 \r
1483 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}\r
1484 }\r
1485 \if{html}{\out{</div>}}\r
1486 }\r
1487 }\r
1488 \if{html}{\out{<hr>}}\r
1489 \if{html}{\out{<a id="method-Arvados-container_requests_get"></a>}}\r
1490 \if{latex}{\out{\hypertarget{method-Arvados-container_requests_get}{}}}\r
1491 \subsection{Method \code{container_requests_get()}}{\r
1492 container_requests_get is a method defined in Arvados class.\r
1493 \subsection{Usage}{\r
1494 \if{html}{\out{<div class="r">}}\preformatted{Arvados$container_requests_get(uuid)}\if{html}{\out{</div>}}\r
1495 }\r
1496 \r
1497 \subsection{Arguments}{\r
1498 \if{html}{\out{<div class="arguments">}}\r
1499 \describe{\r
1500 \item{\code{uuid}}{The UUID of the containerRequest in question.}\r
1501 }\r
1502 \if{html}{\out{</div>}}\r
1503 }\r
1504 }\r
1505 \if{html}{\out{<hr>}}\r
1506 \if{html}{\out{<a id="method-Arvados-container_requests_create"></a>}}\r
1507 \if{latex}{\out{\hypertarget{method-Arvados-container_requests_create}{}}}\r
1508 \subsection{Method \code{container_requests_create()}}{\r
1509 container_requests_create is a method defined in Arvados class.\r
1510 \subsection{Usage}{\r
1511 \if{html}{\out{<div class="r">}}\preformatted{Arvados$container_requests_create(\r
1512   containerRequest,\r
1513   ensureUniqueName = "false",\r
1514   clusterID = NULL\r
1515 )}\if{html}{\out{</div>}}\r
1516 }\r
1517 \r
1518 \subsection{Arguments}{\r
1519 \if{html}{\out{<div class="arguments">}}\r
1520 \describe{\r
1521 \item{\code{containerRequest}}{containerRequest object.}\r
1522 \r
1523 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}\r
1524 \r
1525 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}\r
1526 }\r
1527 \if{html}{\out{</div>}}\r
1528 }\r
1529 }\r
1530 \if{html}{\out{<hr>}}\r
1531 \if{html}{\out{<a id="method-Arvados-container_requests_update"></a>}}\r
1532 \if{latex}{\out{\hypertarget{method-Arvados-container_requests_update}{}}}\r
1533 \subsection{Method \code{container_requests_update()}}{\r
1534 container_requests_update is a method defined in Arvados class.\r
1535 \subsection{Usage}{\r
1536 \if{html}{\out{<div class="r">}}\preformatted{Arvados$container_requests_update(containerRequest, uuid)}\if{html}{\out{</div>}}\r
1537 }\r
1538 \r
1539 \subsection{Arguments}{\r
1540 \if{html}{\out{<div class="arguments">}}\r
1541 \describe{\r
1542 \item{\code{containerRequest}}{containerRequest object.}\r
1543 \r
1544 \item{\code{uuid}}{The UUID of the containerRequest in question.}\r
1545 }\r
1546 \if{html}{\out{</div>}}\r
1547 }\r
1548 }\r
1549 \if{html}{\out{<hr>}}\r
1550 \if{html}{\out{<a id="method-Arvados-container_requests_delete"></a>}}\r
1551 \if{latex}{\out{\hypertarget{method-Arvados-container_requests_delete}{}}}\r
1552 \subsection{Method \code{container_requests_delete()}}{\r
1553 container_requests_delete is a method defined in Arvados class.\r
1554 \subsection{Usage}{\r
1555 \if{html}{\out{<div class="r">}}\preformatted{Arvados$container_requests_delete(uuid)}\if{html}{\out{</div>}}\r
1556 }\r
1557 \r
1558 \subsection{Arguments}{\r
1559 \if{html}{\out{<div class="arguments">}}\r
1560 \describe{\r
1561 \item{\code{uuid}}{The UUID of the containerRequest in question.}\r
1562 }\r
1563 \if{html}{\out{</div>}}\r
1564 }\r
1565 }\r
1566 \if{html}{\out{<hr>}}\r
1567 \if{html}{\out{<a id="method-Arvados-container_requests_list"></a>}}\r
1568 \if{latex}{\out{\hypertarget{method-Arvados-container_requests_list}{}}}\r
1569 \subsection{Method \code{container_requests_list()}}{\r
1570 container_requests_list is a method defined in Arvados class.\r
1571 \subsection{Usage}{\r
1572 \if{html}{\out{<div class="r">}}\preformatted{Arvados$container_requests_list(\r
1573   filters = NULL,\r
1574   where = NULL,\r
1575   order = NULL,\r
1576   select = NULL,\r
1577   distinct = NULL,\r
1578   limit = "100",\r
1579   offset = "0",\r
1580   count = "exact",\r
1581   clusterID = NULL,\r
1582   bypassFederation = NULL,\r
1583   includeTrash = NULL\r
1584 )}\if{html}{\out{</div>}}\r
1585 }\r
1586 \r
1587 \subsection{Arguments}{\r
1588 \if{html}{\out{<div class="arguments">}}\r
1589 \describe{\r
1590 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}\r
1591 \r
1592 \item{\code{bypassFederation}}{bypass federation behavior, list items from local instance database only}\r
1593 \r
1594 \item{\code{includeTrash}}{Include container requests whose owner project is trashed.}\r
1595 }\r
1596 \if{html}{\out{</div>}}\r
1597 }\r
1598 }\r
1599 \if{html}{\out{<hr>}}\r
1600 \if{html}{\out{<a id="method-Arvados-groups_get"></a>}}\r
1601 \if{latex}{\out{\hypertarget{method-Arvados-groups_get}{}}}\r
1602 \subsection{Method \code{groups_get()}}{\r
1603 groups_get is a method defined in Arvados class.\r
1604 \subsection{Usage}{\r
1605 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_get(uuid)}\if{html}{\out{</div>}}\r
1606 }\r
1607 \r
1608 \subsection{Arguments}{\r
1609 \if{html}{\out{<div class="arguments">}}\r
1610 \describe{\r
1611 \item{\code{uuid}}{The UUID of the Group in question.}\r
1612 }\r
1613 \if{html}{\out{</div>}}\r
1614 }\r
1615 }\r
1616 \if{html}{\out{<hr>}}\r
1617 \if{html}{\out{<a id="method-Arvados-groups_create"></a>}}\r
1618 \if{latex}{\out{\hypertarget{method-Arvados-groups_create}{}}}\r
1619 \subsection{Method \code{groups_create()}}{\r
1620 groups_create is a method defined in Arvados class that supports project creation.\r
1621 \subsection{Usage}{\r
1622 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_create(\r
1623   group,\r
1624   ensureUniqueName = "false",\r
1625   clusterID = NULL,\r
1626   async = "false"\r
1627 )}\if{html}{\out{</div>}}\r
1628 }\r
1629 \r
1630 \subsection{Arguments}{\r
1631 \if{html}{\out{<div class="arguments">}}\r
1632 \describe{\r
1633 \item{\code{group}}{Group object.}\r
1634 \r
1635 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}\r
1636 \r
1637 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}\r
1638 \r
1639 \item{\code{async}}{Defer permissions update.}\r
1640 }\r
1641 \if{html}{\out{</div>}}\r
1642 }\r
1643 }\r
1644 \if{html}{\out{<hr>}}\r
1645 \if{html}{\out{<a id="method-Arvados-groups_update"></a>}}\r
1646 \if{latex}{\out{\hypertarget{method-Arvados-groups_update}{}}}\r
1647 \subsection{Method \code{groups_update()}}{\r
1648 groups_update is a method defined in Arvados class.\r
1649 \subsection{Usage}{\r
1650 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_update(group, uuid, async = "false")}\if{html}{\out{</div>}}\r
1651 }\r
1652 \r
1653 \subsection{Arguments}{\r
1654 \if{html}{\out{<div class="arguments">}}\r
1655 \describe{\r
1656 \item{\code{group}}{Group object.}\r
1657 \r
1658 \item{\code{uuid}}{The UUID of the Group in question.}\r
1659 \r
1660 \item{\code{async}}{Defer permissions update.}\r
1661 }\r
1662 \if{html}{\out{</div>}}\r
1663 }\r
1664 }\r
1665 \if{html}{\out{<hr>}}\r
1666 \if{html}{\out{<a id="method-Arvados-groups_delete"></a>}}\r
1667 \if{latex}{\out{\hypertarget{method-Arvados-groups_delete}{}}}\r
1668 \subsection{Method \code{groups_delete()}}{\r
1669 groups_delete is a method defined in Arvados class.\r
1670 \subsection{Usage}{\r
1671 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_delete(uuid)}\if{html}{\out{</div>}}\r
1672 }\r
1673 \r
1674 \subsection{Arguments}{\r
1675 \if{html}{\out{<div class="arguments">}}\r
1676 \describe{\r
1677 \item{\code{uuid}}{The UUID of the Group in question.}\r
1678 }\r
1679 \if{html}{\out{</div>}}\r
1680 }\r
1681 }\r
1682 \if{html}{\out{<hr>}}\r
1683 \if{html}{\out{<a id="method-Arvados-groups_contents"></a>}}\r
1684 \if{latex}{\out{\hypertarget{method-Arvados-groups_contents}{}}}\r
1685 \subsection{Method \code{groups_contents()}}{\r
1686 groups_contents is a method defined in Arvados class.\r
1687 \subsection{Usage}{\r
1688 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_contents(\r
1689   filters = NULL,\r
1690   where = NULL,\r
1691   order = NULL,\r
1692   distinct = NULL,\r
1693   limit = "100",\r
1694   offset = "0",\r
1695   count = "exact",\r
1696   clusterID = NULL,\r
1697   bypassFederation = NULL,\r
1698   includeTrash = NULL,\r
1699   uuid = NULL,\r
1700   recursive = NULL,\r
1701   include = NULL\r
1702 )}\if{html}{\out{</div>}}\r
1703 }\r
1704 \r
1705 \subsection{Arguments}{\r
1706 \if{html}{\out{<div class="arguments">}}\r
1707 \describe{\r
1708 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}\r
1709 \r
1710 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}\r
1711 \r
1712 \item{\code{includeTrash}}{Include items whose is_trashed attribute is true.}\r
1713 \r
1714 \item{\code{recursive}}{Include contents from child groups recursively.}\r
1715 \r
1716 \item{\code{include}}{Include objects referred to by listed field in "included" (only ownerUUID).}\r
1717 }\r
1718 \if{html}{\out{</div>}}\r
1719 }\r
1720 }\r
1721 \if{html}{\out{<hr>}}\r
1722 \if{html}{\out{<a id="method-Arvados-groups_shared"></a>}}\r
1723 \if{latex}{\out{\hypertarget{method-Arvados-groups_shared}{}}}\r
1724 \subsection{Method \code{groups_shared()}}{\r
1725 groups_shared is a method defined in Arvados class.\r
1726 \subsection{Usage}{\r
1727 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_shared(\r
1728   filters = NULL,\r
1729   where = NULL,\r
1730   order = NULL,\r
1731   select = NULL,\r
1732   distinct = NULL,\r
1733   limit = "100",\r
1734   offset = "0",\r
1735   count = "exact",\r
1736   clusterID = NULL,\r
1737   bypassFederation = NULL,\r
1738   includeTrash = NULL,\r
1739   include = NULL\r
1740 )}\if{html}{\out{</div>}}\r
1741 }\r
1742 \r
1743 \subsection{Arguments}{\r
1744 \if{html}{\out{<div class="arguments">}}\r
1745 \describe{\r
1746 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}\r
1747 \r
1748 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}\r
1749 \r
1750 \item{\code{includeTrash}}{Include items whose is_trashed attribute is true.}\r
1751 }\r
1752 \if{html}{\out{</div>}}\r
1753 }\r
1754 }\r
1755 \if{html}{\out{<hr>}}\r
1756 \if{html}{\out{<a id="method-Arvados-groups_trash"></a>}}\r
1757 \if{latex}{\out{\hypertarget{method-Arvados-groups_trash}{}}}\r
1758 \subsection{Method \code{groups_trash()}}{\r
1759 groups_trash is a method defined in Arvados class.\r
1760 \subsection{Usage}{\r
1761 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_trash(uuid)}\if{html}{\out{</div>}}\r
1762 }\r
1763 \r
1764 \subsection{Arguments}{\r
1765 \if{html}{\out{<div class="arguments">}}\r
1766 \describe{\r
1767 \item{\code{uuid}}{The UUID of the Group in question.}\r
1768 }\r
1769 \if{html}{\out{</div>}}\r
1770 }\r
1771 }\r
1772 \if{html}{\out{<hr>}}\r
1773 \if{html}{\out{<a id="method-Arvados-groups_untrash"></a>}}\r
1774 \if{latex}{\out{\hypertarget{method-Arvados-groups_untrash}{}}}\r
1775 \subsection{Method \code{groups_untrash()}}{\r
1776 groups_untrash is a method defined in Arvados class.\r
1777 \subsection{Usage}{\r
1778 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_untrash(uuid)}\if{html}{\out{</div>}}\r
1779 }\r
1780 \r
1781 \subsection{Arguments}{\r
1782 \if{html}{\out{<div class="arguments">}}\r
1783 \describe{\r
1784 \item{\code{uuid}}{The UUID of the Group in question.}\r
1785 }\r
1786 \if{html}{\out{</div>}}\r
1787 }\r
1788 }\r
1789 \if{html}{\out{<hr>}}\r
1790 \if{html}{\out{<a id="method-Arvados-groups_list"></a>}}\r
1791 \if{latex}{\out{\hypertarget{method-Arvados-groups_list}{}}}\r
1792 \subsection{Method \code{groups_list()}}{\r
1793 groups_list is a method defined in Arvados class.\r
1794 \subsection{Usage}{\r
1795 \if{html}{\out{<div class="r">}}\preformatted{Arvados$groups_list(\r
1796   filters = NULL,\r
1797   where = NULL,\r
1798   order = NULL,\r
1799   select = NULL,\r
1800   distinct = NULL,\r
1801   limit = "100",\r
1802   offset = "0",\r
1803   count = "exact",\r
1804   clusterID = NULL,\r
1805   bypassFederation = NULL,\r
1806   includeTrash = NULL\r
1807 )}\if{html}{\out{</div>}}\r
1808 }\r
1809 \r
1810 \subsection{Arguments}{\r
1811 \if{html}{\out{<div class="arguments">}}\r
1812 \describe{\r
1813 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}\r
1814 \r
1815 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}\r
1816 \r
1817 \item{\code{includeTrash}}{Include items whose is_trashed attribute is true.}\r
1818 }\r
1819 \if{html}{\out{</div>}}\r
1820 }\r
1821 }\r
1822 \if{html}{\out{<hr>}}\r
1823 \if{html}{\out{<a id="method-Arvados-keep_services_get"></a>}}\r
1824 \if{latex}{\out{\hypertarget{method-Arvados-keep_services_get}{}}}\r
1825 \subsection{Method \code{keep_services_get()}}{\r
1826 keep_services_get is a method defined in Arvados class.\r
1827 \subsection{Usage}{\r
1828 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_get(uuid)}\if{html}{\out{</div>}}\r
1829 }\r
1830 \r
1831 \subsection{Arguments}{\r
1832 \if{html}{\out{<div class="arguments">}}\r
1833 \describe{\r
1834 \item{\code{uuid}}{The UUID of the keepService in question.}\r
1835 }\r
1836 \if{html}{\out{</div>}}\r
1837 }\r
1838 }\r
1839 \if{html}{\out{<hr>}}\r
1840 \if{html}{\out{<a id="method-Arvados-keep_services_create"></a>}}\r
1841 \if{latex}{\out{\hypertarget{method-Arvados-keep_services_create}{}}}\r
1842 \subsection{Method \code{keep_services_create()}}{\r
1843 keep_services_create is a method defined in Arvados class.\r
1844 \subsection{Usage}{\r
1845 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_create(\r
1846   keepService,\r
1847   ensureUniqueName = "false",\r
1848   clusterID = NULL\r
1849 )}\if{html}{\out{</div>}}\r
1850 }\r
1851 \r
1852 \subsection{Arguments}{\r
1853 \if{html}{\out{<div class="arguments">}}\r
1854 \describe{\r
1855 \item{\code{keepService}}{keepService object.}\r
1856 \r
1857 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}\r
1858 \r
1859 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}\r
1860 }\r
1861 \if{html}{\out{</div>}}\r
1862 }\r
1863 }\r
1864 \if{html}{\out{<hr>}}\r
1865 \if{html}{\out{<a id="method-Arvados-keep_services_update"></a>}}\r
1866 \if{latex}{\out{\hypertarget{method-Arvados-keep_services_update}{}}}\r
1867 \subsection{Method \code{keep_services_update()}}{\r
1868 keep_services_update is a method defined in Arvados class.\r
1869 \subsection{Usage}{\r
1870 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_update(keepService, uuid)}\if{html}{\out{</div>}}\r
1871 }\r
1872 \r
1873 \subsection{Arguments}{\r
1874 \if{html}{\out{<div class="arguments">}}\r
1875 \describe{\r
1876 \item{\code{keepService}}{keepService object.}\r
1877 \r
1878 \item{\code{uuid}}{The UUID of the keepService in question.}\r
1879 }\r
1880 \if{html}{\out{</div>}}\r
1881 }\r
1882 }\r
1883 \if{html}{\out{<hr>}}\r
1884 \if{html}{\out{<a id="method-Arvados-keep_services_delete"></a>}}\r
1885 \if{latex}{\out{\hypertarget{method-Arvados-keep_services_delete}{}}}\r
1886 \subsection{Method \code{keep_services_delete()}}{\r
1887 keep_services_delete is a method defined in Arvados class.\r
1888 \subsection{Usage}{\r
1889 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_delete(uuid)}\if{html}{\out{</div>}}\r
1890 }\r
1891 \r
1892 \subsection{Arguments}{\r
1893 \if{html}{\out{<div class="arguments">}}\r
1894 \describe{\r
1895 \item{\code{uuid}}{The UUID of the keepService in question.}\r
1896 }\r
1897 \if{html}{\out{</div>}}\r
1898 }\r
1899 }\r
1900 \if{html}{\out{<hr>}}\r
1901 \if{html}{\out{<a id="method-Arvados-keep_services_accessible"></a>}}\r
1902 \if{latex}{\out{\hypertarget{method-Arvados-keep_services_accessible}{}}}\r
1903 \subsection{Method \code{keep_services_accessible()}}{\r
1904 keep_services_accessible is a method defined in Arvados class.\r
1905 \subsection{Usage}{\r
1906 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_accessible()}\if{html}{\out{</div>}}\r
1907 }\r
1908 \r
1909 }\r
1910 \if{html}{\out{<hr>}}\r
1911 \if{html}{\out{<a id="method-Arvados-keep_services_list"></a>}}\r
1912 \if{latex}{\out{\hypertarget{method-Arvados-keep_services_list}{}}}\r
1913 \subsection{Method \code{keep_services_list()}}{\r
1914 keep_services_list is a method defined in Arvados class.\r
1915 \subsection{Usage}{\r
1916 \if{html}{\out{<div class="r">}}\preformatted{Arvados$keep_services_list(\r
1917   filters = NULL,\r
1918   where = NULL,\r
1919   order = NULL,\r
1920   select = NULL,\r
1921   distinct = NULL,\r
1922   limit = "100",\r
1923   offset = "0",\r
1924   count = "exact",\r
1925   clusterID = NULL,\r
1926   bypassFederation = NULL\r
1927 )}\if{html}{\out{</div>}}\r
1928 }\r
1929 \r
1930 \subsection{Arguments}{\r
1931 \if{html}{\out{<div class="arguments">}}\r
1932 \describe{\r
1933 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}\r
1934 \r
1935 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}\r
1936 }\r
1937 \if{html}{\out{</div>}}\r
1938 }\r
1939 }\r
1940 \if{html}{\out{<hr>}}\r
1941 \if{html}{\out{<a id="method-Arvados-project_permission_give"></a>}}\r
1942 \if{latex}{\out{\hypertarget{method-Arvados-project_permission_give}{}}}\r
1943 \subsection{Method \code{project_permission_give()}}{\r
1944 project_permission_give is a method defined in Arvados class that enables sharing files with another users.\r
1945 \subsection{Usage}{\r
1946 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_permission_give(type, uuid, user)}\if{html}{\out{</div>}}\r
1947 }\r
1948 \r
1949 \subsection{Arguments}{\r
1950 \if{html}{\out{<div class="arguments">}}\r
1951 \describe{\r
1952 \item{\code{type}}{Possible options are can_read or can_write or can_manage.}\r
1953 \r
1954 \item{\code{uuid}}{The UUID of a project or a file.}\r
1955 \r
1956 \item{\code{user}}{The UUID of the person that gets the permission.}\r
1957 }\r
1958 \if{html}{\out{</div>}}\r
1959 }\r
1960 \subsection{Examples}{\r
1961 \if{html}{\out{<div class="r example copy">}}\r
1962 \preformatted{\dontrun{\r
1963 arv$project_permission_give(type = "can_read", uuid = objectUUID, user = userUUID)\r
1964 }\r
1965 }\r
1966 \if{html}{\out{</div>}}\r
1967 \r
1968 }\r
1969 \r
1970 }\r
1971 \if{html}{\out{<hr>}}\r
1972 \if{html}{\out{<a id="method-Arvados-project_permission_refuse"></a>}}\r
1973 \if{latex}{\out{\hypertarget{method-Arvados-project_permission_refuse}{}}}\r
1974 \subsection{Method \code{project_permission_refuse()}}{\r
1975 project_permission_refuse is a method defined in Arvados class that unables sharing files with another users.\r
1976 \subsection{Usage}{\r
1977 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_permission_refuse(type, uuid, user)}\if{html}{\out{</div>}}\r
1978 }\r
1979 \r
1980 \subsection{Arguments}{\r
1981 \if{html}{\out{<div class="arguments">}}\r
1982 \describe{\r
1983 \item{\code{type}}{Possible options are can_read or can_write or can_manage.}\r
1984 \r
1985 \item{\code{uuid}}{The UUID of a project or a file.}\r
1986 \r
1987 \item{\code{user}}{The UUID of a person that permissions are taken from.}\r
1988 }\r
1989 \if{html}{\out{</div>}}\r
1990 }\r
1991 \subsection{Examples}{\r
1992 \if{html}{\out{<div class="r example copy">}}\r
1993 \preformatted{\dontrun{\r
1994 arv$project_permission_refuse(type = "can_read", uuid = objectUUID, user = userUUID)\r
1995 }\r
1996 }\r
1997 \if{html}{\out{</div>}}\r
1998 \r
1999 }\r
2000 \r
2001 }\r
2002 \if{html}{\out{<hr>}}\r
2003 \if{html}{\out{<a id="method-Arvados-project_permission_update"></a>}}\r
2004 \if{latex}{\out{\hypertarget{method-Arvados-project_permission_update}{}}}\r
2005 \subsection{Method \code{project_permission_update()}}{\r
2006 project_permission_update is a method defined in Arvados class that enables updating permissions.\r
2007 \subsection{Usage}{\r
2008 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_permission_update(typeOld, typeNew, uuid, user)}\if{html}{\out{</div>}}\r
2009 }\r
2010 \r
2011 \subsection{Arguments}{\r
2012 \if{html}{\out{<div class="arguments">}}\r
2013 \describe{\r
2014 \item{\code{typeOld}}{Old option.}\r
2015 \r
2016 \item{\code{typeNew}}{New option like can_read or can_write or can_manage.}\r
2017 \r
2018 \item{\code{uuid}}{The UUID of a project or a file.}\r
2019 \r
2020 \item{\code{user}}{The UUID of the person that the permission is being updated.}\r
2021 }\r
2022 \if{html}{\out{</div>}}\r
2023 }\r
2024 \subsection{Examples}{\r
2025 \if{html}{\out{<div class="r example copy">}}\r
2026 \preformatted{\dontrun{\r
2027 arv$project_permission_update(typeOld = "can_read", typeNew = "can_write", uuid = objectUUID, user = userUUID)\r
2028 }\r
2029 }\r
2030 \if{html}{\out{</div>}}\r
2031 \r
2032 }\r
2033 \r
2034 }\r
2035 \if{html}{\out{<hr>}}\r
2036 \if{html}{\out{<a id="method-Arvados-project_permission_check"></a>}}\r
2037 \if{latex}{\out{\hypertarget{method-Arvados-project_permission_check}{}}}\r
2038 \subsection{Method \code{project_permission_check()}}{\r
2039 project_permission_check is a method defined in Arvados class that enables checking file permissions.\r
2040 \subsection{Usage}{\r
2041 \if{html}{\out{<div class="r">}}\preformatted{Arvados$project_permission_check(uuid, user, type = NULL)}\if{html}{\out{</div>}}\r
2042 }\r
2043 \r
2044 \subsection{Arguments}{\r
2045 \if{html}{\out{<div class="arguments">}}\r
2046 \describe{\r
2047 \item{\code{uuid}}{The UUID of a project or a file.}\r
2048 \r
2049 \item{\code{user}}{The UUID of the person that the permission is being updated.}\r
2050 \r
2051 \item{\code{type}}{Possible options are can_read or can_write or can_manage.}\r
2052 }\r
2053 \if{html}{\out{</div>}}\r
2054 }\r
2055 \subsection{Examples}{\r
2056 \if{html}{\out{<div class="r example copy">}}\r
2057 \preformatted{\dontrun{\r
2058 arv$project_permission_check(type = "can_read", uuid = objectUUID, user = userUUID)\r
2059 }\r
2060 }\r
2061 \if{html}{\out{</div>}}\r
2062 \r
2063 }\r
2064 \r
2065 }\r
2066 \if{html}{\out{<hr>}}\r
2067 \if{html}{\out{<a id="method-Arvados-links_get"></a>}}\r
2068 \if{latex}{\out{\hypertarget{method-Arvados-links_get}{}}}\r
2069 \subsection{Method \code{links_get()}}{\r
2070 links_get is a method defined in Arvados class.\r
2071 \subsection{Usage}{\r
2072 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_get(uuid)}\if{html}{\out{</div>}}\r
2073 }\r
2074 \r
2075 \subsection{Arguments}{\r
2076 \if{html}{\out{<div class="arguments">}}\r
2077 \describe{\r
2078 \item{\code{uuid}}{The UUID of the Link in question.}\r
2079 }\r
2080 \if{html}{\out{</div>}}\r
2081 }\r
2082 }\r
2083 \if{html}{\out{<hr>}}\r
2084 \if{html}{\out{<a id="method-Arvados-links_create"></a>}}\r
2085 \if{latex}{\out{\hypertarget{method-Arvados-links_create}{}}}\r
2086 \subsection{Method \code{links_create()}}{\r
2087 links_create is a method defined in Arvados class.\r
2088 \subsection{Usage}{\r
2089 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_create(link, ensureUniqueName = "false", clusterID = NULL)}\if{html}{\out{</div>}}\r
2090 }\r
2091 \r
2092 \subsection{Arguments}{\r
2093 \if{html}{\out{<div class="arguments">}}\r
2094 \describe{\r
2095 \item{\code{link}}{Link object.}\r
2096 \r
2097 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}\r
2098 \r
2099 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}\r
2100 }\r
2101 \if{html}{\out{</div>}}\r
2102 }\r
2103 }\r
2104 \if{html}{\out{<hr>}}\r
2105 \if{html}{\out{<a id="method-Arvados-links_update"></a>}}\r
2106 \if{latex}{\out{\hypertarget{method-Arvados-links_update}{}}}\r
2107 \subsection{Method \code{links_update()}}{\r
2108 links_update is a method defined in Arvados class.\r
2109 \subsection{Usage}{\r
2110 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_update(link, uuid, async = "false")}\if{html}{\out{</div>}}\r
2111 }\r
2112 \r
2113 \subsection{Arguments}{\r
2114 \if{html}{\out{<div class="arguments">}}\r
2115 \describe{\r
2116 \item{\code{link}}{Link object.}\r
2117 \r
2118 \item{\code{uuid}}{The UUID of the Link in question.}\r
2119 }\r
2120 \if{html}{\out{</div>}}\r
2121 }\r
2122 }\r
2123 \if{html}{\out{<hr>}}\r
2124 \if{html}{\out{<a id="method-Arvados-links_delete"></a>}}\r
2125 \if{latex}{\out{\hypertarget{method-Arvados-links_delete}{}}}\r
2126 \subsection{Method \code{links_delete()}}{\r
2127 links_delete is a method defined in Arvados class.\r
2128 \subsection{Usage}{\r
2129 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_delete(uuid)}\if{html}{\out{</div>}}\r
2130 }\r
2131 \r
2132 \subsection{Arguments}{\r
2133 \if{html}{\out{<div class="arguments">}}\r
2134 \describe{\r
2135 \item{\code{uuid}}{The UUID of the Link in question.}\r
2136 }\r
2137 \if{html}{\out{</div>}}\r
2138 }\r
2139 }\r
2140 \if{html}{\out{<hr>}}\r
2141 \if{html}{\out{<a id="method-Arvados-links_list"></a>}}\r
2142 \if{latex}{\out{\hypertarget{method-Arvados-links_list}{}}}\r
2143 \subsection{Method \code{links_list()}}{\r
2144 links_list is a method defined in Arvados class.\r
2145 \subsection{Usage}{\r
2146 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_list(\r
2147   filters = NULL,\r
2148   where = NULL,\r
2149   order = NULL,\r
2150   select = NULL,\r
2151   distinct = NULL,\r
2152   limit = "100",\r
2153   offset = "0",\r
2154   count = "exact",\r
2155   clusterID = NULL,\r
2156   bypassFederation = NULL\r
2157 )}\if{html}{\out{</div>}}\r
2158 }\r
2159 \r
2160 \subsection{Arguments}{\r
2161 \if{html}{\out{<div class="arguments">}}\r
2162 \describe{\r
2163 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}\r
2164 \r
2165 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}\r
2166 }\r
2167 \if{html}{\out{</div>}}\r
2168 }\r
2169 }\r
2170 \if{html}{\out{<hr>}}\r
2171 \if{html}{\out{<a id="method-Arvados-links_get_permissions"></a>}}\r
2172 \if{latex}{\out{\hypertarget{method-Arvados-links_get_permissions}{}}}\r
2173 \subsection{Method \code{links_get_permissions()}}{\r
2174 links_get_permissions is a method defined in Arvados class.\r
2175 \subsection{Usage}{\r
2176 \if{html}{\out{<div class="r">}}\preformatted{Arvados$links_get_permissions(uuid)}\if{html}{\out{</div>}}\r
2177 }\r
2178 \r
2179 \subsection{Arguments}{\r
2180 \if{html}{\out{<div class="arguments">}}\r
2181 \describe{\r
2182 \item{\code{uuid}}{The UUID of the Log in question.}\r
2183 }\r
2184 \if{html}{\out{</div>}}\r
2185 }\r
2186 }\r
2187 \if{html}{\out{<hr>}}\r
2188 \if{html}{\out{<a id="method-Arvados-logs_get"></a>}}\r
2189 \if{latex}{\out{\hypertarget{method-Arvados-logs_get}{}}}\r
2190 \subsection{Method \code{logs_get()}}{\r
2191 logs_get is a method defined in Arvados class.\r
2192 \subsection{Usage}{\r
2193 \if{html}{\out{<div class="r">}}\preformatted{Arvados$logs_get(uuid)}\if{html}{\out{</div>}}\r
2194 }\r
2195 \r
2196 \subsection{Arguments}{\r
2197 \if{html}{\out{<div class="arguments">}}\r
2198 \describe{\r
2199 \item{\code{uuid}}{The UUID of the Log in question.}\r
2200 }\r
2201 \if{html}{\out{</div>}}\r
2202 }\r
2203 }\r
2204 \if{html}{\out{<hr>}}\r
2205 \if{html}{\out{<a id="method-Arvados-logs_create"></a>}}\r
2206 \if{latex}{\out{\hypertarget{method-Arvados-logs_create}{}}}\r
2207 \subsection{Method \code{logs_create()}}{\r
2208 logs_create is a method defined in Arvados class.\r
2209 \subsection{Usage}{\r
2210 \if{html}{\out{<div class="r">}}\preformatted{Arvados$logs_create(log, ensureUniqueName = "false", clusterID = NULL)}\if{html}{\out{</div>}}\r
2211 }\r
2212 \r
2213 \subsection{Arguments}{\r
2214 \if{html}{\out{<div class="arguments">}}\r
2215 \describe{\r
2216 \item{\code{log}}{Log object.}\r
2217 \r
2218 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}\r
2219 \r
2220 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}\r
2221 }\r
2222 \if{html}{\out{</div>}}\r
2223 }\r
2224 }\r
2225 \if{html}{\out{<hr>}}\r
2226 \if{html}{\out{<a id="method-Arvados-logs_update"></a>}}\r
2227 \if{latex}{\out{\hypertarget{method-Arvados-logs_update}{}}}\r
2228 \subsection{Method \code{logs_update()}}{\r
2229 logs_update is a method defined in Arvados class.\r
2230 \subsection{Usage}{\r
2231 \if{html}{\out{<div class="r">}}\preformatted{Arvados$logs_update(log, uuid)}\if{html}{\out{</div>}}\r
2232 }\r
2233 \r
2234 \subsection{Arguments}{\r
2235 \if{html}{\out{<div class="arguments">}}\r
2236 \describe{\r
2237 \item{\code{log}}{Log object.}\r
2238 \r
2239 \item{\code{uuid}}{The UUID of the Log in question.}\r
2240 }\r
2241 \if{html}{\out{</div>}}\r
2242 }\r
2243 }\r
2244 \if{html}{\out{<hr>}}\r
2245 \if{html}{\out{<a id="method-Arvados-logs_delete"></a>}}\r
2246 \if{latex}{\out{\hypertarget{method-Arvados-logs_delete}{}}}\r
2247 \subsection{Method \code{logs_delete()}}{\r
2248 logs_delete is a method defined in Arvados class.\r
2249 \subsection{Usage}{\r
2250 \if{html}{\out{<div class="r">}}\preformatted{Arvados$logs_delete(uuid)}\if{html}{\out{</div>}}\r
2251 }\r
2252 \r
2253 \subsection{Arguments}{\r
2254 \if{html}{\out{<div class="arguments">}}\r
2255 \describe{\r
2256 \item{\code{uuid}}{The UUID of the Log in question.}\r
2257 }\r
2258 \if{html}{\out{</div>}}\r
2259 }\r
2260 }\r
2261 \if{html}{\out{<hr>}}\r
2262 \if{html}{\out{<a id="method-Arvados-logs_list"></a>}}\r
2263 \if{latex}{\out{\hypertarget{method-Arvados-logs_list}{}}}\r
2264 \subsection{Method \code{logs_list()}}{\r
2265 logs_list is a method defined in Arvados class.\r
2266 \subsection{Usage}{\r
2267 \if{html}{\out{<div class="r">}}\preformatted{Arvados$logs_list(\r
2268   filters = NULL,\r
2269   where = NULL,\r
2270   order = NULL,\r
2271   select = NULL,\r
2272   distinct = NULL,\r
2273   limit = "100",\r
2274   offset = "0",\r
2275   count = "exact",\r
2276   clusterID = NULL,\r
2277   bypassFederation = NULL\r
2278 )}\if{html}{\out{</div>}}\r
2279 }\r
2280 \r
2281 \subsection{Arguments}{\r
2282 \if{html}{\out{<div class="arguments">}}\r
2283 \describe{\r
2284 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}\r
2285 \r
2286 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}\r
2287 }\r
2288 \if{html}{\out{</div>}}\r
2289 }\r
2290 }\r
2291 \if{html}{\out{<hr>}}\r
2292 \if{html}{\out{<a id="method-Arvados-users_get"></a>}}\r
2293 \if{latex}{\out{\hypertarget{method-Arvados-users_get}{}}}\r
2294 \subsection{Method \code{users_get()}}{\r
2295 users_get is a method defined in Arvados class.\r
2296 \subsection{Usage}{\r
2297 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_get(uuid)}\if{html}{\out{</div>}}\r
2298 }\r
2299 \r
2300 \subsection{Arguments}{\r
2301 \if{html}{\out{<div class="arguments">}}\r
2302 \describe{\r
2303 \item{\code{uuid}}{The UUID of the User in question.}\r
2304 }\r
2305 \if{html}{\out{</div>}}\r
2306 }\r
2307 }\r
2308 \if{html}{\out{<hr>}}\r
2309 \if{html}{\out{<a id="method-Arvados-users_create"></a>}}\r
2310 \if{latex}{\out{\hypertarget{method-Arvados-users_create}{}}}\r
2311 \subsection{Method \code{users_create()}}{\r
2312 users_create is a method defined in Arvados class.\r
2313 \subsection{Usage}{\r
2314 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_create(user, ensureUniqueName = "false", clusterID = NULL)}\if{html}{\out{</div>}}\r
2315 }\r
2316 \r
2317 \subsection{Arguments}{\r
2318 \if{html}{\out{<div class="arguments">}}\r
2319 \describe{\r
2320 \item{\code{user}}{User object.}\r
2321 \r
2322 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}\r
2323 \r
2324 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}\r
2325 }\r
2326 \if{html}{\out{</div>}}\r
2327 }\r
2328 }\r
2329 \if{html}{\out{<hr>}}\r
2330 \if{html}{\out{<a id="method-Arvados-users_update"></a>}}\r
2331 \if{latex}{\out{\hypertarget{method-Arvados-users_update}{}}}\r
2332 \subsection{Method \code{users_update()}}{\r
2333 users_update is a method defined in Arvados class.\r
2334 \subsection{Usage}{\r
2335 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_update(user, uuid, bypassFederation = NULL)}\if{html}{\out{</div>}}\r
2336 }\r
2337 \r
2338 \subsection{Arguments}{\r
2339 \if{html}{\out{<div class="arguments">}}\r
2340 \describe{\r
2341 \item{\code{user}}{User object.}\r
2342 \r
2343 \item{\code{uuid}}{The UUID of the User in question.}\r
2344 }\r
2345 \if{html}{\out{</div>}}\r
2346 }\r
2347 }\r
2348 \if{html}{\out{<hr>}}\r
2349 \if{html}{\out{<a id="method-Arvados-users_delete"></a>}}\r
2350 \if{latex}{\out{\hypertarget{method-Arvados-users_delete}{}}}\r
2351 \subsection{Method \code{users_delete()}}{\r
2352 users_delete is a method defined in Arvados class.\r
2353 \subsection{Usage}{\r
2354 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_delete(uuid)}\if{html}{\out{</div>}}\r
2355 }\r
2356 \r
2357 \subsection{Arguments}{\r
2358 \if{html}{\out{<div class="arguments">}}\r
2359 \describe{\r
2360 \item{\code{uuid}}{The UUID of the User in question.}\r
2361 }\r
2362 \if{html}{\out{</div>}}\r
2363 }\r
2364 }\r
2365 \if{html}{\out{<hr>}}\r
2366 \if{html}{\out{<a id="method-Arvados-users_current"></a>}}\r
2367 \if{latex}{\out{\hypertarget{method-Arvados-users_current}{}}}\r
2368 \subsection{Method \code{users_current()}}{\r
2369 users_current is a method defined in Arvados class.\r
2370 \subsection{Usage}{\r
2371 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_current()}\if{html}{\out{</div>}}\r
2372 }\r
2373 \r
2374 }\r
2375 \if{html}{\out{<hr>}}\r
2376 \if{html}{\out{<a id="method-Arvados-users_system"></a>}}\r
2377 \if{latex}{\out{\hypertarget{method-Arvados-users_system}{}}}\r
2378 \subsection{Method \code{users_system()}}{\r
2379 users_system is a method defined in Arvados class.\r
2380 \subsection{Usage}{\r
2381 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_system()}\if{html}{\out{</div>}}\r
2382 }\r
2383 \r
2384 }\r
2385 \if{html}{\out{<hr>}}\r
2386 \if{html}{\out{<a id="method-Arvados-users_activate"></a>}}\r
2387 \if{latex}{\out{\hypertarget{method-Arvados-users_activate}{}}}\r
2388 \subsection{Method \code{users_activate()}}{\r
2389 users_activate is a method defined in Arvados class.\r
2390 \subsection{Usage}{\r
2391 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_activate(uuid)}\if{html}{\out{</div>}}\r
2392 }\r
2393 \r
2394 \subsection{Arguments}{\r
2395 \if{html}{\out{<div class="arguments">}}\r
2396 \describe{\r
2397 \item{\code{uuid}}{The UUID of the User in question.}\r
2398 }\r
2399 \if{html}{\out{</div>}}\r
2400 }\r
2401 }\r
2402 \if{html}{\out{<hr>}}\r
2403 \if{html}{\out{<a id="method-Arvados-users_setup"></a>}}\r
2404 \if{latex}{\out{\hypertarget{method-Arvados-users_setup}{}}}\r
2405 \subsection{Method \code{users_setup()}}{\r
2406 users_setup is a method defined in Arvados class.\r
2407 \subsection{Usage}{\r
2408 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_setup(\r
2409   uuid = NULL,\r
2410   user = NULL,\r
2411   repo_name = NULL,\r
2412   vm_uuid = NULL,\r
2413   send_notification_email = "false"\r
2414 )}\if{html}{\out{</div>}}\r
2415 }\r
2416 \r
2417 }\r
2418 \if{html}{\out{<hr>}}\r
2419 \if{html}{\out{<a id="method-Arvados-users_unsetup"></a>}}\r
2420 \if{latex}{\out{\hypertarget{method-Arvados-users_unsetup}{}}}\r
2421 \subsection{Method \code{users_unsetup()}}{\r
2422 users_unsetup is a method defined in Arvados class.\r
2423 \subsection{Usage}{\r
2424 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_unsetup(uuid)}\if{html}{\out{</div>}}\r
2425 }\r
2426 \r
2427 \subsection{Arguments}{\r
2428 \if{html}{\out{<div class="arguments">}}\r
2429 \describe{\r
2430 \item{\code{uuid}}{The UUID of the User in question.}\r
2431 }\r
2432 \if{html}{\out{</div>}}\r
2433 }\r
2434 }\r
2435 \if{html}{\out{<hr>}}\r
2436 \if{html}{\out{<a id="method-Arvados-users_merge"></a>}}\r
2437 \if{latex}{\out{\hypertarget{method-Arvados-users_merge}{}}}\r
2438 \subsection{Method \code{users_merge()}}{\r
2439 users_merge is a method defined in Arvados class.\r
2440 \subsection{Usage}{\r
2441 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_merge(\r
2442   newOwnerUUID,\r
2443   newUserToken = NULL,\r
2444   redirectToNewUser = NULL,\r
2445   oldUserUUID = NULL,\r
2446   newUserUUID = NULL\r
2447 )}\if{html}{\out{</div>}}\r
2448 }\r
2449 \r
2450 }\r
2451 \if{html}{\out{<hr>}}\r
2452 \if{html}{\out{<a id="method-Arvados-users_list"></a>}}\r
2453 \if{latex}{\out{\hypertarget{method-Arvados-users_list}{}}}\r
2454 \subsection{Method \code{users_list()}}{\r
2455 users_list is a method defined in Arvados class.\r
2456 \subsection{Usage}{\r
2457 \if{html}{\out{<div class="r">}}\preformatted{Arvados$users_list(\r
2458   filters = NULL,\r
2459   where = NULL,\r
2460   order = NULL,\r
2461   select = NULL,\r
2462   distinct = NULL,\r
2463   limit = "100",\r
2464   offset = "0",\r
2465   count = "exact",\r
2466   clusterID = NULL,\r
2467   bypassFederation = NULL\r
2468 )}\if{html}{\out{</div>}}\r
2469 }\r
2470 \r
2471 \subsection{Arguments}{\r
2472 \if{html}{\out{<div class="arguments">}}\r
2473 \describe{\r
2474 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}\r
2475 \r
2476 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}\r
2477 }\r
2478 \if{html}{\out{</div>}}\r
2479 }\r
2480 }\r
2481 \if{html}{\out{<hr>}}\r
2482 \if{html}{\out{<a id="method-Arvados-repositories_get"></a>}}\r
2483 \if{latex}{\out{\hypertarget{method-Arvados-repositories_get}{}}}\r
2484 \subsection{Method \code{repositories_get()}}{\r
2485 repositories_get is a method defined in Arvados class.\r
2486 \subsection{Usage}{\r
2487 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_get(uuid)}\if{html}{\out{</div>}}\r
2488 }\r
2489 \r
2490 \subsection{Arguments}{\r
2491 \if{html}{\out{<div class="arguments">}}\r
2492 \describe{\r
2493 \item{\code{uuid}}{The UUID of the Repository in question.}\r
2494 }\r
2495 \if{html}{\out{</div>}}\r
2496 }\r
2497 }\r
2498 \if{html}{\out{<hr>}}\r
2499 \if{html}{\out{<a id="method-Arvados-repositories_create"></a>}}\r
2500 \if{latex}{\out{\hypertarget{method-Arvados-repositories_create}{}}}\r
2501 \subsection{Method \code{repositories_create()}}{\r
2502 repositories_create is a method defined in Arvados class.\r
2503 \subsection{Usage}{\r
2504 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_create(\r
2505   repository,\r
2506   ensureUniqueName = "false",\r
2507   clusterID = NULL\r
2508 )}\if{html}{\out{</div>}}\r
2509 }\r
2510 \r
2511 \subsection{Arguments}{\r
2512 \if{html}{\out{<div class="arguments">}}\r
2513 \describe{\r
2514 \item{\code{repository}}{Repository object.}\r
2515 \r
2516 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}\r
2517 \r
2518 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}\r
2519 }\r
2520 \if{html}{\out{</div>}}\r
2521 }\r
2522 }\r
2523 \if{html}{\out{<hr>}}\r
2524 \if{html}{\out{<a id="method-Arvados-repositories_update"></a>}}\r
2525 \if{latex}{\out{\hypertarget{method-Arvados-repositories_update}{}}}\r
2526 \subsection{Method \code{repositories_update()}}{\r
2527 repositories_update is a method defined in Arvados class.\r
2528 \subsection{Usage}{\r
2529 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_update(repository, uuid)}\if{html}{\out{</div>}}\r
2530 }\r
2531 \r
2532 \subsection{Arguments}{\r
2533 \if{html}{\out{<div class="arguments">}}\r
2534 \describe{\r
2535 \item{\code{repository}}{Repository object.}\r
2536 \r
2537 \item{\code{uuid}}{The UUID of the Repository in question.}\r
2538 }\r
2539 \if{html}{\out{</div>}}\r
2540 }\r
2541 }\r
2542 \if{html}{\out{<hr>}}\r
2543 \if{html}{\out{<a id="method-Arvados-repositories_delete"></a>}}\r
2544 \if{latex}{\out{\hypertarget{method-Arvados-repositories_delete}{}}}\r
2545 \subsection{Method \code{repositories_delete()}}{\r
2546 repositories_delete is a method defined in Arvados class.\r
2547 \subsection{Usage}{\r
2548 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_delete(uuid)}\if{html}{\out{</div>}}\r
2549 }\r
2550 \r
2551 \subsection{Arguments}{\r
2552 \if{html}{\out{<div class="arguments">}}\r
2553 \describe{\r
2554 \item{\code{uuid}}{The UUID of the Repository in question.}\r
2555 }\r
2556 \if{html}{\out{</div>}}\r
2557 }\r
2558 }\r
2559 \if{html}{\out{<hr>}}\r
2560 \if{html}{\out{<a id="method-Arvados-repositories_get_all_permissions"></a>}}\r
2561 \if{latex}{\out{\hypertarget{method-Arvados-repositories_get_all_permissions}{}}}\r
2562 \subsection{Method \code{repositories_get_all_permissions()}}{\r
2563 repositories_get_all_permissions is a method defined in Arvados class.\r
2564 \subsection{Usage}{\r
2565 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_get_all_permissions()}\if{html}{\out{</div>}}\r
2566 }\r
2567 \r
2568 }\r
2569 \if{html}{\out{<hr>}}\r
2570 \if{html}{\out{<a id="method-Arvados-repositories_list"></a>}}\r
2571 \if{latex}{\out{\hypertarget{method-Arvados-repositories_list}{}}}\r
2572 \subsection{Method \code{repositories_list()}}{\r
2573 repositories_list is a method defined in Arvados class.\r
2574 \subsection{Usage}{\r
2575 \if{html}{\out{<div class="r">}}\preformatted{Arvados$repositories_list(\r
2576   filters = NULL,\r
2577   where = NULL,\r
2578   order = NULL,\r
2579   select = NULL,\r
2580   distinct = NULL,\r
2581   limit = "100",\r
2582   offset = "0",\r
2583   count = "exact",\r
2584   clusterID = NULL,\r
2585   bypassFederation = NULL\r
2586 )}\if{html}{\out{</div>}}\r
2587 }\r
2588 \r
2589 \subsection{Arguments}{\r
2590 \if{html}{\out{<div class="arguments">}}\r
2591 \describe{\r
2592 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}\r
2593 \r
2594 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}\r
2595 }\r
2596 \if{html}{\out{</div>}}\r
2597 }\r
2598 }\r
2599 \if{html}{\out{<hr>}}\r
2600 \if{html}{\out{<a id="method-Arvados-virtual_machines_get"></a>}}\r
2601 \if{latex}{\out{\hypertarget{method-Arvados-virtual_machines_get}{}}}\r
2602 \subsection{Method \code{virtual_machines_get()}}{\r
2603 virtual_machines_get is a method defined in Arvados class.\r
2604 \subsection{Usage}{\r
2605 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_get(uuid)}\if{html}{\out{</div>}}\r
2606 }\r
2607 \r
2608 \subsection{Arguments}{\r
2609 \if{html}{\out{<div class="arguments">}}\r
2610 \describe{\r
2611 \item{\code{uuid}}{The UUID of the virtualMachine in question.}\r
2612 }\r
2613 \if{html}{\out{</div>}}\r
2614 }\r
2615 }\r
2616 \if{html}{\out{<hr>}}\r
2617 \if{html}{\out{<a id="method-Arvados-virtual_machines_create"></a>}}\r
2618 \if{latex}{\out{\hypertarget{method-Arvados-virtual_machines_create}{}}}\r
2619 \subsection{Method \code{virtual_machines_create()}}{\r
2620 virtual_machines_create is a method defined in Arvados class.\r
2621 \subsection{Usage}{\r
2622 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_create(\r
2623   virtualMachine,\r
2624   ensureUniqueName = "false",\r
2625   clusterID = NULL\r
2626 )}\if{html}{\out{</div>}}\r
2627 }\r
2628 \r
2629 \subsection{Arguments}{\r
2630 \if{html}{\out{<div class="arguments">}}\r
2631 \describe{\r
2632 \item{\code{virtualMachine}}{virtualMachine object.}\r
2633 \r
2634 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}\r
2635 \r
2636 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}\r
2637 }\r
2638 \if{html}{\out{</div>}}\r
2639 }\r
2640 }\r
2641 \if{html}{\out{<hr>}}\r
2642 \if{html}{\out{<a id="method-Arvados-virtual_machines_update"></a>}}\r
2643 \if{latex}{\out{\hypertarget{method-Arvados-virtual_machines_update}{}}}\r
2644 \subsection{Method \code{virtual_machines_update()}}{\r
2645 virtual_machines_update is a method defined in Arvados class.\r
2646 \subsection{Usage}{\r
2647 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_update(virtualMachine, uuid)}\if{html}{\out{</div>}}\r
2648 }\r
2649 \r
2650 \subsection{Arguments}{\r
2651 \if{html}{\out{<div class="arguments">}}\r
2652 \describe{\r
2653 \item{\code{virtualMachine}}{virtualMachine object.}\r
2654 \r
2655 \item{\code{uuid}}{The UUID of the virtualMachine in question.}\r
2656 }\r
2657 \if{html}{\out{</div>}}\r
2658 }\r
2659 }\r
2660 \if{html}{\out{<hr>}}\r
2661 \if{html}{\out{<a id="method-Arvados-virtual_machines_delete"></a>}}\r
2662 \if{latex}{\out{\hypertarget{method-Arvados-virtual_machines_delete}{}}}\r
2663 \subsection{Method \code{virtual_machines_delete()}}{\r
2664 virtual_machines_delete is a method defined in Arvados class.\r
2665 \subsection{Usage}{\r
2666 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_delete(uuid)}\if{html}{\out{</div>}}\r
2667 }\r
2668 \r
2669 \subsection{Arguments}{\r
2670 \if{html}{\out{<div class="arguments">}}\r
2671 \describe{\r
2672 \item{\code{uuid}}{The UUID of the virtualMachine in question.}\r
2673 }\r
2674 \if{html}{\out{</div>}}\r
2675 }\r
2676 }\r
2677 \if{html}{\out{<hr>}}\r
2678 \if{html}{\out{<a id="method-Arvados-virtual_machines_logins"></a>}}\r
2679 \if{latex}{\out{\hypertarget{method-Arvados-virtual_machines_logins}{}}}\r
2680 \subsection{Method \code{virtual_machines_logins()}}{\r
2681 virtual_machines_logins is a method defined in Arvados class.\r
2682 \subsection{Usage}{\r
2683 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_logins(uuid)}\if{html}{\out{</div>}}\r
2684 }\r
2685 \r
2686 \subsection{Arguments}{\r
2687 \if{html}{\out{<div class="arguments">}}\r
2688 \describe{\r
2689 \item{\code{uuid}}{The UUID of the virtualMachine in question.}\r
2690 }\r
2691 \if{html}{\out{</div>}}\r
2692 }\r
2693 }\r
2694 \if{html}{\out{<hr>}}\r
2695 \if{html}{\out{<a id="method-Arvados-virtual_machines_get_all_logins"></a>}}\r
2696 \if{latex}{\out{\hypertarget{method-Arvados-virtual_machines_get_all_logins}{}}}\r
2697 \subsection{Method \code{virtual_machines_get_all_logins()}}{\r
2698 virtual_machines_get_all_logins is a method defined in Arvados class.\r
2699 \subsection{Usage}{\r
2700 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_get_all_logins()}\if{html}{\out{</div>}}\r
2701 }\r
2702 \r
2703 }\r
2704 \if{html}{\out{<hr>}}\r
2705 \if{html}{\out{<a id="method-Arvados-virtual_machines_list"></a>}}\r
2706 \if{latex}{\out{\hypertarget{method-Arvados-virtual_machines_list}{}}}\r
2707 \subsection{Method \code{virtual_machines_list()}}{\r
2708 virtual_machines_list is a method defined in Arvados class.\r
2709 \subsection{Usage}{\r
2710 \if{html}{\out{<div class="r">}}\preformatted{Arvados$virtual_machines_list(\r
2711   filters = NULL,\r
2712   where = NULL,\r
2713   order = NULL,\r
2714   select = NULL,\r
2715   distinct = NULL,\r
2716   limit = "100",\r
2717   offset = "0",\r
2718   count = "exact",\r
2719   clusterID = NULL,\r
2720   bypassFederation = NULL\r
2721 )}\if{html}{\out{</div>}}\r
2722 }\r
2723 \r
2724 \subsection{Arguments}{\r
2725 \if{html}{\out{<div class="arguments">}}\r
2726 \describe{\r
2727 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}\r
2728 \r
2729 \item{\code{bypassFederation}}{bypass federation behavior, list items from local instance database only}\r
2730 }\r
2731 \if{html}{\out{</div>}}\r
2732 }\r
2733 }\r
2734 \if{html}{\out{<hr>}}\r
2735 \if{html}{\out{<a id="method-Arvados-workflows_get"></a>}}\r
2736 \if{latex}{\out{\hypertarget{method-Arvados-workflows_get}{}}}\r
2737 \subsection{Method \code{workflows_get()}}{\r
2738 workflows_get is a method defined in Arvados class.\r
2739 \subsection{Usage}{\r
2740 \if{html}{\out{<div class="r">}}\preformatted{Arvados$workflows_get(uuid)}\if{html}{\out{</div>}}\r
2741 }\r
2742 \r
2743 \subsection{Arguments}{\r
2744 \if{html}{\out{<div class="arguments">}}\r
2745 \describe{\r
2746 \item{\code{uuid}}{The UUID of the Workflow in question.}\r
2747 }\r
2748 \if{html}{\out{</div>}}\r
2749 }\r
2750 }\r
2751 \if{html}{\out{<hr>}}\r
2752 \if{html}{\out{<a id="method-Arvados-workflows_create"></a>}}\r
2753 \if{latex}{\out{\hypertarget{method-Arvados-workflows_create}{}}}\r
2754 \subsection{Method \code{workflows_create()}}{\r
2755 workflows_create is a method defined in Arvados class.\r
2756 \subsection{Usage}{\r
2757 \if{html}{\out{<div class="r">}}\preformatted{Arvados$workflows_create(\r
2758   workflow,\r
2759   ensureUniqueName = "false",\r
2760   clusterID = NULL\r
2761 )}\if{html}{\out{</div>}}\r
2762 }\r
2763 \r
2764 \subsection{Arguments}{\r
2765 \if{html}{\out{<div class="arguments">}}\r
2766 \describe{\r
2767 \item{\code{workflow}}{Workflow object.}\r
2768 \r
2769 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}\r
2770 \r
2771 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}\r
2772 }\r
2773 \if{html}{\out{</div>}}\r
2774 }\r
2775 }\r
2776 \if{html}{\out{<hr>}}\r
2777 \if{html}{\out{<a id="method-Arvados-workflows_update"></a>}}\r
2778 \if{latex}{\out{\hypertarget{method-Arvados-workflows_update}{}}}\r
2779 \subsection{Method \code{workflows_update()}}{\r
2780 workflows_update is a method defined in Arvados class.\r
2781 \subsection{Usage}{\r
2782 \if{html}{\out{<div class="r">}}\preformatted{Arvados$workflows_update(workflow, uuid)}\if{html}{\out{</div>}}\r
2783 }\r
2784 \r
2785 \subsection{Arguments}{\r
2786 \if{html}{\out{<div class="arguments">}}\r
2787 \describe{\r
2788 \item{\code{workflow}}{Workflow object.}\r
2789 \r
2790 \item{\code{uuid}}{The UUID of the Workflow in question.}\r
2791 }\r
2792 \if{html}{\out{</div>}}\r
2793 }\r
2794 }\r
2795 \if{html}{\out{<hr>}}\r
2796 \if{html}{\out{<a id="method-Arvados-workflows_delete"></a>}}\r
2797 \if{latex}{\out{\hypertarget{method-Arvados-workflows_delete}{}}}\r
2798 \subsection{Method \code{workflows_delete()}}{\r
2799 workflows_delete is a method defined in Arvados class.\r
2800 \subsection{Usage}{\r
2801 \if{html}{\out{<div class="r">}}\preformatted{Arvados$workflows_delete(uuid)}\if{html}{\out{</div>}}\r
2802 }\r
2803 \r
2804 \subsection{Arguments}{\r
2805 \if{html}{\out{<div class="arguments">}}\r
2806 \describe{\r
2807 \item{\code{uuid}}{The UUID of the Workflow in question.}\r
2808 }\r
2809 \if{html}{\out{</div>}}\r
2810 }\r
2811 }\r
2812 \if{html}{\out{<hr>}}\r
2813 \if{html}{\out{<a id="method-Arvados-workflows_list"></a>}}\r
2814 \if{latex}{\out{\hypertarget{method-Arvados-workflows_list}{}}}\r
2815 \subsection{Method \code{workflows_list()}}{\r
2816 workflows_list is a method defined in Arvados class.\r
2817 \subsection{Usage}{\r
2818 \if{html}{\out{<div class="r">}}\preformatted{Arvados$workflows_list(\r
2819   filters = NULL,\r
2820   where = NULL,\r
2821   order = NULL,\r
2822   select = NULL,\r
2823   distinct = NULL,\r
2824   limit = "100",\r
2825   offset = "0",\r
2826   count = "exact",\r
2827   clusterID = NULL,\r
2828   bypassFederation = NULL\r
2829 )}\if{html}{\out{</div>}}\r
2830 }\r
2831 \r
2832 \subsection{Arguments}{\r
2833 \if{html}{\out{<div class="arguments">}}\r
2834 \describe{\r
2835 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}\r
2836 \r
2837 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}\r
2838 }\r
2839 \if{html}{\out{</div>}}\r
2840 }\r
2841 }\r
2842 \if{html}{\out{<hr>}}\r
2843 \if{html}{\out{<a id="method-Arvados-user_agreements_get"></a>}}\r
2844 \if{latex}{\out{\hypertarget{method-Arvados-user_agreements_get}{}}}\r
2845 \subsection{Method \code{user_agreements_get()}}{\r
2846 user_agreements_get is a method defined in Arvados class.\r
2847 \subsection{Usage}{\r
2848 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_get(uuid)}\if{html}{\out{</div>}}\r
2849 }\r
2850 \r
2851 \subsection{Arguments}{\r
2852 \if{html}{\out{<div class="arguments">}}\r
2853 \describe{\r
2854 \item{\code{uuid}}{The UUID of the userAgreement in question.}\r
2855 }\r
2856 \if{html}{\out{</div>}}\r
2857 }\r
2858 }\r
2859 \if{html}{\out{<hr>}}\r
2860 \if{html}{\out{<a id="method-Arvados-user_agreements_create"></a>}}\r
2861 \if{latex}{\out{\hypertarget{method-Arvados-user_agreements_create}{}}}\r
2862 \subsection{Method \code{user_agreements_create()}}{\r
2863 user_agreements_create is a method defined in Arvados class.\r
2864 \subsection{Usage}{\r
2865 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_create(\r
2866   userAgreement,\r
2867   ensureUniqueName = "false",\r
2868   clusterID = NULL\r
2869 )}\if{html}{\out{</div>}}\r
2870 }\r
2871 \r
2872 \subsection{Arguments}{\r
2873 \if{html}{\out{<div class="arguments">}}\r
2874 \describe{\r
2875 \item{\code{userAgreement}}{userAgreement object.}\r
2876 \r
2877 \item{\code{ensureUniqueName}}{Adjust name to ensure uniqueness instead of returning an error.}\r
2878 \r
2879 \item{\code{clusterID}}{Create object on a remote federated cluster instead of the current one.}\r
2880 }\r
2881 \if{html}{\out{</div>}}\r
2882 }\r
2883 }\r
2884 \if{html}{\out{<hr>}}\r
2885 \if{html}{\out{<a id="method-Arvados-user_agreements_update"></a>}}\r
2886 \if{latex}{\out{\hypertarget{method-Arvados-user_agreements_update}{}}}\r
2887 \subsection{Method \code{user_agreements_update()}}{\r
2888 user_agreements_update is a method defined in Arvados class.\r
2889 \subsection{Usage}{\r
2890 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_update(userAgreement, uuid)}\if{html}{\out{</div>}}\r
2891 }\r
2892 \r
2893 \subsection{Arguments}{\r
2894 \if{html}{\out{<div class="arguments">}}\r
2895 \describe{\r
2896 \item{\code{userAgreement}}{userAgreement object.}\r
2897 \r
2898 \item{\code{uuid}}{The UUID of the userAgreement in question.}\r
2899 }\r
2900 \if{html}{\out{</div>}}\r
2901 }\r
2902 }\r
2903 \if{html}{\out{<hr>}}\r
2904 \if{html}{\out{<a id="method-Arvados-user_agreements_delete"></a>}}\r
2905 \if{latex}{\out{\hypertarget{method-Arvados-user_agreements_delete}{}}}\r
2906 \subsection{Method \code{user_agreements_delete()}}{\r
2907 user_agreements_delete is a method defined in Arvados class.\r
2908 \subsection{Usage}{\r
2909 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_delete(uuid)}\if{html}{\out{</div>}}\r
2910 }\r
2911 \r
2912 \subsection{Arguments}{\r
2913 \if{html}{\out{<div class="arguments">}}\r
2914 \describe{\r
2915 \item{\code{uuid}}{The UUID of the userAgreement in question.}\r
2916 }\r
2917 \if{html}{\out{</div>}}\r
2918 }\r
2919 }\r
2920 \if{html}{\out{<hr>}}\r
2921 \if{html}{\out{<a id="method-Arvados-user_agreements_signatures"></a>}}\r
2922 \if{latex}{\out{\hypertarget{method-Arvados-user_agreements_signatures}{}}}\r
2923 \subsection{Method \code{user_agreements_signatures()}}{\r
2924 user_agreements_signatures is a method defined in Arvados class.\r
2925 \subsection{Usage}{\r
2926 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_signatures()}\if{html}{\out{</div>}}\r
2927 }\r
2928 \r
2929 }\r
2930 \if{html}{\out{<hr>}}\r
2931 \if{html}{\out{<a id="method-Arvados-user_agreements_sign"></a>}}\r
2932 \if{latex}{\out{\hypertarget{method-Arvados-user_agreements_sign}{}}}\r
2933 \subsection{Method \code{user_agreements_sign()}}{\r
2934 user_agreements_sign is a method defined in Arvados class.\r
2935 \subsection{Usage}{\r
2936 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_sign()}\if{html}{\out{</div>}}\r
2937 }\r
2938 \r
2939 }\r
2940 \if{html}{\out{<hr>}}\r
2941 \if{html}{\out{<a id="method-Arvados-user_agreements_list"></a>}}\r
2942 \if{latex}{\out{\hypertarget{method-Arvados-user_agreements_list}{}}}\r
2943 \subsection{Method \code{user_agreements_list()}}{\r
2944 user_agreements_list is a method defined in Arvados class.\r
2945 \subsection{Usage}{\r
2946 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_list(\r
2947   filters = NULL,\r
2948   where = NULL,\r
2949   order = NULL,\r
2950   select = NULL,\r
2951   distinct = NULL,\r
2952   limit = "100",\r
2953   offset = "0",\r
2954   count = "exact",\r
2955   clusterID = NULL,\r
2956   bypassFederation = NULL\r
2957 )}\if{html}{\out{</div>}}\r
2958 }\r
2959 \r
2960 \subsection{Arguments}{\r
2961 \if{html}{\out{<div class="arguments">}}\r
2962 \describe{\r
2963 \item{\code{clusterID}}{List objects on a remote federated cluster instead of the current one.}\r
2964 \r
2965 \item{\code{bypassFederation}}{Bypass federation behavior, list items from local instance database only.}\r
2966 }\r
2967 \if{html}{\out{</div>}}\r
2968 }\r
2969 }\r
2970 \if{html}{\out{<hr>}}\r
2971 \if{html}{\out{<a id="method-Arvados-user_agreements_new"></a>}}\r
2972 \if{latex}{\out{\hypertarget{method-Arvados-user_agreements_new}{}}}\r
2973 \subsection{Method \code{user_agreements_new()}}{\r
2974 user_agreements_new is a method defined in Arvados class.\r
2975 \subsection{Usage}{\r
2976 \if{html}{\out{<div class="r">}}\preformatted{Arvados$user_agreements_new()}\if{html}{\out{</div>}}\r
2977 }\r
2978 \r
2979 }\r
2980 \if{html}{\out{<hr>}}\r
2981 \if{html}{\out{<a id="method-Arvados-configs_get"></a>}}\r
2982 \if{latex}{\out{\hypertarget{method-Arvados-configs_get}{}}}\r
2983 \subsection{Method \code{configs_get()}}{\r
2984 configs_get is a method defined in Arvados class.\r
2985 \subsection{Usage}{\r
2986 \if{html}{\out{<div class="r">}}\preformatted{Arvados$configs_get()}\if{html}{\out{</div>}}\r
2987 }\r
2988 \r
2989 }\r
2990 \if{html}{\out{<hr>}}\r
2991 \if{html}{\out{<a id="method-Arvados-getHostName"></a>}}\r
2992 \if{latex}{\out{\hypertarget{method-Arvados-getHostName}{}}}\r
2993 \subsection{Method \code{getHostName()}}{\r
2994 \subsection{Usage}{\r
2995 \if{html}{\out{<div class="r">}}\preformatted{Arvados$getHostName()}\if{html}{\out{</div>}}\r
2996 }\r
2997 \r
2998 }\r
2999 \if{html}{\out{<hr>}}\r
3000 \if{html}{\out{<a id="method-Arvados-getToken"></a>}}\r
3001 \if{latex}{\out{\hypertarget{method-Arvados-getToken}{}}}\r
3002 \subsection{Method \code{getToken()}}{\r
3003 \subsection{Usage}{\r
3004 \if{html}{\out{<div class="r">}}\preformatted{Arvados$getToken()}\if{html}{\out{</div>}}\r
3005 }\r
3006 \r
3007 }\r
3008 \if{html}{\out{<hr>}}\r
3009 \if{html}{\out{<a id="method-Arvados-setRESTService"></a>}}\r
3010 \if{latex}{\out{\hypertarget{method-Arvados-setRESTService}{}}}\r
3011 \subsection{Method \code{setRESTService()}}{\r
3012 \subsection{Usage}{\r
3013 \if{html}{\out{<div class="r">}}\preformatted{Arvados$setRESTService(newREST)}\if{html}{\out{</div>}}\r
3014 }\r
3015 \r
3016 }\r
3017 \if{html}{\out{<hr>}}\r
3018 \if{html}{\out{<a id="method-Arvados-getRESTService"></a>}}\r
3019 \if{latex}{\out{\hypertarget{method-Arvados-getRESTService}{}}}\r
3020 \subsection{Method \code{getRESTService()}}{\r
3021 \subsection{Usage}{\r
3022 \if{html}{\out{<div class="r">}}\preformatted{Arvados$getRESTService()}\if{html}{\out{</div>}}\r
3023 }\r
3024 \r
3025 }\r
3026 }\r