Word (Google Cloud Vision Parent 3.1.3 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.vision.v1.Word

All Implemented Interfaces:

WordOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable
```
public final class Word
extends GeneratedMessageV3
implements WordOrBuilder
```
```
 A word representation.
 
```
Protobuf type google.cloud.vision.v1.Word
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Word.Builder
A word representation.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  AbstractMessageLite.InternalOneOfEnum

Nested Classes
Modifier and Type	Class and Description
`static class`	`Word.Builder` A word representation.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BOUNDING_BOX_FIELD_NUMBER`
`static int`	`CONFIDENCE_FIELD_NUMBER`
`static int`	`PROPERTY_FIELD_NUMBER`
`static int`	`SYMBOLS_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`BoundingPoly`	`getBoundingBox()` The bounding box for the word.
`BoundingPolyOrBuilder`	`getBoundingBoxOrBuilder()` The bounding box for the word.
`float`	`getConfidence()` Confidence of the OCR results for the word.
`static Word`	`getDefaultInstance()`
`Word`	`getDefaultInstanceForType()`
`static Descriptors.Descriptor`	`getDescriptor()`
`Parser<Word>`	`getParserForType()`
`TextAnnotation.TextProperty`	`getProperty()` Additional information detected for the word.
`TextAnnotation.TextPropertyOrBuilder`	`getPropertyOrBuilder()` Additional information detected for the word.
`int`	`getSerializedSize()`
`Symbol`	`getSymbols(int index)` List of symbols in the word.
`int`	`getSymbolsCount()` List of symbols in the word.
`List<Symbol>`	`getSymbolsList()` List of symbols in the word.
`SymbolOrBuilder`	`getSymbolsOrBuilder(int index)` List of symbols in the word.
`List<? extends SymbolOrBuilder>`	`getSymbolsOrBuilderList()` List of symbols in the word.
`UnknownFieldSet`	`getUnknownFields()`
`boolean`	`hasBoundingBox()` The bounding box for the word.
`int`	`hashCode()`
`boolean`	`hasProperty()` Additional information detected for the word.
`protected GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Word.Builder`	`newBuilder()`
`static Word.Builder`	`newBuilder(Word prototype)`
`Word.Builder`	`newBuilderForType()`
`protected Word.Builder`	`newBuilderForType(GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Word`	`parseDelimitedFrom(InputStream input)`
`static Word`	`parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Word`	`parseFrom(byte[] data)`
`static Word`	`parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)`
`static Word`	`parseFrom(ByteBuffer data)`
`static Word`	`parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)`
`static Word`	`parseFrom(ByteString data)`
`static Word`	`parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)`
`static Word`	`parseFrom(CodedInputStream input)`
`static Word`	`parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)`
`static Word`	`parseFrom(InputStream input)`
`static Word`	`parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)`
`static Parser<Word>`	`parser()`
`Word.Builder`	`toBuilder()`
`void`	`writeTo(CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- PROPERTY_FIELD_NUMBER
```
public static final int PROPERTY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BOUNDING_BOX_FIELD_NUMBER
```
public static final int BOUNDING_BOX_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SYMBOLS_FIELD_NUMBER
```
public static final int SYMBOLS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CONFIDENCE_FIELD_NUMBER
```
public static final int CONFIDENCE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class GeneratedMessageV3

getUnknownFields
```
public final UnknownFieldSet getUnknownFields()
```
Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

hasProperty
```
public boolean hasProperty()
```
```
 Additional information detected for the word.
 
```
.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;
Specified by:

hasProperty in interface WordOrBuilder

Returns:

Whether the property field is set.

getProperty
```
public TextAnnotation.TextProperty getProperty()
```
```
 Additional information detected for the word.
 
```
.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;
Specified by:

getProperty in interface WordOrBuilder

Returns:

The property.

getPropertyOrBuilder
```
public TextAnnotation.TextPropertyOrBuilder getPropertyOrBuilder()
```
```
 Additional information detected for the word.
 
```
.google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;
Specified by:

getPropertyOrBuilder in interface WordOrBuilder

hasBoundingBox

public boolean hasBoundingBox()

 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 vertex order will still be (0, 1, 2, 3).

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

Specified by:: hasBoundingBox in interface WordOrBuilder
Returns:: Whether the boundingBox field is set.

getBoundingBox

public BoundingPoly getBoundingBox()

 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 vertex order will still be (0, 1, 2, 3).

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

Specified by:: getBoundingBox in interface WordOrBuilder
Returns:: The boundingBox.

getBoundingBoxOrBuilder

public BoundingPolyOrBuilder getBoundingBoxOrBuilder()

 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 vertex order will still be (0, 1, 2, 3).

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

Specified by:: getBoundingBoxOrBuilder in interface WordOrBuilder