Class Symbol.Builder (3.42.0)

public static final class Symbol.Builder extends GeneratedMessageV3.Builder<Symbol.Builder> implements SymbolOrBuilder

A single symbol representation.

Protobuf type google.cloud.vision.v1.Symbol

Implements

SymbolOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Symbol.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Symbol.Builder
Overrides

build()

public Symbol build()
Returns
Type Description
Symbol

buildPartial()

public Symbol buildPartial()
Returns
Type Description
Symbol

clear()

public Symbol.Builder clear()
Returns
Type Description
Symbol.Builder
Overrides

clearBoundingBox()

public Symbol.Builder clearBoundingBox()

The bounding box for the symbol. 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 vertex order will still be (0, 1, 2, 3).

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

Returns
Type Description
Symbol.Builder

clearConfidence()

public Symbol.Builder clearConfidence()

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

float confidence = 4;

Returns
Type Description
Symbol.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Symbol.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Symbol.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Symbol.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Symbol.Builder
Overrides

clearProperty()

public Symbol.Builder clearProperty()

Additional information detected for the symbol.

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

Returns
Type Description
Symbol.Builder

clearText()

public Symbol.Builder clearText()

The actual UTF-8 representation of the symbol.

string text = 3;

Returns
Type Description
Symbol.Builder

This builder for chaining.

clone()

public Symbol.Builder clone()
Returns
Type Description
Symbol.Builder
Overrides

getBoundingBox()

public BoundingPoly getBoundingBox()

The bounding box for the symbol. 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 vertex order will still be (0, 1, 2, 3).

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

Returns
Type Description
BoundingPoly

The boundingBox.

getBoundingBoxBuilder()

public BoundingPoly.Builder getBoundingBoxBuilder()

The bounding box for the symbol. 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 vertex order will still be (0, 1, 2, 3).

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

Returns
Type Description
BoundingPoly.Builder

getBoundingBoxOrBuilder()

public BoundingPolyOrBuilder getBoundingBoxOrBuilder()

The bounding box for the symbol. 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 vertex order will still be (0, 1, 2, 3).

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

Returns
Type Description
BoundingPolyOrBuilder

getConfidence()

public float getConfidence()

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

float confidence = 4;

Returns
Type Description
float

The confidence.

getDefaultInstanceForType()

public Symbol getDefaultInstanceForType()
Returns
Type Description
Symbol

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getProperty()

public TextAnnotation.TextProperty getProperty()

Additional information detected for the symbol.

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

Returns
Type Description
TextAnnotation.TextProperty

The property.

getPropertyBuilder()

public TextAnnotation.TextProperty.Builder getPropertyBuilder()

Additional information detected for the symbol.

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

Returns
Type Description
TextAnnotation.TextProperty.Builder

getPropertyOrBuilder()

public TextAnnotation.TextPropertyOrBuilder getPropertyOrBuilder()

Additional information detected for the symbol.

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

Returns
Type Description
TextAnnotation.TextPropertyOrBuilder

getText()

public String getText()

The actual UTF-8 representation of the symbol.

string text = 3;

Returns
Type Description
String

The text.

getTextBytes()

public ByteString getTextBytes()

The actual UTF-8 representation of the symbol.

string text = 3;

Returns
Type Description
ByteString

The bytes for text.

hasBoundingBox()

public boolean hasBoundingBox()

The bounding box for the symbol. 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 vertex order will still be (0, 1, 2, 3).

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

Returns
Type Description
boolean

Whether the boundingBox field is set.

hasProperty()

public boolean hasProperty()

Additional information detected for the symbol.

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

Returns
Type Description
boolean

Whether the property field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBoundingBox(BoundingPoly value)

public Symbol.Builder mergeBoundingBox(BoundingPoly value)

The bounding box for the symbol. 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 vertex order will still be (0, 1, 2, 3).

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

Parameter
Name Description
value BoundingPoly
Returns
Type Description
Symbol.Builder

mergeFrom(Symbol other)

public Symbol.Builder mergeFrom(Symbol other)
Parameter
Name Description
other Symbol
Returns
Type Description
Symbol.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Symbol.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Symbol.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Symbol.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Symbol.Builder
Overrides

mergeProperty(TextAnnotation.TextProperty value)

public Symbol.Builder mergeProperty(TextAnnotation.TextProperty value)

Additional information detected for the symbol.

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

Parameter
Name Description
value TextAnnotation.TextProperty
Returns
Type Description
Symbol.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Symbol.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Symbol.Builder
Overrides

setBoundingBox(BoundingPoly value)

public Symbol.Builder setBoundingBox(BoundingPoly value)

The bounding box for the symbol. 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 vertex order will still be (0, 1, 2, 3).

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

Parameter
Name Description
value BoundingPoly
Returns
Type Description
Symbol.Builder

setBoundingBox(BoundingPoly.Builder builderForValue)

public Symbol.Builder setBoundingBox(BoundingPoly.Builder builderForValue)

The bounding box for the symbol. 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 vertex order will still be (0, 1, 2, 3).

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

Parameter
Name Description
builderForValue BoundingPoly.Builder
Returns
Type Description
Symbol.Builder

setConfidence(float value)

public Symbol.Builder setConfidence(float value)

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

float confidence = 4;

Parameter
Name Description
value float

The confidence to set.

Returns
Type Description
Symbol.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Symbol.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Symbol.Builder
Overrides

setProperty(TextAnnotation.TextProperty value)

public Symbol.Builder setProperty(TextAnnotation.TextProperty value)

Additional information detected for the symbol.

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

Parameter
Name Description
value TextAnnotation.TextProperty
Returns
Type Description
Symbol.Builder

setProperty(TextAnnotation.TextProperty.Builder builderForValue)

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

Additional information detected for the symbol.

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

Parameter
Name Description
builderForValue TextAnnotation.TextProperty.Builder
Returns
Type Description
Symbol.Builder

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

public Symbol.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Symbol.Builder
Overrides

setText(String value)

public Symbol.Builder setText(String value)

The actual UTF-8 representation of the symbol.

string text = 3;

Parameter
Name Description
value String

The text to set.

Returns
Type Description
Symbol.Builder

This builder for chaining.

setTextBytes(ByteString value)

public Symbol.Builder setTextBytes(ByteString value)

The actual UTF-8 representation of the symbol.

string text = 3;

Parameter
Name Description
value ByteString

The bytes for text to set.

Returns
Type Description
Symbol.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Symbol.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Symbol.Builder
Overrides