com.google.cloud.documentai.v1beta2

Class OcrParams

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1beta2.OcrParams

All Implemented Interfaces:

OcrParamsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class OcrParams
extends com.google.protobuf.GeneratedMessageV3
implements OcrParamsOrBuilder

 Parameters to control Optical Character Recognition (OCR) behavior.
 

Protobuf type google.cloud.documentai.v1beta2.OcrParams

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OcrParams.Builder Parameters to control Optical Character Recognition (OCR) behavior.

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

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	LANGUAGE_HINTS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, 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 and Description
boolean	equals(Object obj)
static OcrParams	getDefaultInstance()
OcrParams	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getLanguageHints(int index) List of languages to use for OCR.
com.google.protobuf.ByteString	getLanguageHintsBytes(int index) List of languages to use for OCR.
int	getLanguageHintsCount() List of languages to use for OCR.
com.google.protobuf.ProtocolStringList	getLanguageHintsList() List of languages to use for OCR.
com.google.protobuf.Parser<OcrParams>	getParserForType()
int	getSerializedSize()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static OcrParams.Builder	newBuilder()
static OcrParams.Builder	newBuilder(OcrParams prototype)
OcrParams.Builder	newBuilderForType()
protected OcrParams.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static OcrParams	parseDelimitedFrom(InputStream input)
static OcrParams	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OcrParams	parseFrom(byte[] data)
static OcrParams	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OcrParams	parseFrom(ByteBuffer data)
static OcrParams	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OcrParams	parseFrom(com.google.protobuf.ByteString data)
static OcrParams	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OcrParams	parseFrom(com.google.protobuf.CodedInputStream input)
static OcrParams	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OcrParams	parseFrom(InputStream input)
static OcrParams	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<OcrParams>	parser()
OcrParams.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

LANGUAGE_HINTS_FIELD_NUMBER

public static final int LANGUAGE_HINTS_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

getLanguageHintsList

public com.google.protobuf.ProtocolStringList getLanguageHintsList()

 List of languages to use for OCR. In most cases, an empty value
 yields the best results since it enables automatic language detection. For
 languages based on the Latin alphabet, setting `language_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). Document processing returns an
 error if one or more of the specified languages is not one of the
 supported languages.
 

repeated string language_hints = 1;

Specified by:

getLanguageHintsList in interface OcrParamsOrBuilder

Returns:

A list containing the languageHints.

getLanguageHintsCount

public int getLanguageHintsCount()

 List of languages to use for OCR. In most cases, an empty value
 yields the best results since it enables automatic language detection. For
 languages based on the Latin alphabet, setting `language_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). Document processing returns an
 error if one or more of the specified languages is not one of the
 supported languages.
 

repeated string language_hints = 1;

Specified by:

getLanguageHintsCount in interface OcrParamsOrBuilder

Returns:

The count of languageHints.

getLanguageHints

public String getLanguageHints(int index)

 List of languages to use for OCR. In most cases, an empty value
 yields the best results since it enables automatic language detection. For
 languages based on the Latin alphabet, setting `language_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). Document processing returns an
 error if one or more of the specified languages is not one of the
 supported languages.
 

repeated string language_hints = 1;

Specified by:

getLanguageHints in interface OcrParamsOrBuilder

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 languages to use for OCR. In most cases, an empty value
 yields the best results since it enables automatic language detection. For
 languages based on the Latin alphabet, setting `language_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). Document processing returns an
 error if one or more of the specified languages is not one of the
 supported languages.
 

repeated string language_hints = 1;

Specified by:

getLanguageHintsBytes in interface OcrParamsOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the languageHints 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.GeneratedMessageV3

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

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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 OcrParams parseFrom(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OcrParams parseFrom(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OcrParams parseFrom(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OcrParams parseFrom(InputStream input)
                           throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static OcrParams parseDelimitedFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static OcrParams parseFrom(com.google.protobuf.CodedInputStream input)
                           throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public OcrParams.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static OcrParams.Builder newBuilder()

newBuilder

public static OcrParams.Builder newBuilder(OcrParams prototype)

toBuilder

public OcrParams.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected OcrParams.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static OcrParams getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<OcrParams> 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.GeneratedMessageV3

getDefaultInstanceForType

public OcrParams getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder