Package com.google.cloud.documentai.v1

Class DocumentSchema.Metadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.google.cloud.documentai.v1.DocumentSchema.Metadata

All Implemented Interfaces:

DocumentSchema.MetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

DocumentSchema

public static final class DocumentSchema.Metadata
extends com.google.protobuf.GeneratedMessage
implements DocumentSchema.MetadataOrBuilder

 Metadata for global schema behavior.
 

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

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DocumentSchema.Metadata.Builder	Metadata for global schema behavior.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

com.google.protobuf.AbstractMessage.BuilderParent

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DOCUMENT_ALLOW_MULTIPLE_LABELS_FIELD_NUMBER
static final int	DOCUMENT_SPLITTER_FIELD_NUMBER
static final int	PREFIXED_NAMING_ON_PROPERTIES_FIELD_NUMBER
static final int	SKIP_NAMING_VALIDATION_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessage

alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static DocumentSchema.Metadata	getDefaultInstance()
DocumentSchema.Metadata	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getDocumentAllowMultipleLabels()	If true, on a given page, there can be multiple `document` annotations covering it.
boolean	getDocumentSplitter()	If true, a `document` entity type can be applied to subdocument (splitting).
com.google.protobuf.Parser<DocumentSchema.Metadata>	getParserForType()
boolean	getPrefixedNamingOnProperties()	If set, all the nested entities must be prefixed with the parents.
int	getSerializedSize()
boolean	getSkipNamingValidation()	If set, we will skip the naming format validation in the schema.
int	hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static DocumentSchema.Metadata.Builder	newBuilder()
static DocumentSchema.Metadata.Builder	newBuilder(DocumentSchema.Metadata prototype)
DocumentSchema.Metadata.Builder	newBuilderForType()
protected DocumentSchema.Metadata.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static DocumentSchema.Metadata	parseDelimitedFrom(InputStream input)
static DocumentSchema.Metadata	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentSchema.Metadata	parseFrom(byte[] data)
static DocumentSchema.Metadata	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentSchema.Metadata	parseFrom(com.google.protobuf.ByteString data)
static DocumentSchema.Metadata	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentSchema.Metadata	parseFrom(com.google.protobuf.CodedInputStream input)
static DocumentSchema.Metadata	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentSchema.Metadata	parseFrom(InputStream input)
static DocumentSchema.Metadata	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentSchema.Metadata	parseFrom(ByteBuffer data)
static DocumentSchema.Metadata	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DocumentSchema.Metadata>	parser()
DocumentSchema.Metadata.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessage

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Field Details

DOCUMENT_SPLITTER_FIELD_NUMBER

public static final int DOCUMENT_SPLITTER_FIELD_NUMBER

See Also:

• Constant Field Values

DOCUMENT_ALLOW_MULTIPLE_LABELS_FIELD_NUMBER

public static final int DOCUMENT_ALLOW_MULTIPLE_LABELS_FIELD_NUMBER

See Also:

• Constant Field Values

PREFIXED_NAMING_ON_PROPERTIES_FIELD_NUMBER

public static final int PREFIXED_NAMING_ON_PROPERTIES_FIELD_NUMBER

See Also:

• Constant Field Values

SKIP_NAMING_VALIDATION_FIELD_NUMBER

public static final int SKIP_NAMING_VALIDATION_FIELD_NUMBER

See Also:

• Constant Field Values

Method Details

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

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;

Specified by:

getDocumentSplitter in interface DocumentSchema.MetadataOrBuilder

Returns:

The documentSplitter.

getDocumentAllowMultipleLabels

public boolean getDocumentAllowMultipleLabels()

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

bool document_allow_multiple_labels = 2;

Specified by:

getDocumentAllowMultipleLabels in interface DocumentSchema.MetadataOrBuilder

Returns:

The documentAllowMultipleLabels.

getPrefixedNamingOnProperties

public boolean getPrefixedNamingOnProperties()

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

bool prefixed_naming_on_properties = 6;

Specified by:

getPrefixedNamingOnProperties in interface DocumentSchema.MetadataOrBuilder

Returns:

The prefixedNamingOnProperties.

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;

Specified by:

getSkipNamingValidation in interface DocumentSchema.MetadataOrBuilder

Returns:

The skipNamingValidation.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessage

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static DocumentSchema.Metadata parseFrom(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentSchema.Metadata parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentSchema.Metadata parseFrom(com.google.protobuf.ByteString data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentSchema.Metadata parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentSchema.Metadata parseFrom(byte[] data)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentSchema.Metadata parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentSchema.Metadata parseFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static DocumentSchema.Metadata parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static DocumentSchema.Metadata parseDelimitedFrom(InputStream input)
                                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static DocumentSchema.Metadata parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                  throws IOException

Throws:

IOException

parseFrom

public static DocumentSchema.Metadata parseFrom(com.google.protobuf.CodedInputStream input)
                                         throws IOException

Throws:

IOException

parseFrom

public static DocumentSchema.Metadata parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

newBuilderForType

public DocumentSchema.Metadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DocumentSchema.Metadata.Builder newBuilder()

newBuilder

public static DocumentSchema.Metadata.Builder newBuilder(DocumentSchema.Metadata prototype)

toBuilder

public DocumentSchema.Metadata.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DocumentSchema.Metadata.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static DocumentSchema.Metadata getDefaultInstance()

parser

public static com.google.protobuf.Parser<DocumentSchema.Metadata> parser()

getParserForType

public com.google.protobuf.Parser<DocumentSchema.Metadata> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessage

getDefaultInstanceForType

public DocumentSchema.Metadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder