Class Word.Builder (3.45.0)

public static final class Word.Builder extends GeneratedMessageV3.Builder<Word.Builder> implements WordOrBuilder

A word representation.

Protobuf type google.cloud.vision.v1p3beta1.Word

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Word.Builder

Implements

WordOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllSymbols(Iterable<? extends Symbol> values)

public Word.Builder addAllSymbols(Iterable<? extends Symbol> values)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Parameter
Name	Description
`values`	`Iterable<? extends com.google.cloud.vision.v1p3beta1.Symbol>`

Returns
Type	Description
`Word.Builder`

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Word.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Word.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addSymbols(Symbol value)

public Word.Builder addSymbols(Symbol value)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Parameter
Name	Description
`value`	`Symbol`

Returns
Type	Description
`Word.Builder`

addSymbols(Symbol.Builder builderForValue)

public Word.Builder addSymbols(Symbol.Builder builderForValue)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Parameter
Name	Description
`builderForValue`	`Symbol.Builder`

Returns
Type	Description
`Word.Builder`

addSymbols(int index, Symbol value)

public Word.Builder addSymbols(int index, Symbol value)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Parameters
Name	Description
`index`	`int`
`value`	`Symbol`

Returns
Type	Description
`Word.Builder`

addSymbols(int index, Symbol.Builder builderForValue)

public Word.Builder addSymbols(int index, Symbol.Builder builderForValue)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Symbol.Builder`

Returns
Type	Description
`Word.Builder`

addSymbolsBuilder()

public Symbol.Builder addSymbolsBuilder()

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Returns
Type	Description
`Symbol.Builder`

addSymbolsBuilder(int index)

public Symbol.Builder addSymbolsBuilder(int index)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Symbol.Builder`

build()

public Word build()

Returns
Type	Description
`Word`

buildPartial()

public Word buildPartial()

Returns
Type	Description
`Word`

clear()

public Word.Builder clear()

Returns
Type	Description
`Word.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBoundingBox()

public Word.Builder clearBoundingBox()

The bounding box for the word. The vertices are in the order of top-left, top-right, bottom-right, bottom-left. When a rotation of the bounding box is detected the rotation is represented as around the top-left corner as defined when the text is read in the 'natural' orientation. For example:

when the text is horizontal it might look like: 0----1 | | 3----2
when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3).

.google.cloud.vision.v1p3beta1.BoundingPoly bounding_box = 2;

Returns
Type	Description
`Word.Builder`

clearConfidence()

public Word.Builder clearConfidence()

Confidence of the OCR results for the word. Range [0, 1].

float confidence = 4;

Returns
Type	Description
`Word.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Word.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`Word.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public Word.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`Word.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearProperty()

public Word.Builder clearProperty()

Additional information detected for the word.

.google.cloud.vision.v1p3beta1.TextAnnotation.TextProperty property = 1;

Returns
Type	Description
`Word.Builder`

clearSymbols()

public Word.Builder clearSymbols()

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Returns
Type	Description
`Word.Builder`

clone()

public Word.Builder clone()

Returns
Type	Description
`Word.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getBoundingBox()

public BoundingPoly getBoundingBox()

when the text is horizontal it might look like: 0----1 | | 3----2
when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3).

.google.cloud.vision.v1p3beta1.BoundingPoly bounding_box = 2;

Returns
Type	Description
`BoundingPoly`	The boundingBox.

getBoundingBoxBuilder()

public BoundingPoly.Builder getBoundingBoxBuilder()

when the text is horizontal it might look like: 0----1 | | 3----2
when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3).

.google.cloud.vision.v1p3beta1.BoundingPoly bounding_box = 2;

Returns
Type	Description
`BoundingPoly.Builder`

getBoundingBoxOrBuilder()

public BoundingPolyOrBuilder getBoundingBoxOrBuilder()

when the text is horizontal it might look like: 0----1 | | 3----2
when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3).

.google.cloud.vision.v1p3beta1.BoundingPoly bounding_box = 2;

Returns
Type	Description
`BoundingPolyOrBuilder`

getConfidence()

public float getConfidence()

Confidence of the OCR results for the word. Range [0, 1].

float confidence = 4;

Returns
Type	Description
`float`	The confidence.

getDefaultInstanceForType()

public Word getDefaultInstanceForType()

Returns
Type	Description
`Word`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getProperty()

public TextAnnotation.TextProperty getProperty()

Additional information detected for the word.

.google.cloud.vision.v1p3beta1.TextAnnotation.TextProperty property = 1;

Returns
Type	Description
`TextAnnotation.TextProperty`	The property.

getPropertyBuilder()

public TextAnnotation.TextProperty.Builder getPropertyBuilder()

Additional information detected for the word.

.google.cloud.vision.v1p3beta1.TextAnnotation.TextProperty property = 1;

Returns
Type	Description
`TextAnnotation.TextProperty.Builder`

getPropertyOrBuilder()

public TextAnnotation.TextPropertyOrBuilder getPropertyOrBuilder()

Additional information detected for the word.

.google.cloud.vision.v1p3beta1.TextAnnotation.TextProperty property = 1;

Returns
Type	Description
`TextAnnotation.TextPropertyOrBuilder`

getSymbols(int index)

public Symbol getSymbols(int index)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Symbol`

