doc/api/schema/Collection.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: api
   4 navmenu: Schema
   5 title: Collection
   6
   7 ...
   8
   9 Note: This resource concerns indexing, usage accounting, and integrity checks for data stored in Arvados. Reading and writing the data _per se_ is achieved by the "Keep":{{site.baseurl}}/user/tutorials/tutorial-keep.html storage system.
  10
  11 h2. Methods
  12
  13 See "collections":{{site.baseurl}}/api/methods/collections.html
  14
  15 h3. Conditions of creating a Collection
  16
  17 The @uuid@ and @manifest_text@ attributes must be provided when creating a Collection. The cryptographic digest of the supplied @manifest_text@ must match the supplied @uuid@.
  18
  19 h3. Side effects of creating a Collection
  20
  21 Referenced data can be protected from garbage collection. See the section about "resources" links on the "Links":Link.html page.
  22
  23 Data can be shared with other users via the Arvados permission model.
  24
  25 Clients can request checks of data integrity and storage redundancy.
  26
  27 h2. Resource
  28
  29 Each collection has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html:
  30
  31 table(table table-bordered table-condensed).
  32 |_. Attribute|_. Type|_. Description|_. Example|
  33 |name|string|||
  34 |description|text|||
  35 |portable_data_hash|string|||
  36 |manifest_text|text|||
  37 |replication_desired|number|Minimum storage replication level desired for each data block referenced by this collection. A value of @null@ signifies that the site default replication level (typically 2) is desired.|@2@|
  38 |replication_confirmed|number|Replication level most recently confirmed by the storage system. This field is null when a collection is first created, and is reset to null when the manifest_text changes in a way that introduces a new data block. An integer value indicates the replication level of the _least replicated_ data block in the collection.|@2@, null|
  39 |replication_confirmed_at|datetime|When replication_confirmed was confirmed. If replication_confirmed is null, this field is also null.||