Class Document (2.76.0) 
  
  
  
   
  
    
  
  
    
    
    
    
  Version 2.76.0keyboard_arrow_down  
  
 
    
    
    
    
      
  
  
  
    
public   final   class  Document   extends   GeneratedMessageV3   implements   DocumentOrBuilder  
   A structured text document e.g. a PDF.
 Protobuf type google.cloud.automl.v1beta1.Document
    Inherited Members 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT) 
    
    
      com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int) 
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
      com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int) 
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
   
  Static Fields
   
  DOCUMENT_DIMENSIONS_FIELD_NUMBER 
  
    
public   static   final   int   DOCUMENT_DIMENSIONS_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  DOCUMENT_TEXT_FIELD_NUMBER 
  
    
public   static   final   int   DOCUMENT_TEXT_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  
  
    
public   static   final   int   INPUT_CONFIG_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  LAYOUT_FIELD_NUMBER 
  
    
public   static   final   int   LAYOUT_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  PAGE_COUNT_FIELD_NUMBER 
  
    
public   static   final   int   PAGE_COUNT_FIELD_NUMBER  
  
    
      
        Field Value  
      
        Type Description  
      
        int  
     
  
  Static Methods
   
  getDefaultInstance() 
  
    
public   static   Document   getDefaultInstance ()  
  
  getDescriptor() 
  
    
public   static   final   Descriptors . Descriptor   getDescriptor ()  
  
  newBuilder() 
  
    
public   static   Document . Builder   newBuilder ()  
  
  newBuilder(Document prototype) 
  
    
public   static   Document . Builder   newBuilder ( Document   prototype )  
  
    
      
        Parameter  
      
        Name Description  
      
        prototypeDocument  
     
  
  
  
    
public   static   Document   parseDelimitedFrom ( InputStream   input )  
  
  
  
  
    
public   static   Document   parseDelimitedFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(byte[] data) 
  
    
public   static   Document   parseFrom ( byte []   data )  
  
    
      
        Parameter  
      
        Name Description  
      
        databyte [] 
     
  
  
  
  parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Document   parseFrom ( byte []   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteString data) 
  
    
