Package com.google.cloud.vision.v1

Class TextDetectionParams

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.vision.v1.TextDetectionParams
All Implemented Interfaces:
TextDetectionParamsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class TextDetectionParams extends com.google.protobuf.GeneratedMessage implements TextDetectionParamsOrBuilder
 Parameters for text detections. This is used to control TEXT_DETECTION and
 DOCUMENT_TEXT_DETECTION features.
Protobuf type google.cloud.vision.v1.TextDetectionParams
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    TextDetectionParams.Builder
    Parameters for text detections.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ADVANCED_OCR_OPTIONS_FIELD_NUMBER
     
    static final int
    ENABLE_TEXT_DETECTION_CONFIDENCE_SCORE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getAdvancedOcrOptions(int index)
    A list of advanced OCR options to further fine-tune OCR behavior.
    com.google.protobuf.ByteString
    getAdvancedOcrOptionsBytes(int index)
    A list of advanced OCR options to further fine-tune OCR behavior.
    int
    getAdvancedOcrOptionsCount()
    A list of advanced OCR options to further fine-tune OCR behavior.
    com.google.protobuf.ProtocolStringList
    getAdvancedOcrOptionsList()
    A list of advanced OCR options to further fine-tune OCR behavior.
    static TextDetectionParams
    getDefaultInstance()
     
    TextDetectionParams
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    boolean
    getEnableTextDetectionConfidenceScore()
    By default, Cloud Vision API only includes confidence score for DOCUMENT_TEXT_DETECTION result.
    com.google.protobuf.Parser<TextDetectionParams>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static TextDetectionParams.Builder
    newBuilder()
     
    static TextDetectionParams.Builder
    newBuilder(TextDetectionParams prototype)
     
    TextDetectionParams.Builder
    newBuilderForType()
     
    protected TextDetectionParams.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static TextDetectionParams
    parseDelimitedFrom(InputStream input)
     
    static TextDetectionParams
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TextDetectionParams
    parseFrom(byte[] data)
     
    static TextDetectionParams
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TextDetectionParams
    parseFrom(com.google.protobuf.ByteString data)
     
    static TextDetectionParams
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TextDetectionParams
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static TextDetectionParams
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TextDetectionParams
    parseFrom(InputStream input)
     
    static TextDetectionParams
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static TextDetectionParams
    parseFrom(ByteBuffer data)
     
    static TextDetectionParams
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<TextDetectionParams>
    parser()
     
    TextDetectionParams.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • ENABLE_TEXT_DETECTION_CONFIDENCE_SCORE_FIELD_NUMBER

      public static final int ENABLE_TEXT_DETECTION_CONFIDENCE_SCORE_FIELD_NUMBER
      See Also:

    • ADVANCED_OCR_OPTIONS_FIELD_NUMBER

      public static final int ADVANCED_OCR_OPTIONS_FIELD_NUMBER
      See Also:

  • 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

    • getEnableTextDetectionConfidenceScore

      public boolean getEnableTextDetectionConfidenceScore()
       By default, Cloud Vision API only includes confidence score for
 DOCUMENT_TEXT_DETECTION result. Set the flag to true to include confidence
 score for TEXT_DETECTION as well.
      bool enable_text_detection_confidence_score = 9;
      Specified by:
      getEnableTextDetectionConfidenceScore in interface TextDetectionParamsOrBuilder
      Returns:
      The enableTextDetectionConfidenceScore.

    • getAdvancedOcrOptionsList

      public com.google.protobuf.ProtocolStringList getAdvancedOcrOptionsList()
       A list of advanced OCR options to further fine-tune OCR behavior.
 Current valid values are:

 - `legacy_layout`: a heuristics layout detection algorithm, which serves as
 an alternative to the current ML-based layout detection algorithm.
 Customers can choose the best suitable layout algorithm based on their
 situation.
      repeated string advanced_ocr_options = 11;
      Specified by:
      getAdvancedOcrOptionsList in interface TextDetectionParamsOrBuilder
      Returns:
      A list containing the advancedOcrOptions.

    • getAdvancedOcrOptionsCount

      public int getAdvancedOcrOptionsCount()
       A list of advanced OCR options to further fine-tune OCR behavior.
 Current valid values are:

 - `legacy_layout`: a heuristics layout detection algorithm, which serves as
 an alternative to the current ML-based layout detection algorithm.
 Customers can choose the best suitable layout algorithm based on their
 situation.
      repeated string advanced_ocr_options = 11;
      Specified by:
      getAdvancedOcrOptionsCount in interface TextDetectionParamsOrBuilder
      Returns:
      The count of advancedOcrOptions.

    • getAdvancedOcrOptions

      public String getAdvancedOcrOptions(int index)
       A list of advanced OCR options to further fine-tune OCR behavior.
 Current valid values are:

 - `legacy_layout`: a heuristics layout detection algorithm, which serves as
 an alternative to the current ML-based layout detection algorithm.
 Customers can choose the best suitable layout algorithm based on their
 situation.
      repeated string advanced_ocr_options = 11;
      Specified by:
      getAdvancedOcrOptions in interface TextDetectionParamsOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The advancedOcrOptions at the given index.

    • getAdvancedOcrOptionsBytes

      public com.google.protobuf.ByteString getAdvancedOcrOptionsBytes(int index)
       A list of advanced OCR options to further fine-tune OCR behavior.
 Current valid values are:

 - `legacy_layout`: a heuristics layout detection algorithm, which serves as
 an alternative to the current ML-based layout detection algorithm.
 Customers can choose the best suitable layout algorithm based on their
 situation.
      repeated string advanced_ocr_options = 11;
      Specified by:
      getAdvancedOcrOptionsBytes in interface TextDetectionParamsOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the advancedOcrOptions at the given index.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

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

    • parseFrom

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

    • parseFrom

      public static TextDetectionParams parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static TextDetectionParams parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TextDetectionParams parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TextDetectionParams parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static TextDetectionParams parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static TextDetectionParams parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static TextDetectionParams.Builder newBuilder()

    • newBuilder

      public static TextDetectionParams.Builder newBuilder(TextDetectionParams prototype)

    • toBuilder

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

    • newBuilderForType

      protected TextDetectionParams.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static TextDetectionParams getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<TextDetectionParams> 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.GeneratedMessage

    • getDefaultInstanceForType

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