Package com.google.cloud.documentai.v1beta1

Class Document.Entity

  • All Implemented Interfaces:
    Document.EntityOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    Document
    public static final class Document.Entity
extends com.google.protobuf.GeneratedMessageV3
implements Document.EntityOrBuilder
     A phrase in the text that is a known entity type, such as a person, an
 organization, or location.
    Protobuf type google.cloud.documentai.v1beta1.Document.Entity
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Document.Entity.Builder
      A phrase in the text that is a known entity type, such as a person, an organization, or location.

      • 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 MENTION_ID_FIELD_NUMBER  
      static int MENTION_TEXT_FIELD_NUMBER  
      static int TEXT_ANCHOR_FIELD_NUMBER  
      static int TYPE_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 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

      • hasTextAnchor

        public boolean hasTextAnchor()
         Provenance of the entity.
 Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1beta1.Document.text].
        .google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;
        Specified by:
        hasTextAnchor in interface Document.EntityOrBuilder
        Returns:
        Whether the textAnchor field is set.

      • getTextAnchor

        public Document.TextAnchor getTextAnchor()
         Provenance of the entity.
 Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1beta1.Document.text].
        .google.cloud.documentai.v1beta1.Document.TextAnchor text_anchor = 1;
        Specified by:
        getTextAnchor in interface Document.EntityOrBuilder
        Returns:
        The textAnchor.

      • getType

        public String getType()
         Required. Entity type from a schema e.g. `Address`.
        string type = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getType in interface Document.EntityOrBuilder
        Returns:
        The type.

      • getTypeBytes

        public com.google.protobuf.ByteString getTypeBytes()
         Required. Entity type from a schema e.g. `Address`.
        string type = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getTypeBytes in interface Document.EntityOrBuilder
        Returns:
        The bytes for type.

      • getMentionText

        public String getMentionText()
         Text value in the document e.g. `1600 Amphitheatre Pkwy`.
        string mention_text = 3;
        Specified by:
        getMentionText in interface Document.EntityOrBuilder
        Returns:
        The mentionText.

      • getMentionTextBytes

        public com.google.protobuf.ByteString getMentionTextBytes()
         Text value in the document e.g. `1600 Amphitheatre Pkwy`.
        string mention_text = 3;
        Specified by:
        getMentionTextBytes in interface Document.EntityOrBuilder
        Returns:
        The bytes for mentionText.

      • getMentionId

        public String getMentionId()
         Canonical mention name. This will be a unique value in the entity list
 for this document.
        string mention_id = 4;
        Specified by:
        getMentionId in interface Document.EntityOrBuilder
        Returns:
        The mentionId.

      • getMentionIdBytes

        public com.google.protobuf.ByteString getMentionIdBytes()
         Canonical mention name. This will be a unique value in the entity list
 for this document.
        string mention_id = 4;
        Specified by:
        getMentionIdBytes in interface Document.EntityOrBuilder
        Returns:
        The bytes for mentionId.

      • 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 Document.Entity parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document.Entity parseFrom​(ByteBuffer data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document.Entity parseFrom​(com.google.protobuf.ByteString data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document.Entity parseFrom​(com.google.protobuf.ByteString data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document.Entity parseFrom​(byte[] data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document.Entity parseFrom​(byte[] data,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document.Entity parseFrom​(com.google.protobuf.CodedInputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Document.Entity.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Document.Entity.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Document.Entity.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Document.Entity> 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 Document.Entity getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder