A document-link between source and target document.
| JSON representation | 
|---|
{ "name": string, "sourceDocumentReference": { object (  | 
            
| Fields | |
|---|---|
name | 
              
                 
 name of this document-link. It is required that the parent derived form the name to be consistent with the source document reference. Otherwise an exception will be thrown. Format: projects/{projectNumber}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}.  | 
            
sourceDocumentReference | 
              
                 
 Document references of the source document.  | 
            
targetDocumentReference | 
              
                 
 Document references of the target document.  | 
            
description | 
              
                 
 description of this document-link.  | 
            
updateTime | 
              
                 
 Output only. The time when the documentLink is last updated. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:   | 
            
createTime | 
              
                 
 Output only. The time when the documentLink is created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:   | 
            
state | 
              
                 
 The state of the documentlink. If target node has been deleted, the link is marked as invalid. Removing a source node will result in removal of all associated links.  | 
            
DocumentReference
References to the documents.
| JSON representation | 
|---|
{ "documentName": string, "displayName": string, "snippet": string, "documentIsFolder": boolean, "updateTime": string, "createTime": string, "deleteTime": string, "documentIsRetentionFolder": boolean, "documentIsLegalHoldFolder": boolean }  | 
              
| Fields | |
|---|---|
documentName | 
                
                   
 Required. name of the referenced document.  | 
              
displayName | 
                
                   
 displayName of the referenced document; this name does not need to be consistent to the displayName in the Document proto, depending on the ACL constraint.  | 
              
snippet | 
                
                   
 Stores the subset of the referenced document's content. This is useful to allow user peek the information of the referenced document.  | 
              
documentIsFolder | 
                
                   
 The document type of the document being referenced.  | 
              
updateTime | 
                
                   
 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:   | 
              
createTime | 
                
                   
 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:   | 
              
deleteTime | 
                
                   
 Output only. The time when the document is deleted. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples:   | 
              
documentIsRetentionFolder | 
                
                   
 Document is a folder with retention policy.  | 
              
documentIsLegalHoldFolder | 
                
                   
 Document is a folder with legal hold.  | 
              
State
The state of a document-link.
| Enums | |
|---|---|
STATE_UNSPECIFIED | 
                Unknown state of documentlink. | 
ACTIVE | 
                The documentlink has both source and target documents detected. | 
SOFT_DELETED | 
                target document is deleted, and mark the documentlink as soft-deleted. |