Package com.google.cloud.documentai.v1beta1

Class OcrParams.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<OcrParams.Builder>

com.google.cloud.documentai.v1beta1.OcrParams.Builder

All Implemented Interfaces:

OcrParamsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

OcrParams

public static final class OcrParams.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<OcrParams.Builder>
implements OcrParamsOrBuilder

 Parameters to control Optical Character Recognition (OCR) behavior.
 

Protobuf type google.cloud.documentai.v1beta1.OcrParams

Method Summary

Modifier and Type	Method	Description
OcrParams.Builder	addAllLanguageHints(Iterable<String> values)	List of languages to use for OCR.
OcrParams.Builder	addLanguageHints(String value)	List of languages to use for OCR.
OcrParams.Builder	addLanguageHintsBytes(com.google.protobuf.ByteString value)	List of languages to use for OCR.
OcrParams.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
OcrParams	build()
OcrParams	buildPartial()
OcrParams.Builder	clear()
OcrParams.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
OcrParams.Builder	clearLanguageHints()	List of languages to use for OCR.
OcrParams.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
OcrParams.Builder	clone()
OcrParams	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
OcrParams.Builder	mergeFrom(OcrParams other)
OcrParams.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
OcrParams.Builder	mergeFrom(com.google.protobuf.Message other)
OcrParams.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
OcrParams.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
OcrParams.Builder	setLanguageHints(int index, String value)	List of languages to use for OCR.
OcrParams.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
OcrParams.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

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

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, 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 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<OcrParams.Builder>

clear

public OcrParams.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<OcrParams.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<OcrParams.Builder>

getDefaultInstanceForType

public OcrParams getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public OcrParams build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public OcrParams buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public OcrParams.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<OcrParams.Builder>

setField

public OcrParams.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<OcrParams.Builder>

clearField

public OcrParams.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<OcrParams.Builder>

clearOneof

public OcrParams.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<OcrParams.Builder>

setRepeatedField

public OcrParams.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<OcrParams.Builder>

addRepeatedField

public OcrParams.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<OcrParams.Builder>

mergeFrom

public OcrParams.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<OcrParams.Builder>

mergeFrom

public OcrParams.Builder mergeFrom(OcrParams other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<OcrParams.Builder>

mergeFrom

public OcrParams.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<OcrParams.Builder>

Throws:

IOException

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.

setLanguageHints

public OcrParams.Builder setLanguageHints(int index,
                                          String value)

 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;

Parameters:

index - The index to set the value at.

value - The languageHints to set.

Returns:

This builder for chaining.

addLanguageHints

public OcrParams.Builder addLanguageHints(String value)

 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;

Parameters:

value - The languageHints to add.

Returns:

This builder for chaining.

addAllLanguageHints

public OcrParams.Builder addAllLanguageHints(Iterable<String> values)

 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;

Parameters:

values - The languageHints to add.

Returns:

This builder for chaining.

clearLanguageHints

public OcrParams.Builder clearLanguageHints()

 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;

Returns:

This builder for chaining.

addLanguageHintsBytes

public OcrParams.Builder addLanguageHintsBytes(com.google.protobuf.ByteString value)

 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;

Parameters:

value - The bytes of the languageHints to add.

Returns:

This builder for chaining.

setUnknownFields

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

mergeUnknownFields

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