Package com.google.cloud.documentai.v1

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
     An entity that could be a phrase in the text or a property that belongs to
 the document. It is a known entity type, such as a person, an organization,
 or location.
    Protobuf type google.cloud.documentai.v1.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()
         Optional. Provenance of the entity.
 Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1.Document.text].
        .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasTextAnchor in interface Document.EntityOrBuilder
        Returns:
        Whether the textAnchor field is set.

      • getTextAnchor

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

      • setTextAnchor

        public Document.Entity.Builder setTextAnchor​(Document.TextAnchor value)
         Optional. Provenance of the entity.
 Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1.Document.text].
        .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

      • setTextAnchor

        public Document.Entity.Builder setTextAnchor​(Document.TextAnchor.Builder builderForValue)
         Optional. Provenance of the entity.
 Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1.Document.text].
        .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

      • mergeTextAnchor

        public Document.Entity.Builder mergeTextAnchor​(Document.TextAnchor value)
         Optional. Provenance of the entity.
 Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1.Document.text].
        .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

      • clearTextAnchor

        public Document.Entity.Builder clearTextAnchor()
         Optional. Provenance of the entity.
 Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1.Document.text].
        .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

      • getTextAnchorBuilder

        public Document.TextAnchor.Builder getTextAnchorBuilder()
         Optional. Provenance of the entity.
 Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1.Document.text].
        .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];

      • getTextAnchorOrBuilder

        public Document.TextAnchorOrBuilder getTextAnchorOrBuilder()
         Optional. Provenance of the entity.
 Text anchor indexing into the
 [Document.text][google.cloud.documentai.v1.Document.text].
        .google.cloud.documentai.v1.Document.TextAnchor text_anchor = 1 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getTextAnchorOrBuilder in interface Document.EntityOrBuilder

      • 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()
         Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
        string mention_text = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMentionText in interface Document.EntityOrBuilder
        Returns:
        The mentionText.

      • getMentionTextBytes

        public com.google.protobuf.ByteString getMentionTextBytes()
         Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
        string mention_text = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMentionTextBytes in interface Document.EntityOrBuilder
        Returns:
        The bytes for mentionText.

      • setMentionText

        public Document.Entity.Builder setMentionText​(String value)
         Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
        string mention_text = 3 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The mentionText to set.
        Returns:
        This builder for chaining.

      • clearMentionText

        public Document.Entity.Builder clearMentionText()
         Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
        string mention_text = 3 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setMentionTextBytes

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

      • getMentionId

        public String getMentionId()
         Optional. Deprecated.  Use `id` field instead.
        string mention_id = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMentionId in interface Document.EntityOrBuilder
        Returns:
        The mentionId.

      • getMentionIdBytes

        public com.google.protobuf.ByteString getMentionIdBytes()
         Optional. Deprecated.  Use `id` field instead.
        string mention_id = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getMentionIdBytes in interface Document.EntityOrBuilder
        Returns:
        The bytes for mentionId.

      • setMentionId

        public Document.Entity.Builder setMentionId​(String value)
         Optional. Deprecated.  Use `id` field instead.
        string mention_id = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The mentionId to set.
        Returns:
        This builder for chaining.

      • clearMentionId

        public Document.Entity.Builder clearMentionId()
         Optional. Deprecated.  Use `id` field instead.
        string mention_id = 4 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setMentionIdBytes

        public Document.Entity.Builder setMentionIdBytes​(com.google.protobuf.ByteString value)
         Optional. Deprecated.  Use `id` field instead.
        string mention_id = 4 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for mentionId to set.
        Returns:
        This builder for chaining.

      • getConfidence

        public float getConfidence()
         Optional. Confidence of detected Schema entity. Range `[0, 1]`.
        float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getConfidence in interface Document.EntityOrBuilder
        Returns:
        The confidence.

      • setConfidence

        public Document.Entity.Builder setConfidence​(float value)
         Optional. Confidence of detected Schema entity. Range `[0, 1]`.
        float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The confidence to set.
        Returns:
        This builder for chaining.

      • clearConfidence

        public Document.Entity.Builder clearConfidence()
         Optional. Confidence of detected Schema entity. Range `[0, 1]`.
        float confidence = 5 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • hasPageAnchor

        public boolean hasPageAnchor()
         Optional. Represents the provenance of this entity wrt. the location on
 the page where it was found.
        .google.cloud.documentai.v1.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasPageAnchor in interface Document.EntityOrBuilder
        Returns:
        Whether the pageAnchor field is set.

      • getPageAnchor

        public Document.PageAnchor getPageAnchor()
         Optional. Represents the provenance of this entity wrt. the location on
 the page where it was found.
        .google.cloud.documentai.v1.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageAnchor in interface Document.EntityOrBuilder
        Returns:
        The pageAnchor.

      • setPageAnchor

        public Document.Entity.Builder setPageAnchor​(Document.PageAnchor value)
         Optional. Represents the provenance of this entity wrt. the location on
 the page where it was found.
        .google.cloud.documentai.v1.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

      • setPageAnchor

        public Document.Entity.Builder setPageAnchor​(Document.PageAnchor.Builder builderForValue)
         Optional. Represents the provenance of this entity wrt. the location on
 the page where it was found.
        .google.cloud.documentai.v1.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

      • mergePageAnchor

        public Document.Entity.Builder mergePageAnchor​(Document.PageAnchor value)
         Optional. Represents the provenance of this entity wrt. the location on
 the page where it was found.
        .google.cloud.documentai.v1.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

      • clearPageAnchor

        public Document.Entity.Builder clearPageAnchor()
         Optional. Represents the provenance of this entity wrt. the location on
 the page where it was found.
        .google.cloud.documentai.v1.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

      • getPageAnchorBuilder

        public Document.PageAnchor.Builder getPageAnchorBuilder()
         Optional. Represents the provenance of this entity wrt. the location on
 the page where it was found.
        .google.cloud.documentai.v1.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];

      • getPageAnchorOrBuilder

        public Document.PageAnchorOrBuilder getPageAnchorOrBuilder()
         Optional. Represents the provenance of this entity wrt. the location on
 the page where it was found.
        .google.cloud.documentai.v1.Document.PageAnchor page_anchor = 6 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPageAnchorOrBuilder in interface Document.EntityOrBuilder

      • getId

        public String getId()
         Optional. Canonical id. This will be a unique value in the entity list
 for this document.
        string id = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getId in interface Document.EntityOrBuilder
        Returns:
        The id.

      • getIdBytes

        public com.google.protobuf.ByteString getIdBytes()
         Optional. Canonical id. This will be a unique value in the entity list
 for this document.
        string id = 7 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getIdBytes in interface Document.EntityOrBuilder
        Returns:
        The bytes for id.

      • setId

        public Document.Entity.Builder setId​(String value)
         Optional. Canonical id. This will be a unique value in the entity list
 for this document.
        string id = 7 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The id to set.
        Returns:
        This builder for chaining.

      • clearId

        public Document.Entity.Builder clearId()
         Optional. Canonical id. This will be a unique value in the entity list
 for this document.
        string id = 7 [(.google.api.field_behavior) = OPTIONAL];
        Returns:
        This builder for chaining.

      • setIdBytes

        public Document.Entity.Builder setIdBytes​(com.google.protobuf.ByteString value)
         Optional. Canonical id. This will be a unique value in the entity list
 for this document.
        string id = 7 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The bytes for id to set.
        Returns:
        This builder for chaining.

      • hasNormalizedValue

        public boolean hasNormalizedValue()
         Optional. Normalized entity value. Absent if the extracted value could
 not be converted or the type (e.g. address) is not supported for certain
 parsers. This field is also only populated for certain supported document
 types.
        .google.cloud.documentai.v1.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasNormalizedValue in interface Document.EntityOrBuilder
        Returns:
        Whether the normalizedValue field is set.

      • getNormalizedValue

        public Document.Entity.NormalizedValue getNormalizedValue()
         Optional. Normalized entity value. Absent if the extracted value could
 not be converted or the type (e.g. address) is not supported for certain
 parsers. This field is also only populated for certain supported document
 types.
        .google.cloud.documentai.v1.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getNormalizedValue in interface Document.EntityOrBuilder
        Returns:
        The normalizedValue.

      • setNormalizedValue

        public Document.Entity.Builder setNormalizedValue​(Document.Entity.NormalizedValue value)
         Optional. Normalized entity value. Absent if the extracted value could
 not be converted or the type (e.g. address) is not supported for certain
 parsers. This field is also only populated for certain supported document
 types.
        .google.cloud.documentai.v1.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

      • setNormalizedValue

        public Document.Entity.Builder setNormalizedValue​(Document.Entity.NormalizedValue.Builder builderForValue)
         Optional. Normalized entity value. Absent if the extracted value could
 not be converted or the type (e.g. address) is not supported for certain
 parsers. This field is also only populated for certain supported document
 types.
        .google.cloud.documentai.v1.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

      • mergeNormalizedValue

        public Document.Entity.Builder mergeNormalizedValue​(Document.Entity.NormalizedValue value)
         Optional. Normalized entity value. Absent if the extracted value could
 not be converted or the type (e.g. address) is not supported for certain
 parsers. This field is also only populated for certain supported document
 types.
        .google.cloud.documentai.v1.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

      • clearNormalizedValue

        public Document.Entity.Builder clearNormalizedValue()
         Optional. Normalized entity value. Absent if the extracted value could
 not be converted or the type (e.g. address) is not supported for certain
 parsers. This field is also only populated for certain supported document
 types.
        .google.cloud.documentai.v1.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

      • getNormalizedValueBuilder

        public Document.Entity.NormalizedValue.Builder getNormalizedValueBuilder()
         Optional. Normalized entity value. Absent if the extracted value could
 not be converted or the type (e.g. address) is not supported for certain
 parsers. This field is also only populated for certain supported document
 types.
        .google.cloud.documentai.v1.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];

      • getNormalizedValueOrBuilder

        public Document.Entity.NormalizedValueOrBuilder getNormalizedValueOrBuilder()
         Optional. Normalized entity value. Absent if the extracted value could
 not be converted or the type (e.g. address) is not supported for certain
 parsers. This field is also only populated for certain supported document
 types.
        .google.cloud.documentai.v1.Document.Entity.NormalizedValue normalized_value = 9 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getNormalizedValueOrBuilder in interface Document.EntityOrBuilder

      • getPropertiesList

        public List<Document.Entity> getPropertiesList()
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPropertiesList in interface Document.EntityOrBuilder

      • getPropertiesCount

        public int getPropertiesCount()
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPropertiesCount in interface Document.EntityOrBuilder

      • getProperties

        public Document.Entity getProperties​(int index)
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getProperties in interface Document.EntityOrBuilder

      • setProperties

        public Document.Entity.Builder setProperties​(int index,
                                             Document.Entity value)
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

      • setProperties

        public Document.Entity.Builder setProperties​(int index,
                                             Document.Entity.Builder builderForValue)
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

      • addProperties

        public Document.Entity.Builder addProperties​(Document.Entity value)
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

      • addProperties

        public Document.Entity.Builder addProperties​(int index,
                                             Document.Entity value)
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

      • addProperties

        public Document.Entity.Builder addProperties​(Document.Entity.Builder builderForValue)
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

      • addProperties

        public Document.Entity.Builder addProperties​(int index,
                                             Document.Entity.Builder builderForValue)
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

      • addAllProperties

        public Document.Entity.Builder addAllProperties​(Iterable<? extends Document.Entity> values)
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

      • clearProperties

        public Document.Entity.Builder clearProperties()
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

      • removeProperties

        public Document.Entity.Builder removeProperties​(int index)
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

      • getPropertiesBuilder

        public Document.Entity.Builder getPropertiesBuilder​(int index)
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

      • getPropertiesOrBuilder

        public Document.EntityOrBuilder getPropertiesOrBuilder​(int index)
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPropertiesOrBuilder in interface Document.EntityOrBuilder

      • getPropertiesOrBuilderList

        public List<? extends Document.EntityOrBuilder> getPropertiesOrBuilderList()
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getPropertiesOrBuilderList in interface Document.EntityOrBuilder

      • addPropertiesBuilder

        public Document.Entity.Builder addPropertiesBuilder()
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

      • addPropertiesBuilder

        public Document.Entity.Builder addPropertiesBuilder​(int index)
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

      • getPropertiesBuilderList

        public List<Document.Entity.Builder> getPropertiesBuilderList()
         Optional. Entities can be nested to form a hierarchical data structure
 representing the content in the document.
        repeated .google.cloud.documentai.v1.Document.Entity properties = 10 [(.google.api.field_behavior) = OPTIONAL];

      • hasProvenance

        public boolean hasProvenance()
         Optional. The history of this annotation.
        .google.cloud.documentai.v1.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasProvenance in interface Document.EntityOrBuilder
        Returns:
        Whether the provenance field is set.

      • getProvenance

        public Document.Provenance getProvenance()
         Optional. The history of this annotation.
        .google.cloud.documentai.v1.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getProvenance in interface Document.EntityOrBuilder
        Returns:
        The provenance.

      • setProvenance

        public Document.Entity.Builder setProvenance​(Document.Provenance value)
         Optional. The history of this annotation.
        .google.cloud.documentai.v1.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];

      • setProvenance

        public Document.Entity.Builder setProvenance​(Document.Provenance.Builder builderForValue)
         Optional. The history of this annotation.
        .google.cloud.documentai.v1.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];

      • mergeProvenance

        public Document.Entity.Builder mergeProvenance​(Document.Provenance value)
         Optional. The history of this annotation.
        .google.cloud.documentai.v1.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];

      • clearProvenance

        public Document.Entity.Builder clearProvenance()
         Optional. The history of this annotation.
        .google.cloud.documentai.v1.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];

      • getProvenanceBuilder

        public Document.Provenance.Builder getProvenanceBuilder()
         Optional. The history of this annotation.
        .google.cloud.documentai.v1.Document.Provenance provenance = 11 [(.google.api.field_behavior) = OPTIONAL];

      • getRedacted

        public boolean getRedacted()
         Optional. Whether the entity will be redacted for de-identification
 purposes.
        bool redacted = 12 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getRedacted in interface Document.EntityOrBuilder
        Returns:
        The redacted.

      • setRedacted

        public Document.Entity.Builder setRedacted​(boolean value)
         Optional. Whether the entity will be redacted for de-identification
 purposes.
        bool redacted = 12 [(.google.api.field_behavior) = OPTIONAL];
        Parameters:
        value - The redacted to set.
        Returns:
        This builder for chaining.

      • clearRedacted

        public Document.Entity.Builder clearRedacted()
         Optional. Whether the entity will be redacted for de-identification
 purposes.
        bool redacted = 12 [(.google.api.field_behavior) = OPTIONAL];
        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>