Class Symbol (3.17.0)

public final class Symbol extends GeneratedMessageV3 implements SymbolOrBuilder

A single symbol representation.

Protobuf type google.cloud.vision.v1p4beta1.Symbol

Implements

SymbolOrBuilder

Static Fields

BOUNDING_BOX_FIELD_NUMBER

public static final int BOUNDING_BOX_FIELD_NUMBER
Field Value
TypeDescription
int

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER
Field Value
TypeDescription
int

PROPERTY_FIELD_NUMBER

public static final int PROPERTY_FIELD_NUMBER
Field Value
TypeDescription
int

TEXT_FIELD_NUMBER

public static final int TEXT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Symbol getDefaultInstance()
Returns
TypeDescription
Symbol

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Symbol.Builder newBuilder()
Returns
TypeDescription
Symbol.Builder

newBuilder(Symbol prototype)

public static Symbol.Builder newBuilder(Symbol prototype)
Parameter
NameDescription
prototypeSymbol
Returns
TypeDescription
Symbol.Builder

parseDelimitedFrom(InputStream input)

public static Symbol parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Symbol
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Symbol parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Symbol
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Symbol parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Symbol
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Symbol parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Symbol
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Symbol parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Symbol
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Symbol parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Symbol
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Symbol parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Symbol
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Symbol parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Symbol
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Symbol parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Symbol
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Symbol parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Symbol
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Symbol parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Symbol
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Symbol parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Symbol
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Symbol> parser()
Returns
TypeDescription
Parser<Symbol>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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.v1p4beta1.BoundingPoly bounding_box = 2;

Returns
TypeDescription
BoundingPoly

The boundingBox.

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

getParserForType()

public Parser<Symbol> getParserForType()
Returns
TypeDescription
Parser<Symbol>
Overrides

getProperty()

public TextAnnotation.TextProperty getProperty()

Additional information detected for the symbol.

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

Returns
TypeDescription
TextAnnotation.TextProperty

The property.

getPropertyOrBuilder()

public TextAnnotation.TextPropertyOrBuilder getPropertyOrBuilder()

Additional information detected for the symbol.

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

Returns
TypeDescription
TextAnnotation.TextPropertyOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.v1p4beta1.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.v1p4beta1.TextAnnotation.TextProperty property = 1;

Returns
TypeDescription
boolean

Whether the property field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Symbol.Builder newBuilderForType()
Returns
TypeDescription
Symbol.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Symbol.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Symbol.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Symbol.Builder toBuilder()
Returns
TypeDescription
Symbol.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException