Class DocumentSchema (2.36.0)

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.v1.DocumentSchema

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ENTITY_TYPES_FIELD_NUMBER

public static final int ENTITY_TYPES_FIELD_NUMBER
Field Value
TypeDescription
int

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DocumentSchema getDefaultInstance()
Returns
TypeDescription
DocumentSchema

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static DocumentSchema.Builder newBuilder()
Returns
TypeDescription
DocumentSchema.Builder

newBuilder(DocumentSchema prototype)

public static DocumentSchema.Builder newBuilder(DocumentSchema prototype)
Parameter
NameDescription
prototypeDocumentSchema
Returns
TypeDescription
DocumentSchema.Builder

parseDelimitedFrom(InputStream input)

public static DocumentSchema parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DocumentSchema parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentSchema parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentSchema parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DocumentSchema parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DocumentSchema parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentSchema
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DocumentSchema> parser()
Returns
TypeDescription
Parser<DocumentSchema>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public DocumentSchema getDefaultInstanceForType()
Returns
TypeDescription
DocumentSchema

getDescription()

public String getDescription()

Description of the schema.

string description = 2;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Description of the schema.

string description = 2;

Returns
TypeDescription
ByteString

The bytes for description.

getDisplayName()

public String getDisplayName()

Display name to show to users.

string display_name = 1;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Display name to show to users.

string display_name = 1;

Returns
TypeDescription
ByteString

The bytes for displayName.

getEntityTypes(int index)

public DocumentSchema.EntityType getEntityTypes(int index)

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
DocumentSchema.EntityType

getEntityTypesCount()

public int getEntityTypesCount()

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Returns
TypeDescription
int

getEntityTypesList()

public List<DocumentSchema.EntityType> getEntityTypesList()

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Returns
TypeDescription
List<EntityType>

getEntityTypesOrBuilder(int index)

public DocumentSchema.EntityTypeOrBuilder getEntityTypesOrBuilder(int index)

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
DocumentSchema.EntityTypeOrBuilder

getEntityTypesOrBuilderList()

public List<? extends DocumentSchema.EntityTypeOrBuilder> getEntityTypesOrBuilderList()

Entity types of the schema.

repeated .google.cloud.documentai.v1.DocumentSchema.EntityType entity_types = 3;

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1.DocumentSchema.EntityTypeOrBuilder>

getMetadata()

public DocumentSchema.Metadata getMetadata()

Metadata of the schema.

.google.cloud.documentai.v1.DocumentSchema.Metadata metadata = 4;

Returns
TypeDescription
DocumentSchema.Metadata

The metadata.

getMetadataOrBuilder()

public DocumentSchema.MetadataOrBuilder getMetadataOrBuilder()

Metadata of the schema.

.google.cloud.documentai.v1.DocumentSchema.Metadata metadata = 4;

Returns
TypeDescription
DocumentSchema.MetadataOrBuilder

getParserForType()

public Parser<DocumentSchema> getParserForType()
Returns
TypeDescription
Parser<DocumentSchema>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasMetadata()

public boolean hasMetadata()

Metadata of the schema.

.google.cloud.documentai.v1.DocumentSchema.Metadata metadata = 4;

Returns
TypeDescription
boolean

Whether the metadata field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DocumentSchema.Builder newBuilderForType()
Returns
TypeDescription
DocumentSchema.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentSchema.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DocumentSchema.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DocumentSchema.Builder toBuilder()
Returns
TypeDescription
DocumentSchema.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException