Package com.google.cloud.documentai.v1beta2

Class Document.Label.Builder

  • All Implemented Interfaces:
    Document.LabelOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
    Enclosing class:
    Document.Label
    public static final class Document.Label.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Document.Label.Builder>
implements Document.LabelOrBuilder
     Label attaches schema information and/or other metadata to segments within
 a [Document][google.cloud.documentai.v1beta2.Document]. Multiple
 [Label][google.cloud.documentai.v1beta2.Document.Label]s on a single field
 can denote either different labels, different instances of the same label
 created at different times, or some combination of both.
    Protobuf type google.cloud.documentai.v1beta2.Document.Label

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

      • clear

        public Document.Label.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.Label.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.Label.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Document.Label.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.Label.Builder>

      • setField

        public Document.Label.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.Label.Builder>

      • clearField

        public Document.Label.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.Label.Builder>

      • clearOneof

        public Document.Label.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.Label.Builder>

      • setRepeatedField

        public Document.Label.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.Label.Builder>

      • addRepeatedField

        public Document.Label.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.Label.Builder>

      • mergeFrom

        public Document.Label.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.Label.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.Label.Builder>

      • mergeFrom

        public Document.Label.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.Label.Builder>
        Throws:
        IOException

      • hasAutomlModel

        public boolean hasAutomlModel()
         Label is generated AutoML model. This field stores the full resource
 name of the AutoML model.

 Format:
 `projects/{project-id}/locations/{location-id}/models/{model-id}`
        string automl_model = 2;
        Specified by:
        hasAutomlModel in interface Document.LabelOrBuilder
        Returns:
        Whether the automlModel field is set.

      • getAutomlModel

        public String getAutomlModel()
         Label is generated AutoML model. This field stores the full resource
 name of the AutoML model.

 Format:
 `projects/{project-id}/locations/{location-id}/models/{model-id}`
        string automl_model = 2;
        Specified by:
        getAutomlModel in interface Document.LabelOrBuilder
        Returns:
        The automlModel.

      • getAutomlModelBytes

        public com.google.protobuf.ByteString getAutomlModelBytes()
         Label is generated AutoML model. This field stores the full resource
 name of the AutoML model.

 Format:
 `projects/{project-id}/locations/{location-id}/models/{model-id}`
        string automl_model = 2;
        Specified by:
        getAutomlModelBytes in interface Document.LabelOrBuilder
        Returns:
        The bytes for automlModel.

      • setAutomlModel

        public Document.Label.Builder setAutomlModel​(String value)
         Label is generated AutoML model. This field stores the full resource
 name of the AutoML model.

 Format:
 `projects/{project-id}/locations/{location-id}/models/{model-id}`
        string automl_model = 2;
        Parameters:
        value - The automlModel to set.
        Returns:
        This builder for chaining.

      • clearAutomlModel

        public Document.Label.Builder clearAutomlModel()
         Label is generated AutoML model. This field stores the full resource
 name of the AutoML model.

 Format:
 `projects/{project-id}/locations/{location-id}/models/{model-id}`
        string automl_model = 2;
        Returns:
        This builder for chaining.

      • setAutomlModelBytes

        public Document.Label.Builder setAutomlModelBytes​(com.google.protobuf.ByteString value)
         Label is generated AutoML model. This field stores the full resource
 name of the AutoML model.

 Format:
 `projects/{project-id}/locations/{location-id}/models/{model-id}`
        string automl_model = 2;
        Parameters:
        value - The bytes for automlModel to set.
        Returns:
        This builder for chaining.

      • getName

        public String getName()
         Name of the label.

 When the label is generated from AutoML Text Classification model, this
 field represents the name of the category.
        string name = 1;
        Specified by:
        getName in interface Document.LabelOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Name of the label.

 When the label is generated from AutoML Text Classification model, this
 field represents the name of the category.
        string name = 1;
        Specified by:
        getNameBytes in interface Document.LabelOrBuilder
        Returns:
        The bytes for name.

      • setName

        public Document.Label.Builder setName​(String value)
         Name of the label.

 When the label is generated from AutoML Text Classification model, this
 field represents the name of the category.
        string name = 1;
        Parameters:
        value - The name to set.
        Returns:
        This builder for chaining.

      • clearName

        public Document.Label.Builder clearName()
         Name of the label.

 When the label is generated from AutoML Text Classification model, this
 field represents the name of the category.
        string name = 1;
        Returns:
        This builder for chaining.

      • setNameBytes

        public Document.Label.Builder setNameBytes​(com.google.protobuf.ByteString value)
         Name of the label.

 When the label is generated from AutoML Text Classification model, this
 field represents the name of the category.
        string name = 1;
        Parameters:
        value - The bytes for name to set.
        Returns:
        This builder for chaining.

      • getConfidence

        public float getConfidence()
         Confidence score between 0 and 1 for label assignment.
        float confidence = 3;
        Specified by:
        getConfidence in interface Document.LabelOrBuilder
        Returns:
        The confidence.

      • setConfidence

        public Document.Label.Builder setConfidence​(float value)
         Confidence score between 0 and 1 for label assignment.
        float confidence = 3;
        Parameters:
        value - The confidence to set.
        Returns:
        This builder for chaining.

      • clearConfidence

        public Document.Label.Builder clearConfidence()
         Confidence score between 0 and 1 for label assignment.
        float confidence = 3;
        Returns:
        This builder for chaining.

      • setUnknownFields

        public final Document.Label.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.Label.Builder>

      • mergeUnknownFields

        public final Document.Label.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.Label.Builder>