REST Resource: projects.locations.collections

Resource: Collection

Defines the structure for content warehouse collection proto.

JSON representation 
{
  "name": string,
  "displayName": string,
  "parentCollectionId": string,
  "collectionType": enum (CollectionType),
  "revokeDocEditPermission": boolean,
  "allowLinkDocuments": boolean,
  "createTime": string,
  "updateTime": string,
  "attributes": {
    object
  }
}
Fields
name

string

The resource name of the collection. Format: projects/{projectNumber}/locations/{location}/collections/{collection}.

The name is ignored when creating a collection.
displayName

string

Required. Display name of the collection given by the user.
parentCollectionId

string

The parent collection id of the collection. One collection only can have one parent collection, and they should be in the same project and location.
collectionType

enum (CollectionType)

Indicate this collection's type.
revokeDocEditPermission

boolean

If it is true, after adding the document to the collection, the users with document edit permission will only have view permission. Can not be updated after the collection is created.
createTime

string (Timestamp format)

Output only. The time when the document is created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Output only. The time when the document is last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
attributes

object (Struct format)

Other collection attributes for the use cases.

CollectionType

The type of the collection.

Enums
COLLECTION_TYPE_UNSPECIFIED Not specified.
DATASET Dataset collection.
RECORD_SET Record set collection.
WORK_QUEUE Queue collection. E.g. a queue for human review.
WORKFLOW The working collection for a workflow. One workflow has one collection.
LEGAL_HOLD Legal hold collection.

Methods

create

 Creates a collection.

delete

 Deletes a collection.

fetchCollectionAcl

 Gets the access control policy for the collection.

get

 Gets a collection.
Searches for collections using provided SearchCollectionsRequest.

setCollectionAcl

 Sets the access control policy for the collection.