X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/3318fb4db96c25d87fd5a4037ff2c2aa55bc01ed..c8bf4dc1eef2a73b4b01501eabdc922e2a27a276:/doc/api/methods/collections.html.textile.liquid diff --git a/doc/api/methods/collections.html.textile.liquid b/doc/api/methods/collections.html.textile.liquid index c68773d900..01efda2b0c 100644 --- a/doc/api/methods/collections.html.textile.liquid +++ b/doc/api/methods/collections.html.textile.liquid @@ -19,7 +19,7 @@ Example UUID: @zzzzz-4zz18-0123456789abcde@ h2. Resource -Collections describe sets of files in terms of data blocks stored in Keep. See "storage in Keep":{{site.baseurl}}/api/storage.html for details. +Collections describe sets of files in terms of data blocks stored in Keep. See "Keep - Content-Addressable Storage":{{site.baseurl}}/architecture/storage.html for details. Each collection has, in addition to the "Common resource fields":{{site.baseurl}}/api/resources.html: @@ -32,13 +32,18 @@ table(table table-bordered table-condensed). |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.|| +|replication_confirmed_at|datetime|When @replication_confirmed@ was confirmed. If @replication_confirmed@ is null, this field is also null.|| +|storage_classes_desired|list|An optional list of storage class names where the blocks should be saved. If not provided, the cluster's default storage class(es) will be set.|@['archival']@| +|storage_classes_confirmed|list|Storage classes most recently confirmed by the storage system. This field is an empty list when a collection is first created.|@'archival']@, @[]@| +|storage_classes_confirmed_at|datetime|When @storage_classes_confirmed@ was confirmed. If @storage_classes_confirmed@ is @[]@, this field is null.|| |trash_at|datetime|If @trash_at@ is non-null and in the past, this collection will be hidden from API calls. May be untrashed.|| |delete_at|datetime|If @delete_at@ is non-null and in the past, the collection may be permanently deleted.|| |is_trashed|boolean|True if @trash_at@ is in the past, false if not.|| |current_version_uuid|string|UUID of the collection's current version. On new collections, it'll be equal to the @uuid@ attribute.|| |version|number|Version number, starting at 1 on new collections. This attribute is read-only.|| -|preserve_version|boolean|When set to true on a current version, it will be saved on the next versionable update.|| +|preserve_version|boolean|When set to true on a current version, it will be persisted. When passing @true@ as part of a bigger update call, both current and newly created versions are persisted.|| +|file_count|number|The total number of files in the collection. This attribute is read-only.|| +|file_size_total|number|The sum of the file sizes in the collection. This attribute is read-only.|| h3. Conditions of creating a Collection @@ -80,13 +85,13 @@ table(table table-bordered table-condensed). h3. get -Gets a Collection's metadata by UUID or portable data hash. When making a request by portable data hash, the returned record will only have the @portable_data_hash@ and @manifest_text@. +Gets a Collection's metadata by UUID or portable data hash. When making a request by portable data hash, attributes other than @portable_data_hash@ and @manifest_text@ are not returned, even when requested explicitly using the @select@ parameter. Arguments: table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | -{background:#ccffcc}.|uuid|string|The UUID of the Collection in question.|path|| +{background:#ccffcc}.|uuid|string|The UUID or portable data hash of the Collection in question.|path|| h3. list @@ -122,3 +127,36 @@ table(table table-bordered table-condensed). |_. Argument |_. Type |_. Description |_. Location |_. Example | {background:#ccffcc}.|uuid|string|The UUID of the Collection to untrash.|path|| |ensure_unique_name|boolean (default false)|Rename collection uniquely if untrashing it would fail with a unique name conflict.|query|| + + +h3. provenance + +Returns a list of objects in the database that directly or indirectly contributed to producing this collection, such as the container request that produced this collection as output. + +The general algorithm is: + +# Visit the container request that produced this collection (via @output_uuid@ or @log_uuid@ attributes of the container request) +# Visit the input collections to that container request (via @mounts@ and @container_image@ of the container request) +# Iterate until there are no more objects to visit + +Arguments: + +table(table table-bordered table-condensed). +|_. Argument |_. Type |_. Description |_. Location |_. Example | +{background:#ccffcc}.|uuid|string|The UUID of the Collection to get provenance.|path|| + +h3. used_by + +Returns a list of objects in the database this collection directly or indirectly contributed to, such as containers that takes this collection as input. + +The general algorithm is: + +# Visit containers that take this collection as input (via @mounts@ or @container_image@ of the container) +# Visit collections produced by those containers (via @output@ or @log@ of the container) +# Iterate until there are no more objects to visit + +Arguments: + +table(table table-bordered table-condensed). +|_. Argument |_. Type |_. Description |_. Location |_. Example | +{background:#ccffcc}.|uuid|string|The UUID of the Collection to get usage.|path||