Send feedback
Class DocumentSchema (2.80.0)
Stay organized with collections
Save and categorize content based on your preferences.
public final class DocumentSchema extends GeneratedMessageV3 implements DocumentSchemaOrBuilder
The schema defines the output of the processed document by a processor.
Protobuf type google.cloud.documentai.v1beta3.DocumentSchema
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
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int
ENTITY_TYPES_FIELD_NUMBER
public static final int ENTITY_TYPES_FIELD_NUMBER
Field Value
Type Description
int
public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static DocumentSchema getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static DocumentSchema . Builder newBuilder ()
newBuilder(DocumentSchema prototype)
public static DocumentSchema . Builder newBuilder ( DocumentSchema prototype )
public static DocumentSchema parseDelimitedFrom ( InputStream input )
public static DocumentSchema parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static DocumentSchema parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DocumentSchema parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static DocumentSchema parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DocumentSchema parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static DocumentSchema parseFrom ( CodedInputStream input )
public static DocumentSchema parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static DocumentSchema parseFrom ( InputStream input )
public static DocumentSchema parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static DocumentSchema parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DocumentSchema parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<DocumentSchema> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public DocumentSchema getDefaultInstanceForType ()
getDescription()
public String getDescription ()
Description of the schema.
string description = 2;
Returns
Type Description
String The description.
getDescriptionBytes()
public ByteString getDescriptionBytes ()
Description of the schema.
string description = 2;
Returns
Type Description
ByteString The bytes for description.
getDisplayName()
public String getDisplayName ()
Display name to show to users.
string display_name = 1;
Returns
Type Description
String The displayName.
getDisplayNameBytes()
public ByteString getDisplayNameBytes ()
Display name to show to users.
string display_name = 1;
Returns
Type Description
ByteString The bytes for displayName.
getEntityTypes(int index)
public DocumentSchema . EntityType getEntityTypes ( int index )
Entity types of the schema.
repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType entity_types = 3;
Parameter
Name Description
indexint
getEntityTypesCount()
public int getEntityTypesCount ()
Entity types of the schema.
repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType entity_types = 3;
Returns
Type Description
int
getEntityTypesList()
public List<DocumentSchema . EntityType > getEntityTypesList ()
Entity types of the schema.
repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType entity_types = 3;
getEntityTypesOrBuilder(int index)
public DocumentSchema . EntityTypeOrBuilder getEntityTypesOrBuilder ( int index )
Entity types of the schema.
repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType entity_types = 3;
Parameter
Name Description
indexint
getEntityTypesOrBuilderList()
public List <? extends DocumentSchema . EntityTypeOrBuilder > getEntityTypesOrBuilderList ()
Entity types of the schema.
repeated .google.cloud.documentai.v1beta3.DocumentSchema.EntityType entity_types = 3;
Returns
Type Description
List <? extends com.google.cloud.documentai.v1beta3.DocumentSchema.EntityTypeOrBuilder >
public DocumentSchema . Metadata getMetadata ()
Metadata of the schema.
.google.cloud.documentai.v1beta3.DocumentSchema.Metadata metadata = 4;
public DocumentSchema . MetadataOrBuilder getMetadataOrBuilder ()
Metadata of the schema.
.google.cloud.documentai.v1beta3.DocumentSchema.Metadata metadata = 4;
getParserForType()
public Parser<DocumentSchema> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
public boolean hasMetadata ()
Metadata of the schema.
.google.cloud.documentai.v1beta3.DocumentSchema.Metadata metadata = 4;
Returns
Type Description
boolean Whether the metadata field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public DocumentSchema . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DocumentSchema . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public DocumentSchema . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
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-11 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-11 UTC."],[],[]]
