Class Document.PageAnchor.PageRef (2.23.0) 
  
  
  
   
  
    
  
  
    
    
    
    
  Version 2.23.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   static   final   class  Document . PageAnchor . PageRef   extends   GeneratedMessageV3   implements   Document . PageAnchor . PageRefOrBuilder  
   Represents a weak reference to a page element within a document.
 Protobuf type google.cloud.documentai.v1beta2.Document.PageAnchor.PageRef
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
   
  Static Fields
   
  
  
    
public   static   final   int   LAYOUT_ID_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  
  
    
public   static   final   int   LAYOUT_TYPE_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  
  
    
public   static   final   int   PAGE_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  Static Methods
   
  
  
  
    
public   static   Document . PageAnchor . PageRef   getDefaultInstance ()  
  
  
  
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  
  
  
  
    
public   static   Document . PageAnchor . PageRef . Builder   newBuilder ()  
  
  
  
  
    
public   static   Document . PageAnchor . PageRef . Builder   newBuilder ( Document . PageAnchor . PageRef   prototype )  
  
  
  
  
  
    
public   static   Document . PageAnchor . PageRef   parseDelimitedFrom ( InputStream   input )  
  
  
  
  
  
  
    
public   static   Document . PageAnchor . PageRef   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
  
  
    
public   static   Document . PageAnchor . PageRef   parseFrom ( byte []   data )  
  
    
      
        Parameter  
      
        Name Description  
      
        databyte [] 
     
  
  
  
  
  
  
    
public   static   Document . PageAnchor . PageRef   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
  
  
    
public   static   Document . PageAnchor . PageRef   parseFrom ( ByteString   data )  
  
  
  
  
  
  
    
public   static   Document . PageAnchor . PageRef   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
  
  
    
public   static   Document . PageAnchor . PageRef   parseFrom ( CodedInputStream   input )  
  
  
  
  
  
  
    
public   static   Document . PageAnchor . PageRef   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
  
  
    
public   static   Document . PageAnchor . PageRef   parseFrom ( InputStream   input )  
  
  
  
  
  
  
    
public   static   Document . PageAnchor . PageRef   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
  
  
    
public   static   Document . PageAnchor . PageRef   parseFrom ( ByteBuffer   data )  
  
  
  
  
  
  
    
public   static   Document . PageAnchor . PageRef   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
  
  
    
public   static   Parser<Document . PageAnchor . PageRef >  parser ()  
  
  Methods
   
  
  
  
    
public   boolean   equals ( Object   obj )  
  
    
      
        Parameter  
      
        Name Description  
      
        objObject  
     
  
  
  Overrides 
  
  
  
  
    
public   Document . PageAnchor . PageRef   getDefaultInstanceForType ()  
  
  
  
  
    
public   String   getLayoutId ()  
   Optional. The Page.Layout.id  on the page that this element
 references.  If [LayoutRef.type][] is specified this id must also be
 specified.
 string layout_id = 3 [(.google.api.field_behavior) = OPTIONAL];
    
      
        Returns  
      
        Type Description  
      
        String The layoutId.
 
     
  
  
  
  
    
public   ByteString   getLayoutIdBytes ()  
   Optional. The Page.Layout.id  on the page that this element
 references.  If [LayoutRef.type][] is specified this id must also be
 specified.
 string layout_id = 3 [(.google.api.field_behavior) = OPTIONAL];
    
      
        Returns  
      
        Type Description  
      
        ByteString The bytes for layoutId.
 
     
  
  
  
  
    
public   Document . PageAnchor . PageRef . LayoutType   getLayoutType ()  
   Optional. The type of the layout element that is being referenced.  If not
 specified the whole page is assumed to be referenced.
 
 .google.cloud.documentai.v1beta2.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];
 
    
public   int   getLayoutTypeValue ()  
   Optional. The type of the layout element that is being referenced.  If not
 specified the whole page is assumed to be referenced.
 
 .google.cloud.documentai.v1beta2.Document.PageAnchor.PageRef.LayoutType layout_type = 2 [(.google.api.field_behavior) = OPTIONAL];
 
    
      
        Returns  
      
        Type Description  
      
        int The enum numeric value on the wire for layoutType.
 
     
  
  
  
  
   Required. Index into the Document.pages  element
 int64 page = 1 [(.google.api.field_behavior) = REQUIRED];
    
      
        Returns  
      
        Type Description  
      
        long The page.
 
     
  
  
  
  
    
public   Parser<Document . PageAnchor . PageRef >  getParserForType ()  
  
  Overrides 
  
  
  
  
    
public   int   getSerializedSize ()  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  
  
  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  
  
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  
  Overrides 
  
  
  
  
    
public   final   boolean   isInitialized ()  
  
  Overrides 
  
  
  
  
    
public   Document . PageAnchor . PageRef . Builder   newBuilderForType ()  
  
  
  
  
    
protected   Document . PageAnchor . PageRef . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
  
  
  Overrides 
  
  
  
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Object  
     
  
  Overrides 
  
  
  
  
    
public   Document . PageAnchor . PageRef . Builder   toBuilder ()  
  
  
  
  
    
public   void   writeTo ( CodedOutputStream   output )  
  
  Overrides 
  
  
 
     
    
  
  
  
     
  
    
    
      
       
    
    
  
  
 
  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-11 UTC.
 
 
  
  
  
    
      [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]