Class OcrConfig.Hints.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<OcrConfig.Hints.Builder>
com.google.cloud.documentai.v1.OcrConfig.Hints.Builder
All Implemented Interfaces:
OcrConfig.HintsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
OcrConfig.Hints

public static final class OcrConfig.Hints.Builder extends com.google.protobuf.GeneratedMessage.Builder<OcrConfig.Hints.Builder> implements OcrConfig.HintsOrBuilder
 Hints for OCR Engine
 
Protobuf type google.cloud.documentai.v1.OcrConfig.Hints
  • Method Summary

    Modifier and Type
    Method
    Description
    List of BCP-47 language codes to use for OCR.
    List of BCP-47 language codes to use for OCR.
    addLanguageHintsBytes(com.google.protobuf.ByteString value)
    List of BCP-47 language codes to use for OCR.
     
     
     
    List of BCP-47 language codes to use for OCR.
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    com.google.protobuf.Descriptors.Descriptor
     
    getLanguageHints(int index)
    List of BCP-47 language codes to use for OCR.
    com.google.protobuf.ByteString
    List of BCP-47 language codes to use for OCR.
    int
    List of BCP-47 language codes to use for OCR.
    com.google.protobuf.ProtocolStringList
    List of BCP-47 language codes to use for OCR.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
     
    final boolean
     
     
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    mergeFrom(com.google.protobuf.Message other)
     
    setLanguageHints(int index, String value)
    List of BCP-47 language codes to use for OCR.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<OcrConfig.Hints.Builder>
    • clear

      public OcrConfig.Hints.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.GeneratedMessage.Builder<OcrConfig.Hints.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.GeneratedMessage.Builder<OcrConfig.Hints.Builder>
    • getDefaultInstanceForType

      public OcrConfig.Hints getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public OcrConfig.Hints build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public OcrConfig.Hints buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public OcrConfig.Hints.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<OcrConfig.Hints.Builder>
    • mergeFrom

      public OcrConfig.Hints.Builder mergeFrom(OcrConfig.Hints other)
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<OcrConfig.Hints.Builder>
    • mergeFrom

      public OcrConfig.Hints.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<OcrConfig.Hints.Builder>
      Throws:
      IOException
    • getLanguageHintsList

      public com.google.protobuf.ProtocolStringList getLanguageHintsList()
       List of BCP-47 language codes to use for OCR. In most cases, not
       specifying it yields the best results since it enables automatic language
       detection. For languages based on the Latin alphabet, setting hints is
       not needed. In rare cases, when the language of the text in the
       image is known, setting a hint will help get better results (although it
       will be a significant hindrance if the hint is wrong).
       
      repeated string language_hints = 1;
      Specified by:
      getLanguageHintsList in interface OcrConfig.HintsOrBuilder
      Returns:
      A list containing the languageHints.
    • getLanguageHintsCount

      public int getLanguageHintsCount()
       List of BCP-47 language codes to use for OCR. In most cases, not
       specifying it yields the best results since it enables automatic language
       detection. For languages based on the Latin alphabet, setting hints is
       not needed. In rare cases, when the language of the text in the
       image is known, setting a hint will help get better results (although it
       will be a significant hindrance if the hint is wrong).
       
      repeated string language_hints = 1;
      Specified by:
      getLanguageHintsCount in interface OcrConfig.HintsOrBuilder
      Returns:
      The count of languageHints.
    • getLanguageHints

      public String getLanguageHints(int index)
       List of BCP-47 language codes to use for OCR. In most cases, not
       specifying it yields the best results since it enables automatic language
       detection. For languages based on the Latin alphabet, setting hints is
       not needed. In rare cases, when the language of the text in the
       image is known, setting a hint will help get better results (although it
       will be a significant hindrance if the hint is wrong).
       
      repeated string language_hints = 1;
      Specified by:
      getLanguageHints in interface OcrConfig.HintsOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The languageHints at the given index.
    • getLanguageHintsBytes

      public com.google.protobuf.ByteString getLanguageHintsBytes(int index)
       List of BCP-47 language codes to use for OCR. In most cases, not
       specifying it yields the best results since it enables automatic language
       detection. For languages based on the Latin alphabet, setting hints is
       not needed. In rare cases, when the language of the text in the
       image is known, setting a hint will help get better results (although it
       will be a significant hindrance if the hint is wrong).
       
      repeated string language_hints = 1;
      Specified by:
      getLanguageHintsBytes in interface OcrConfig.HintsOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the languageHints at the given index.
    • setLanguageHints

      public OcrConfig.Hints.Builder setLanguageHints(int index, String value)
       List of BCP-47 language codes to use for OCR. In most cases, not
       specifying it yields the best results since it enables automatic language
       detection. For languages based on the Latin alphabet, setting hints is
       not needed. In rare cases, when the language of the text in the
       image is known, setting a hint will help get better results (although it
       will be a significant hindrance if the hint is wrong).
       
      repeated string language_hints = 1;
      Parameters:
      index - The index to set the value at.
      value - The languageHints to set.
      Returns:
      This builder for chaining.
    • addLanguageHints

      public OcrConfig.Hints.Builder addLanguageHints(String value)
       List of BCP-47 language codes to use for OCR. In most cases, not
       specifying it yields the best results since it enables automatic language
       detection. For languages based on the Latin alphabet, setting hints is
       not needed. In rare cases, when the language of the text in the
       image is known, setting a hint will help get better results (although it
       will be a significant hindrance if the hint is wrong).
       
      repeated string language_hints = 1;
      Parameters:
      value - The languageHints to add.
      Returns:
      This builder for chaining.
    • addAllLanguageHints

      public OcrConfig.Hints.Builder addAllLanguageHints(Iterable<String> values)
       List of BCP-47 language codes to use for OCR. In most cases, not
       specifying it yields the best results since it enables automatic language
       detection. For languages based on the Latin alphabet, setting hints is
       not needed. In rare cases, when the language of the text in the
       image is known, setting a hint will help get better results (although it
       will be a significant hindrance if the hint is wrong).
       
      repeated string language_hints = 1;
      Parameters:
      values - The languageHints to add.
      Returns:
      This builder for chaining.
    • clearLanguageHints

      public OcrConfig.Hints.Builder clearLanguageHints()
       List of BCP-47 language codes to use for OCR. In most cases, not
       specifying it yields the best results since it enables automatic language
       detection. For languages based on the Latin alphabet, setting hints is
       not needed. In rare cases, when the language of the text in the
       image is known, setting a hint will help get better results (although it
       will be a significant hindrance if the hint is wrong).
       
      repeated string language_hints = 1;
      Returns:
      This builder for chaining.
    • addLanguageHintsBytes

      public OcrConfig.Hints.Builder addLanguageHintsBytes(com.google.protobuf.ByteString value)
       List of BCP-47 language codes to use for OCR. In most cases, not
       specifying it yields the best results since it enables automatic language
       detection. For languages based on the Latin alphabet, setting hints is
       not needed. In rare cases, when the language of the text in the
       image is known, setting a hint will help get better results (although it
       will be a significant hindrance if the hint is wrong).
       
      repeated string language_hints = 1;
      Parameters:
      value - The bytes of the languageHints to add.
      Returns:
      This builder for chaining.