sdk/R/man/Arvados.Rd

   1 % Generated by roxygen2: do not edit by hand
   2 % Please edit documentation in R/Arvados.R
   3 \name{Arvados}
   4 \alias{Arvados}
   5 \title{Arvados}
   6 \description{
   7 Arvados class gives users ability to access Arvados REST API.
   8 }
   9 \section{Usage}{
  10
  11 \preformatted{arv = Arvados$new(authToken = NULL, hostName = NULL, numRetries = 0)}
  12 }
  13
  14 \section{Arguments}{
  15
  16 \describe{
  17         \item{authToken}{Authentification token. If not specified ARVADOS_API_TOKEN environment variable will be used.}
  18         \item{hostName}{Host name. If not specified ARVADOS_API_HOST environment variable will be used.}
  19         \item{numRetries}{Number which specifies how many times to retry failed service requests.}
  20 }
  21 }
  22
  23 \section{Methods}{
  24
  25 \describe{
  26         \item{}{\code{\link{api_client_authorizations.create}}}
  27         \item{}{\code{\link{api_client_authorizations.create_system_auth}}}
  28         \item{}{\code{\link{api_client_authorizations.current}}}
  29         \item{}{\code{\link{api_client_authorizations.delete}}}
  30         \item{}{\code{\link{api_client_authorizations.get}}}
  31         \item{}{\code{\link{api_client_authorizations.list}}}
  32         \item{}{\code{\link{api_client_authorizations.update}}}
  33         \item{}{\code{\link{api_clients.create}}}
  34         \item{}{\code{\link{api_clients.delete}}}
  35         \item{}{\code{\link{api_clients.get}}}
  36         \item{}{\code{\link{api_clients.list}}}
  37         \item{}{\code{\link{api_clients.update}}}
  38         \item{}{\code{\link{authorized_keys.create}}}
  39         \item{}{\code{\link{authorized_keys.delete}}}
  40         \item{}{\code{\link{authorized_keys.get}}}
  41         \item{}{\code{\link{authorized_keys.list}}}
  42         \item{}{\code{\link{authorized_keys.update}}}
  43         \item{}{\code{\link{collections.create}}}
  44         \item{}{\code{\link{collections.delete}}}
  45         \item{}{\code{\link{collections.get}}}
  46         \item{}{\code{\link{collections.list}}}
  47         \item{}{\code{\link{collections.provenance}}}
  48         \item{}{\code{\link{collections.trash}}}
  49         \item{}{\code{\link{collections.untrash}}}
  50         \item{}{\code{\link{collections.update}}}
  51         \item{}{\code{\link{collections.used_by}}}
  52         \item{}{\code{\link{container_requests.create}}}
  53         \item{}{\code{\link{container_requests.delete}}}
  54         \item{}{\code{\link{container_requests.get}}}
  55         \item{}{\code{\link{container_requests.list}}}
  56         \item{}{\code{\link{container_requests.update}}}
  57         \item{}{\code{\link{containers.auth}}}
  58         \item{}{\code{\link{containers.create}}}
  59         \item{}{\code{\link{containers.current}}}
  60         \item{}{\code{\link{containers.delete}}}
  61         \item{}{\code{\link{containers.get}}}
  62         \item{}{\code{\link{containers.list}}}
  63         \item{}{\code{\link{containers.lock}}}
  64         \item{}{\code{\link{containers.secret_mounts}}}
  65         \item{}{\code{\link{containers.unlock}}}
  66         \item{}{\code{\link{containers.update}}}
  67         \item{}{\code{\link{groups.contents}}}
  68         \item{}{\code{\link{groups.create}}}
  69         \item{}{\code{\link{groups.delete}}}
  70         \item{}{\code{\link{groups.get}}}
  71         \item{}{\code{\link{groups.list}}}
  72         \item{}{\code{\link{groups.trash}}}
  73         \item{}{\code{\link{groups.untrash}}}
  74         \item{}{\code{\link{groups.update}}}
  75         \item{}{\code{\link{humans.create}}}
  76         \item{}{\code{\link{humans.delete}}}
  77         \item{}{\code{\link{humans.get}}}
  78         \item{}{\code{\link{humans.list}}}
  79         \item{}{\code{\link{humans.update}}}
  80         \item{}{\code{\link{jobs.cancel}}}
  81         \item{}{\code{\link{jobs.create}}}
  82         \item{}{\code{\link{jobs.delete}}}
  83         \item{}{\code{\link{jobs.get}}}
  84         \item{}{\code{\link{jobs.list}}}
  85         \item{}{\code{\link{jobs.lock}}}
  86         \item{}{\code{\link{jobs.queue}}}
  87         \item{}{\code{\link{jobs.queue_size}}}
  88         \item{}{\code{\link{jobs.update}}}
  89         \item{}{\code{\link{job_tasks.create}}}
  90         \item{}{\code{\link{job_tasks.delete}}}
  91         \item{}{\code{\link{job_tasks.get}}}
  92         \item{}{\code{\link{job_tasks.list}}}
  93         \item{}{\code{\link{job_tasks.update}}}
  94         \item{}{\code{\link{keep_disks.create}}}
  95         \item{}{\code{\link{keep_disks.delete}}}
  96         \item{}{\code{\link{keep_disks.get}}}
  97         \item{}{\code{\link{keep_disks.list}}}
  98         \item{}{\code{\link{keep_disks.ping}}}
  99         \item{}{\code{\link{keep_disks.update}}}
 100         \item{}{\code{\link{keep_services.accessible}}}
 101         \item{}{\code{\link{keep_services.create}}}
 102         \item{}{\code{\link{keep_services.delete}}}
 103         \item{}{\code{\link{keep_services.get}}}
 104         \item{}{\code{\link{keep_services.list}}}
 105         \item{}{\code{\link{keep_services.update}}}
 106         \item{}{\code{\link{links.create}}}
 107         \item{}{\code{\link{links.delete}}}
 108         \item{}{\code{\link{links.get}}}
 109         \item{}{\code{\link{links.get_permissions}}}
 110         \item{}{\code{\link{links.list}}}
 111         \item{}{\code{\link{links.update}}}
 112         \item{}{\code{\link{logs.create}}}
 113         \item{}{\code{\link{logs.delete}}}
 114         \item{}{\code{\link{logs.get}}}
 115         \item{}{\code{\link{logs.list}}}
 116         \item{}{\code{\link{logs.update}}}
 117         \item{}{\code{\link{nodes.create}}}
 118         \item{}{\code{\link{nodes.delete}}}
 119         \item{}{\code{\link{nodes.get}}}
 120         \item{}{\code{\link{nodes.list}}}
 121         \item{}{\code{\link{nodes.ping}}}
 122         \item{}{\code{\link{nodes.update}}}
 123         \item{}{\code{\link{pipeline_instances.cancel}}}
 124         \item{}{\code{\link{pipeline_instances.create}}}
 125         \item{}{\code{\link{pipeline_instances.delete}}}
 126         \item{}{\code{\link{pipeline_instances.get}}}
 127         \item{}{\code{\link{pipeline_instances.list}}}
 128         \item{}{\code{\link{pipeline_instances.update}}}
 129         \item{}{\code{\link{pipeline_templates.create}}}
 130         \item{}{\code{\link{pipeline_templates.delete}}}
 131         \item{}{\code{\link{pipeline_templates.get}}}
 132         \item{}{\code{\link{pipeline_templates.list}}}
 133         \item{}{\code{\link{pipeline_templates.update}}}
 134         \item{}{\code{\link{projects.create}}}
 135         \item{}{\code{\link{projects.delete}}}
 136         \item{}{\code{\link{projects.get}}}
 137         \item{}{\code{\link{projects.list}}}
 138         \item{}{\code{\link{projects.update}}}
 139         \item{}{\code{\link{repositories.create}}}
 140         \item{}{\code{\link{repositories.delete}}}
 141         \item{}{\code{\link{repositories.get}}}
 142         \item{}{\code{\link{repositories.get_all_permissions}}}
 143         \item{}{\code{\link{repositories.list}}}
 144         \item{}{\code{\link{repositories.update}}}
 145         \item{}{\code{\link{specimens.create}}}
 146         \item{}{\code{\link{specimens.delete}}}
 147         \item{}{\code{\link{specimens.get}}}
 148         \item{}{\code{\link{specimens.list}}}
 149         \item{}{\code{\link{specimens.update}}}
 150         \item{}{\code{\link{traits.create}}}
 151         \item{}{\code{\link{traits.delete}}}
 152         \item{}{\code{\link{traits.get}}}
 153         \item{}{\code{\link{traits.list}}}
 154         \item{}{\code{\link{traits.update}}}
 155         \item{}{\code{\link{user_agreements.create}}}
 156         \item{}{\code{\link{user_agreements.delete}}}
 157         \item{}{\code{\link{user_agreements.get}}}
 158         \item{}{\code{\link{user_agreements.list}}}
 159         \item{}{\code{\link{user_agreements.new}}}
 160         \item{}{\code{\link{user_agreements.sign}}}
 161         \item{}{\code{\link{user_agreements.signatures}}}
 162         \item{}{\code{\link{user_agreements.update}}}
 163         \item{}{\code{\link{users.activate}}}
 164         \item{}{\code{\link{users.create}}}
 165         \item{}{\code{\link{users.current}}}
 166         \item{}{\code{\link{users.delete}}}
 167         \item{}{\code{\link{users.get}}}
 168         \item{}{\code{\link{users.list}}}
 169         \item{}{\code{\link{users.merge}}}
 170         \item{}{\code{\link{users.setup}}}
 171         \item{}{\code{\link{users.system}}}
 172         \item{}{\code{\link{users.unsetup}}}
 173         \item{}{\code{\link{users.update}}}
 174         \item{}{\code{\link{virtual_machines.create}}}
 175         \item{}{\code{\link{virtual_machines.delete}}}
 176         \item{}{\code{\link{virtual_machines.get}}}
 177         \item{}{\code{\link{virtual_machines.get_all_logins}}}
 178         \item{}{\code{\link{virtual_machines.list}}}
 179         \item{}{\code{\link{virtual_machines.logins}}}
 180         \item{}{\code{\link{virtual_machines.update}}}
 181         \item{}{\code{\link{workflows.create}}}
 182         \item{}{\code{\link{workflows.delete}}}
 183         \item{}{\code{\link{workflows.get}}}
 184         \item{}{\code{\link{workflows.list}}}
 185         \item{}{\code{\link{workflows.update}}}
 186 }
 187 }
 188
 189 \examples{
 190 \dontrun{
 191 arv <- Arvados$new("your Arvados token", "example.arvadosapi.com")
 192
 193 collection <- arv$collections.get("uuid")
 194
 195 collectionList <- arv$collections.list(list(list("name", "like", "Test\%")))
 196 collectionList <- listAll(arv$collections.list, list(list("name", "like", "Test\%")))
 197
 198 deletedCollection <- arv$collections.delete("uuid")
 199
 200 updatedCollection <- arv$collections.update(list(name = "New name", description = "New description"),
 201                                             "uuid")
 202
 203 createdCollection <- arv$collections.create(list(name = "Example",
 204                                                  description = "This is a test collection"))
 205 }
 206 }