getSymbolsBuilder(int index)

public Symbol.Builder getSymbolsBuilder(int index)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Symbol.Builder`

getSymbolsBuilderList()

public List<Symbol.Builder> getSymbolsBuilderList()

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Returns
Type	Description
`List<Builder>`

getSymbolsCount()

public int getSymbolsCount()

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Returns
Type	Description
`int`

getSymbolsList()

public List<Symbol> getSymbolsList()

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Returns
Type	Description
`List<Symbol>`

getSymbolsOrBuilder(int index)

public SymbolOrBuilder getSymbolsOrBuilder(int index)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SymbolOrBuilder`

getSymbolsOrBuilderList()

public List<? extends SymbolOrBuilder> getSymbolsOrBuilderList()

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Returns
Type	Description
`List<? extends com.google.cloud.vision.v1p3beta1.SymbolOrBuilder>`

hasBoundingBox()

public boolean hasBoundingBox()

when the text is horizontal it might look like: 0----1 | | 3----2
when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3).

.google.cloud.vision.v1p3beta1.BoundingPoly bounding_box = 2;

Returns
Type	Description
`boolean`	Whether the boundingBox field is set.

hasProperty()

public boolean hasProperty()

Additional information detected for the word.

.google.cloud.vision.v1p3beta1.TextAnnotation.TextProperty property = 1;

Returns
Type	Description
`boolean`	Whether the property field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeBoundingBox(BoundingPoly value)

public Word.Builder mergeBoundingBox(BoundingPoly value)

when the text is horizontal it might look like: 0----1 | | 3----2
when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3).

.google.cloud.vision.v1p3beta1.BoundingPoly bounding_box = 2;

Parameter
Name	Description
`value`	`BoundingPoly`

Returns
Type	Description
`Word.Builder`

mergeFrom(Word other)

public Word.Builder mergeFrom(Word other)

Parameter
Name	Description
`other`	`Word`

Returns
Type	Description
`Word.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Word.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Word.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Word.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Word.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeProperty(TextAnnotation.TextProperty value)

public Word.Builder mergeProperty(TextAnnotation.TextProperty value)

Additional information detected for the word.

.google.cloud.vision.v1p3beta1.TextAnnotation.TextProperty property = 1;

Parameter
Name	Description
`value`	`TextAnnotation.TextProperty`

Returns
Type	Description
`Word.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Word.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Word.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeSymbols(int index)

public Word.Builder removeSymbols(int index)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Word.Builder`

setBoundingBox(BoundingPoly value)

public Word.Builder setBoundingBox(BoundingPoly value)

when the text is horizontal it might look like: 0----1 | | 3----2
when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3).

.google.cloud.vision.v1p3beta1.BoundingPoly bounding_box = 2;

Parameter
Name	Description
`value`	`BoundingPoly`

Returns
Type	Description
`Word.Builder`

setBoundingBox(BoundingPoly.Builder builderForValue)

public Word.Builder setBoundingBox(BoundingPoly.Builder builderForValue)

when the text is horizontal it might look like: 0----1 | | 3----2
when it's rotated 180 degrees around the top-left corner it becomes: 2----3 | | 1----0 and the vertice order will still be (0, 1, 2, 3).

.google.cloud.vision.v1p3beta1.BoundingPoly bounding_box = 2;

Parameter
Name	Description
`builderForValue`	`BoundingPoly.Builder`

Returns
Type	Description
`Word.Builder`

setConfidence(float value)

public Word.Builder setConfidence(float value)

Confidence of the OCR results for the word. Range [0, 1].

float confidence = 4;

Parameter
Name	Description
`value`	`float` The confidence to set.

Returns
Type	Description
`Word.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Word.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Word.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setProperty(TextAnnotation.TextProperty value)

public Word.Builder setProperty(TextAnnotation.TextProperty value)

Additional information detected for the word.

.google.cloud.vision.v1p3beta1.TextAnnotation.TextProperty property = 1;

Parameter
Name	Description
`value`	`TextAnnotation.TextProperty`

Returns
Type	Description
`Word.Builder`

setProperty(TextAnnotation.TextProperty.Builder builderForValue)

public Word.Builder setProperty(TextAnnotation.TextProperty.Builder builderForValue)

Additional information detected for the word.

.google.cloud.vision.v1p3beta1.TextAnnotation.TextProperty property = 1;

Parameter
Name	Description
`builderForValue`	`TextAnnotation.TextProperty.Builder`

Returns
Type	Description
`Word.Builder`

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Word.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`Word.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSymbols(int index, Symbol value)

public Word.Builder setSymbols(int index, Symbol value)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Parameters
Name	Description
`index`	`int`
`value`	`Symbol`

Returns
Type	Description
`Word.Builder`

setSymbols(int index, Symbol.Builder builderForValue)

public Word.Builder setSymbols(int index, Symbol.Builder builderForValue)

List of symbols in the word. The order of the symbols follows the natural reading order.

repeated .google.cloud.vision.v1p3beta1.Symbol symbols = 3;

Parameters
Name	Description
`index`	`int`
`builderForValue`	`Symbol.Builder`

Returns
Type	Description
`Word.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final Word.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Word.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)