Package com.google.cloud.documentai.v1

Class DocumentSchema

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1.DocumentSchema

All Implemented Interfaces:

DocumentSchemaOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class DocumentSchema
extends com.google.protobuf.GeneratedMessageV3
implements DocumentSchemaOrBuilder

 The schema defines the output of the processed document by a processor.
 

Protobuf type google.cloud.documentai.v1.DocumentSchema

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DocumentSchema.Builder	The schema defines the output of the processed document by a processor.
static class	DocumentSchema.EntityType	EntityType is the wrapper of a label of the corresponding model with detailed attributes and limitations for entity-based processors.
static interface	DocumentSchema.EntityTypeOrBuilder
static class	DocumentSchema.Metadata	Metadata for global schema behavior.
static interface	DocumentSchema.MetadataOrBuilder

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static int	DESCRIPTION_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	ENTITY_TYPES_FIELD_NUMBER
static int	METADATA_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, 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	getDefaultInstance()
DocumentSchema	getDefaultInstanceForType()
String	getDescription()	Description of the schema.
com.google.protobuf.ByteString	getDescriptionBytes()	Description of the schema.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName()	Display name to show to users.
com.google.protobuf.ByteString	getDisplayNameBytes()	Display name to show to users.
DocumentSchema.EntityType	getEntityTypes(int index)	Entity types of the schema.
int	getEntityTypesCount()	Entity types of the schema.
List<DocumentSchema.EntityType>	getEntityTypesList()	Entity types of the schema.
DocumentSchema.EntityTypeOrBuilder	getEntityTypesOrBuilder(int index)	Entity types of the schema.
List<? extends DocumentSchema.EntityTypeOrBuilder>	getEntityTypesOrBuilderList()	Entity types of the schema.
DocumentSchema.Metadata	getMetadata()	Metadata of the schema.
DocumentSchema.MetadataOrBuilder	getMetadataOrBuilder()	Metadata of the schema.
com.google.protobuf.Parser<DocumentSchema>	getParserForType()
int	getSerializedSize()
int	hashCode()
boolean	hasMetadata()	Metadata of the schema.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DocumentSchema.Builder	newBuilder()
static DocumentSchema.Builder	newBuilder(DocumentSchema prototype)
DocumentSchema.Builder	newBuilderForType()
protected DocumentSchema.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DocumentSchema	parseDelimitedFrom(InputStream input)
static DocumentSchema	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentSchema	parseFrom(byte[] data)
static DocumentSchema	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentSchema	parseFrom(com.google.protobuf.ByteString data)
static DocumentSchema	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentSchema	parseFrom(com.google.protobuf.CodedInputStream input)
static DocumentSchema	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentSchema	parseFrom(InputStream input)
static DocumentSchema	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentSchema	parseFrom(ByteBuffer data)
static DocumentSchema	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DocumentSchema>	parser()
DocumentSchema.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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 Detail

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

ENTITY_TYPES_FIELD_NUMBER

public static final int ENTITY_TYPES_FIELD_NUMBER

See Also:

Constant Field Values

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getDisplayName

public String getDisplayName()

 Display name to show to users.
 

string display_name = 1;

Specified by:

getDisplayName in interface DocumentSchemaOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 Display name to show to users.
 

string display_name = 1;

Specified by:

getDisplayNameBytes in interface DocumentSchemaOrBuilder

Returns:

The bytes for displayName.

getDescription

public String getDescription()

 Description of the schema.
 

string description = 2;

Specified by:

getDescription in interface DocumentSchemaOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 Description of the schema.
 

string description = 2;

Specified by:

getDescriptionBytes in interface DocumentSchemaOrBuilder

Returns:

The bytes for description.

getEntityTypesList

public List<DocumentSchema.EntityType> getEntityTypesList()

 Entity types of the schema.
 

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

Specified by:

getEntityTypesList in interface DocumentSchemaOrBuilder

getEntityTypesOrBuilderList

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

 Entity types of the schema.
 

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

Specified by:

getEntityTypesOrBuilderList in interface DocumentSchemaOrBuilder

getEntityTypesCount

public int getEntityTypesCount()

 Entity types of the schema.
 

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

Specified by:

getEntityTypesCount in interface DocumentSchemaOrBuilder

getEntityTypes

public DocumentSchema.EntityType getEntityTypes(int index)

 Entity types of the schema.
 

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

Specified by:

getEntityTypes in interface DocumentSchemaOrBuilder

getEntityTypesOrBuilder

public DocumentSchema.EntityTypeOrBuilder getEntityTypesOrBuilder(int index)

 Entity types of the schema.
 

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

Specified by:

getEntityTypesOrBuilder in interface DocumentSchemaOrBuilder

hasMetadata

public boolean hasMetadata()

 Metadata of the schema.
 

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

Specified by:

hasMetadata in interface DocumentSchemaOrBuilder

Returns:

Whether the metadata field is set.

getMetadata

public DocumentSchema.Metadata getMetadata()

 Metadata of the schema.
 

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

Specified by:

getMetadata in interface DocumentSchemaOrBuilder

Returns:

The metadata.

getMetadataOrBuilder

public DocumentSchema.MetadataOrBuilder getMetadataOrBuilder()

 Metadata of the schema.
 

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

Specified by:

getMetadataOrBuilder in interface DocumentSchemaOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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 parseFrom(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentSchema 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 parseFrom(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentSchema parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static DocumentSchema parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public DocumentSchema.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DocumentSchema.Builder newBuilder()

newBuilder

public static DocumentSchema.Builder newBuilder(DocumentSchema prototype)

toBuilder

public DocumentSchema.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DocumentSchema getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<DocumentSchema> 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.GeneratedMessageV3

getDefaultInstanceForType

public DocumentSchema getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder