Package com.google.cloud.documentai.v1beta1

Class Document.Entity.Builder

  • All Implemented Interfaces:
    Document.EntityOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Document.Entity
    public static final class Document.Entity.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Document.Entity.Builder>
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

    • Method Detail

      • 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.Builder<Document.Entity.Builder>

      • clear

        public Document.Entity.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Entity.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Entity.Builder>

      • getDefaultInstanceForType

        public Document.Entity getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • clone

        public Document.Entity.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Entity.Builder>

      • setField

        public Document.Entity.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                        Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Entity.Builder>

      • clearField

        public Document.Entity.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Entity.Builder>

      • clearOneof

        public Document.Entity.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Entity.Builder>

      • setRepeatedField

        public Document.Entity.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                int index,
                                                Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Entity.Builder>

      • addRepeatedField

        public Document.Entity.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Entity.Builder>

      • mergeFrom

        public Document.Entity.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.Entity.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Entity.Builder>

      • mergeFrom

        public Document.Entity.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.Entity.Builder>
        Throws:
        IOException

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

      • setTextAnchor

        public Document.Entity.Builder setTextAnchor​(Document.TextAnchor value)
         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;

      • setTextAnchor

        public Document.Entity.Builder setTextAnchor​(Document.TextAnchor.Builder builderForValue)
         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;

      • mergeTextAnchor

        public Document.Entity.Builder mergeTextAnchor​(Document.TextAnchor value)
         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;

      • clearTextAnchor

        public Document.Entity.Builder clearTextAnchor()
         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;

      • getTextAnchorBuilder

        public Document.TextAnchor.Builder getTextAnchorBuilder()
         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;

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

      • setType

        public Document.Entity.Builder setType​(String value)
         Required. Entity type from a schema e.g. `Address`.
        string type = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The type to set.
        Returns:
        This builder for chaining.

      • clearType

        public Document.Entity.Builder clearType()
         Required. Entity type from a schema e.g. `Address`.
        string type = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.

      • setTypeBytes

        public Document.Entity.Builder setTypeBytes​(com.google.protobuf.ByteString value)
         Required. Entity type from a schema e.g. `Address`.
        string type = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for type to set.
        Returns:
        This builder for chaining.

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

      • setMentionText

        public Document.Entity.Builder setMentionText​(String value)
         Text value in the document e.g. `1600 Amphitheatre Pkwy`.
        string mention_text = 3;
        Parameters:
        value - The mentionText to set.
        Returns:
        This builder for chaining.

      • clearMentionText

        public Document.Entity.Builder clearMentionText()
         Text value in the document e.g. `1600 Amphitheatre Pkwy`.
        string mention_text = 3;
        Returns:
        This builder for chaining.

      • setMentionTextBytes

        public Document.Entity.Builder setMentionTextBytes​(com.google.protobuf.ByteString value)
         Text value in the document e.g. `1600 Amphitheatre Pkwy`.
        string mention_text = 3;
        Parameters:
        value - The bytes for mentionText to set.
        Returns:
        This builder for chaining.

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

      • setMentionId

        public Document.Entity.Builder setMentionId​(String value)
         Canonical mention name. This will be a unique value in the entity list
 for this document.
        string mention_id = 4;
        Parameters:
        value - The mentionId to set.
        Returns:
        This builder for chaining.

      • clearMentionId

        public Document.Entity.Builder clearMentionId()
         Canonical mention name. This will be a unique value in the entity list
 for this document.
        string mention_id = 4;
        Returns:
        This builder for chaining.

      • setMentionIdBytes

        public Document.Entity.Builder setMentionIdBytes​(com.google.protobuf.ByteString value)
         Canonical mention name. This will be a unique value in the entity list
 for this document.
        string mention_id = 4;
        Parameters:
        value - The bytes for mentionId to set.
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Document.Entity.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Entity.Builder>

      • mergeUnknownFields

        public final Document.Entity.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Entity.Builder>