Send feedback
  
   
 
  
    
      Class DocumentLink (0.8.0)
    
    
       
    
    
      
      Stay organized with collections
     
    
      
      Save and categorize content based on your preferences.
     
    
  
      
     
  
  
   
  
    
  
  
    
    
    
  Version 0.8.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  DocumentLink   extends   GeneratedMessageV3   implements   DocumentLinkOrBuilder  
   
   A document-link between source and target document.
 Protobuf type google.cloud.contentwarehouse.v1.DocumentLink
 
  
  
  
  Static Fields
   
  CREATE_TIME_FIELD_NUMBER 
  
    
public   static   final   int   CREATE_TIME_FIELD_NUMBER  
   
  Field Value 
  
  DESCRIPTION_FIELD_NUMBER 
  
    
public   static   final   int   DESCRIPTION_FIELD_NUMBER  
   
  Field Value 
  
  NAME_FIELD_NUMBER 
  
    
public   static   final   int   NAME_FIELD_NUMBER  
   
  Field Value 
  
  SOURCE_DOCUMENT_REFERENCE_FIELD_NUMBER 
  
    
public   static   final   int   SOURCE_DOCUMENT_REFERENCE_FIELD_NUMBER  
   
  Field Value 
  
  STATE_FIELD_NUMBER 
  
    
public   static   final   int   STATE_FIELD_NUMBER  
   
  Field Value 
  
  TARGET_DOCUMENT_REFERENCE_FIELD_NUMBER 
  
    
public   static   final   int   TARGET_DOCUMENT_REFERENCE_FIELD_NUMBER  
   
  Field Value 
  
  UPDATE_TIME_FIELD_NUMBER 
  
    
public   static   final   int   UPDATE_TIME_FIELD_NUMBER  
   
  Field Value 
  
  Static Methods
   
   
  getDefaultInstance() 
  
    
public   static   DocumentLink   getDefaultInstance ()  
   
  Returns 
  
   
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
   
  Returns 
  
   
  newBuilder() 
  
    
public   static   DocumentLink . Builder   newBuilder ()  
   
  Returns 
  
   
  newBuilder(DocumentLink prototype) 
  
    
public   static   DocumentLink . Builder   newBuilder ( DocumentLink   prototype )  
   
  Parameter 
  
  Returns 
  
   
  parseDelimitedFrom(InputStream input) 
  
    
public   static   DocumentLink   parseDelimitedFrom ( InputStream   input )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   DocumentLink   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(byte[] data) 
  
    
public   static   DocumentLink   parseFrom ( byte []   data )  
   
  Parameter 
  
    
      
        Name  
        Description  
       
      
        data 
        byte [] 
       
     
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   DocumentLink   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(ByteString data) 
  
    
public   static   DocumentLink   parseFrom ( ByteString   data )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   DocumentLink   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(CodedInputStream input) 
  
    
public   static   DocumentLink   parseFrom ( CodedInputStream   input )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   DocumentLink   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(InputStream input) 
  
    
public   static   DocumentLink   parseFrom ( InputStream   input )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   DocumentLink   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(ByteBuffer data) 
  
    
public   static   DocumentLink   parseFrom ( ByteBuffer   data )  
   
  Parameter 
  
  Returns 
  
  Exceptions 
  
   
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   DocumentLink   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
   
  Parameters 
  
  Returns 
  
  Exceptions 
  
   
  parser() 
  
    
public   static   Parser<DocumentLink>   parser ()  
   
  Returns 
  
  Methods
   
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
   
  Parameter 
  
  Returns 
  
  Overrides 
  
   
  getCreateTime() 
  
    
public   Timestamp   getCreateTime ()  
   
   Output only. The time when the documentLink is created.
 .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
 
  Returns 
  
   
  getCreateTimeOrBuilder() 
  
    
public   TimestampOrBuilder   getCreateTimeOrBuilder ()  
   
   Output only. The time when the documentLink is created.
 .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
 
  Returns 
  
   
  getDefaultInstanceForType() 
  
    
public   DocumentLink   getDefaultInstanceForType ()  
   
  Returns 
  
   
  getDescription() 
  
    
public   String   getDescription ()  
   
   Description of this document-link.
 string description = 4;
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        String  
        The description.
 
       
     
  
   
  getDescriptionBytes() 
  
    
public   ByteString   getDescriptionBytes ()  
   
   Description of this document-link.
 string description = 4;
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        ByteString  
        The bytes for description.
 
       
     
  
   
  getName() 
  
   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/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}.
 string name = 1;
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        String  
        The name.
 
       
     
  
   
  getNameBytes() 
  
    
