Class DocumentSchema.Metadata (2.55.0) 

public static final class DocumentSchema.Metadata extends GeneratedMessageV3 implements DocumentSchema.MetadataOrBuilder

Metadata for global schema behavior.

Protobuf type google.cloud.documentai.v1beta3.DocumentSchema.Metadata

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DocumentSchema.Metadata

Static Fields

DOCUMENT_ALLOW_MULTIPLE_LABELS_FIELD_NUMBER

public static final int DOCUMENT_ALLOW_MULTIPLE_LABELS_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENT_SPLITTER_FIELD_NUMBER

public static final int DOCUMENT_SPLITTER_FIELD_NUMBER
Field Value
Type Description
int

PREFIXED_NAMING_ON_PROPERTIES_FIELD_NUMBER

public static final int PREFIXED_NAMING_ON_PROPERTIES_FIELD_NUMBER
Field Value
Type Description
int

SKIP_NAMING_VALIDATION_FIELD_NUMBER

public static final int SKIP_NAMING_VALIDATION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DocumentSchema.Metadata getDefaultInstance()
Returns
Type Description
DocumentSchema.Metadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DocumentSchema.Metadata.Builder newBuilder()
Returns
Type Description
DocumentSchema.Metadata.Builder

newBuilder(DocumentSchema.Metadata prototype)

public static DocumentSchema.Metadata.Builder newBuilder(DocumentSchema.Metadata prototype)
Parameter
Name Description
prototype DocumentSchema.Metadata
Returns
Type Description
DocumentSchema.Metadata.Builder

parseDelimitedFrom(InputStream input)

public static DocumentSchema.Metadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentSchema.Metadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.Metadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentSchema.Metadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DocumentSchema.Metadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DocumentSchema.Metadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.Metadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentSchema.Metadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentSchema.Metadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DocumentSchema.Metadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.Metadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentSchema.Metadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentSchema.Metadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DocumentSchema.Metadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.Metadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentSchema.Metadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DocumentSchema.Metadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentSchema.Metadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.Metadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentSchema.Metadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DocumentSchema.Metadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DocumentSchema.Metadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentSchema.Metadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentSchema.Metadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DocumentSchema.Metadata> parser()
Returns
Type Description
Parser<Metadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public DocumentSchema.Metadata getDefaultInstanceForType()
Returns
Type Description
DocumentSchema.Metadata

getDocumentAllowMultipleLabels()

public boolean getDocumentAllowMultipleLabels()

If true, on a given page, there can be multiple document annotations covering it.

bool document_allow_multiple_labels = 2;

Returns
Type Description
boolean

The documentAllowMultipleLabels.

getDocumentSplitter()

public boolean getDocumentSplitter()

If true, a document entity type can be applied to subdocument (splitting). Otherwise, it can only be applied to the entire document (classification).

bool document_splitter = 1;

Returns
Type Description
boolean

The documentSplitter.

getParserForType()

public Parser<DocumentSchema.Metadata> getParserForType()
Returns
Type Description
Parser<Metadata>
Overrides

getPrefixedNamingOnProperties()

public boolean getPrefixedNamingOnProperties()

If set, all the nested entities must be prefixed with the parents.

bool prefixed_naming_on_properties = 6;

Returns
Type Description
boolean

The prefixedNamingOnProperties.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSkipNamingValidation()

public boolean getSkipNamingValidation()

If set, we will skip the naming format validation in the schema. So the string values in DocumentSchema.EntityType.name and DocumentSchema.EntityType.Property.name will not be checked.

bool skip_naming_validation = 7;

Returns
Type Description
boolean

The skipNamingValidation.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DocumentSchema.Metadata.Builder newBuilderForType()
Returns
Type Description
DocumentSchema.Metadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentSchema.Metadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DocumentSchema.Metadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DocumentSchema.Metadata.Builder toBuilder()
Returns
Type Description
DocumentSchema.Metadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException