Class Symbol.Builder (3.29.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Symbol.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Symbol.Builder
Overrides

build()

public Symbol build()
Returns
TypeDescription
Symbol

buildPartial()

public Symbol buildPartial()
Returns
TypeDescription
Symbol

clear()

public Symbol.Builder clear()
Returns
TypeDescription
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
TypeDescription
Symbol.Builder

clearConfidence()

public Symbol.Builder clearConfidence()

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

float confidence = 4;

Returns
TypeDescription
Symbol.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Symbol.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Symbol.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Symbol.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Symbol.Builder
Overrides

clearProperty()

public Symbol.Builder clearProperty()

Additional information detected for the symbol.

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

Returns
TypeDescription
Symbol.Builder

clearText()

public Symbol.Builder clearText()

The actual UTF-8 representation of the symbol.

string text = 3;

Returns
TypeDescription
Symbol.Builder

This builder for chaining.

clone()

public Symbol.Builder clone()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
BoundingPolyOrBuilder

getConfidence()

public float getConfidence()

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

float confidence = 4;

Returns
TypeDescription
float

The confidence.

getDefaultInstanceForType()

public Symbol getDefaultInstanceForType()
Returns
TypeDescription
Symbol

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getProperty()

public TextAnnotation.TextProperty getProperty()

Additional information detected for the symbol.

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

Returns
TypeDescription
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
TypeDescription
TextAnnotation.TextProperty.Builder

getPropertyOrBuilder()

public TextAnnotation.TextPropertyOrBuilder getPropertyOrBuilder()

Additional information detected for the symbol.

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

Returns
TypeDescription
TextAnnotation.TextPropertyOrBuilder

getText()

public String getText()

The actual UTF-8 representation of the symbol.

string text = 3;

Returns
TypeDescription
String

The text.

getTextBytes()

public ByteString getTextBytes()

The actual UTF-8 representation of the symbol.

string text = 3;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the property field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
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
NameDescription
valueBoundingPoly
Returns
TypeDescription
Symbol.Builder

mergeFrom(Symbol other)

public Symbol.Builder mergeFrom(Symbol other)
Parameter
NameDescription
otherSymbol
Returns
TypeDescription
Symbol.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Symbol.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Symbol.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Symbol.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueTextAnnotation.TextProperty
Returns
TypeDescription
Symbol.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Symbol.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valueBoundingPoly
Returns
TypeDescription
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
NameDescription
builderForValueBoundingPoly.Builder
Returns
TypeDescription
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
NameDescription
valuefloat

The confidence to set.

Returns
TypeDescription
Symbol.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Symbol.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueTextAnnotation.TextProperty
Returns
TypeDescription
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
NameDescription
builderForValueTextAnnotation.TextProperty.Builder
Returns
TypeDescription
Symbol.Builder

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

public Symbol.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Symbol.Builder
Overrides

setText(String value)

public Symbol.Builder setText(String value)

The actual UTF-8 representation of the symbol.

string text = 3;

Parameter
NameDescription
valueString

The text to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for text to set.

Returns
TypeDescription
Symbol.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Symbol.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Symbol.Builder
Overrides