public   ByteString   getNameBytes ()  
   
   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/{project_number}/locations/{location}/documents/{source_document_id}/documentLinks/{document_link_id}.
 string name = 1;
 
  Returns 
  
   
  getParserForType() 
  
    
public   Parser<DocumentLink>   getParserForType ()  
   
  Returns 
  
  Overrides 
  
   
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
   
  Returns 
  
  Overrides 
  
   
  getSourceDocumentReference() 
  
    
public   DocumentReference   getSourceDocumentReference ()  
   
   Document references of the source document.
 .google.cloud.contentwarehouse.v1.DocumentReference source_document_reference = 2;
 
  Returns 
  
   
  getSourceDocumentReferenceOrBuilder() 
  
    
public   DocumentReferenceOrBuilder   getSourceDocumentReferenceOrBuilder ()  
   
   Document references of the source document.
 .google.cloud.contentwarehouse.v1.DocumentReference source_document_reference = 2;
 
  Returns 
  
   
  getState() 
  
    
public   DocumentLink . State   getState ()  
   
   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.
 .google.cloud.contentwarehouse.v1.DocumentLink.State state = 7;
 
  Returns 
  
   
  getStateValue() 
  
    
public   int   getStateValue ()  
   
   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.
 .google.cloud.contentwarehouse.v1.DocumentLink.State state = 7;
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        int  
        The enum numeric value on the wire for state.
 
       
     
  
   
  getTargetDocumentReference() 
  
    
public   DocumentReference   getTargetDocumentReference ()  
   
   Document references of the target document.
 .google.cloud.contentwarehouse.v1.DocumentReference target_document_reference = 3;
 
  Returns 
  
   
  getTargetDocumentReferenceOrBuilder() 
  
    
public   DocumentReferenceOrBuilder   getTargetDocumentReferenceOrBuilder ()  
   
   Document references of the target document.
 .google.cloud.contentwarehouse.v1.DocumentReference target_document_reference = 3;
 
  Returns 
  
   
  getUnknownFields() 
  
    
public   final   UnknownFieldSet   getUnknownFields ()  
   
  Returns 
  
  Overrides 
  
   
  getUpdateTime() 
  
    
public   Timestamp   getUpdateTime ()  
   
   Output only. The time when the documentLink is last updated.
 .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
 
  Returns 
  
   
  getUpdateTimeOrBuilder() 
  
    
public   TimestampOrBuilder   getUpdateTimeOrBuilder ()  
   
   Output only. The time when the documentLink is last updated.
 .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
 
  Returns 
  
   
  hasCreateTime() 
  
    
public   boolean   hasCreateTime ()  
   
   Output only. The time when the documentLink is created.
 .google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        boolean  
        Whether the createTime field is set.
 
       
     
  
   
  hasSourceDocumentReference() 
  
    
public   boolean   hasSourceDocumentReference ()  
   
   Document references of the source document.
 .google.cloud.contentwarehouse.v1.DocumentReference source_document_reference = 2;
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        boolean  
        Whether the sourceDocumentReference field is set.
 
       
     
  
   
  hasTargetDocumentReference() 
  
    
public   boolean   hasTargetDocumentReference ()  
   
   Document references of the target document.
 .google.cloud.contentwarehouse.v1.DocumentReference target_document_reference = 3;
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        boolean  
        Whether the targetDocumentReference field is set.
 
       
     
  
   
  hasUpdateTime() 
  
    
public   boolean   hasUpdateTime ()  
   
   Output only. The time when the documentLink is last updated.
 .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
 
  Returns 
  
    
      
        Type  
        Description  
       
      
        boolean  
        Whether the updateTime field is set.
 
       
     
  
   
  hashCode() 
  
  Returns 
  
  Overrides 
  
   
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
   
  Returns 
  
  Overrides 
  
   
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
   
  Returns 
  
  Overrides 
  
   
  newBuilderForType() 
  
    
public   DocumentLink . Builder   newBuilderForType ()  
   
  Returns 
  
   
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   DocumentLink . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
   
  Parameter 
  
  Returns 
  
  Overrides 
  
   
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
   
  Parameter 
  
  Returns 
  
  Overrides 
  
   
  toBuilder() 
  
    
public   DocumentLink . Builder   toBuilder ()  
   
  Returns 
  
   
  writeTo(CodedOutputStream output) 
  
    
public   void   writeTo ( CodedOutputStream   output )  
   
  Parameter 
  
  Overrides 
  
  Exceptions 
  
 
     
    
  
  
  
     
  
 
  
    
    
      
    
     
  
       
         
  
  
    
    Send feedback
  
   
 
       
    
    
  
  
 
  Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
  Last updated 2025-10-30 UTC.
 
 
  
  
    
    
    
      
  
  
    Need to tell us more?
  
   
 
     
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]