X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/35336cd73e444534cb2eda20e3730464cc4e6553..3598c3003a7987cca5c0536ba8206ec40c1c3649:/doc/api/schema/Collection.html.textile.liquid diff --git a/doc/api/schema/Collection.html.textile.liquid b/doc/api/schema/Collection.html.textile.liquid index ff08d816db..9aa783cbf5 100644 --- a/doc/api/schema/Collection.html.textile.liquid +++ b/doc/api/schema/Collection.html.textile.liquid @@ -6,16 +6,11 @@ title: Collection ... - - -This resource concerns metadata, usage accounting, and integrity checks for data stored on the cloud. Reading and writing the data _per se_ is achieved by the "Keep":/user/tutorials/tutorial-keep.html storage system. - +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. h2. Methods -See "REST methods for working with Arvados resources":/api/methods.html - -API endpoint base: @https://{{ site.arvados_api_host }}/arvados/v1/links@ +See "collections":{{site.baseurl}}/api/methods/collections.html h3. Conditions of creating a Collection @@ -23,7 +18,7 @@ The @uuid@ and @manifest_text@ attributes must be provided when creating a Colle h3. Side effects of creating a Collection -Referenced data can be protected from garbage collection. +Referenced data can be protected from garbage collection. See the section about "resources" links on the "Links":Link.html page. Data can be shared with other users via the Arvados permission model. @@ -31,15 +26,14 @@ Clients can request checks of data integrity and storage redundancy. h2. Resource -Each collection has, in addition to the usual "attributes of Arvados resources":/api/resources.html: +Each collection has, in addition to the usual "attributes of Arvados resources":{{site.baseurl}}/api/resources.html: table(table table-bordered table-condensed). |_. Attribute|_. Type|_. Description|_. Example| -|locator|string||| -|portable_data_hash|string||| |name|string||| -|redundancy|number||| -|redundancy_confirmed_by_client_uuid|string|API client|| -|redundancy_confirmed_at|datetime||| -|redundancy_confirmed_as|number||| +|description|text||| +|portable_data_hash|string||| |manifest_text|text||| +|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@| +|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| +|replication_confirmed_at|datetime|When replication_confirmed was confirmed. If replication_confirmed is null, this field is also null.||