public   static   Document   parseFrom ( ByteString   data )  
  
  
  
  parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Document   parseFrom ( ByteString   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   Document   parseFrom ( CodedInputStream   input )  
  
  
  
  
    
public   static   Document   parseFrom ( CodedInputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  
    
public   static   Document   parseFrom ( InputStream   input )  
  
  
  
  
    
public   static   Document   parseFrom ( InputStream   input ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parseFrom(ByteBuffer data) 
  
    
public   static   Document   parseFrom ( ByteBuffer   data )  
  
  
  
  parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry) 
  
    
public   static   Document   parseFrom ( ByteBuffer   data ,   ExtensionRegistryLite   extensionRegistry )  
  
  
  
  parser() 
  
    
public   static   Parser<Document>   parser ()  
  
  Methods
   
  equals(Object obj) 
  
    
public   boolean   equals ( Object   obj )  
  
    
      
        Parameter  
      
        Name Description  
      
        objObject  
     
  
  
  Overrides 
  
  getDefaultInstanceForType() 
  
    
public   Document   getDefaultInstanceForType ()  
  
  getDocumentDimensions() 
  
    
public   DocumentDimensions   getDocumentDimensions ()  
   The dimensions of the page in the document.
 .google.cloud.automl.v1beta1.DocumentDimensions document_dimensions = 4;
getDocumentDimensionsOrBuilder() 
  
    
public   DocumentDimensionsOrBuilder   getDocumentDimensionsOrBuilder ()  
   The dimensions of the page in the document.
 .google.cloud.automl.v1beta1.DocumentDimensions document_dimensions = 4;
getDocumentText() 
  
    
public   TextSnippet   getDocumentText ()  
   The plain text version of this document.
 .google.cloud.automl.v1beta1.TextSnippet document_text = 2;
getDocumentTextOrBuilder() 
  
    
public   TextSnippetOrBuilder   getDocumentTextOrBuilder ()  
   The plain text version of this document.
 .google.cloud.automl.v1beta1.TextSnippet document_text = 2;
    
public   DocumentInputConfig   getInputConfig ()  
   An input config specifying the content of the document.
 .google.cloud.automl.v1beta1.DocumentInputConfig input_config = 1;
    
public   DocumentInputConfigOrBuilder   getInputConfigOrBuilder ()  
   An input config specifying the content of the document.
 .google.cloud.automl.v1beta1.DocumentInputConfig input_config = 1;
getLayout(int index) 
  
    
public   Document . Layout   getLayout ( int   index )  
   Describes the layout of the document.
 Sorted by [page_number][].
 repeated .google.cloud.automl.v1beta1.Document.Layout layout = 3;
    
      
        Parameter  
      
        Name Description  
      
        indexint  
     
  
  
  getLayoutCount() 
  
    
public   int   getLayoutCount ()  
   Describes the layout of the document.
 Sorted by [page_number][].
 repeated .google.cloud.automl.v1beta1.Document.Layout layout = 3;
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  getLayoutList() 
  
    
public   List<Document . Layout >  getLayoutList ()  
   Describes the layout of the document.
 Sorted by [page_number][].
 repeated .google.cloud.automl.v1beta1.Document.Layout layout = 3;
getLayoutOrBuilder(int index) 
  
    
public   Document . LayoutOrBuilder   getLayoutOrBuilder ( int   index )  
   Describes the layout of the document.
 Sorted by [page_number][].
 repeated .google.cloud.automl.v1beta1.Document.Layout layout = 3;
    
      
        Parameter  
      
        Name Description  
      
        indexint  
     
  
  
  getLayoutOrBuilderList() 
  
    
public   List <?   extends   Document . LayoutOrBuilder >  getLayoutOrBuilderList ()  
   Describes the layout of the document.
 Sorted by [page_number][].
 repeated .google.cloud.automl.v1beta1.Document.Layout layout = 3;
    
      
        Returns  
      
        Type Description  
      
        List <? extends com.google.cloud.automl.v1beta1.Document.LayoutOrBuilder > 
     
  
  getPageCount() 
  
    
public   int   getPageCount ()  
   Number of pages in the document.
 int32 page_count = 5;
    
      
        Returns  
      
        Type Description  
      
        int The pageCount.
 
     
  
  getParserForType() 
  
    
public   Parser<Document>   getParserForType ()  
  
  Overrides 
  
  getSerializedSize() 
  
    
public   int   getSerializedSize ()  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  hasDocumentDimensions() 
  
    
public   boolean   hasDocumentDimensions ()  
   The dimensions of the page in the document.
 .google.cloud.automl.v1beta1.DocumentDimensions document_dimensions = 4;
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the documentDimensions field is set.
 
     
  
  hasDocumentText() 
  
    
public   boolean   hasDocumentText ()  
   The plain text version of this document.
 .google.cloud.automl.v1beta1.TextSnippet document_text = 2;
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the documentText field is set.
 
     
  
  
    
public   boolean   hasInputConfig ()  
   An input config specifying the content of the document.
 .google.cloud.automl.v1beta1.DocumentInputConfig input_config = 1;
    
      
        Returns  
      
        Type Description  
      
        boolean Whether the inputConfig field is set.
 
     
  
  hashCode() 
  
  
    
      
        Returns  
      
        Type Description  
      
        int  
     
  
  Overrides 
  
  internalGetFieldAccessorTable() 
  
    
protected   GeneratedMessageV3 . FieldAccessorTable   internalGetFieldAccessorTable ()  
  
  Overrides 
  
  isInitialized() 
  
    
public   final   boolean   isInitialized ()  
  
  Overrides 
  
  newBuilderForType() 
  
    
public   Document . Builder   newBuilderForType ()  
  
  newBuilderForType(GeneratedMessageV3.BuilderParent parent) 
  
    
protected   Document . Builder   newBuilderForType ( GeneratedMessageV3 . BuilderParent   parent )  
  
  
  Overrides 
  
  newInstance(GeneratedMessageV3.UnusedPrivateParameter unused) 
  
    
protected   Object   newInstance ( GeneratedMessageV3 . UnusedPrivateParameter   unused )  
  
  
    
      
        Returns  
      
        Type Description  
      
        Object  
     
  
  Overrides 
  
  toBuilder() 
  
    
public   Document . Builder   toBuilder ()  
  
  writeTo(CodedOutputStream output) 
  
    
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-28 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-28 UTC."],[],[]]