com.google.cloud.vision.v1

Class Block

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.vision.v1.Block

All Implemented Interfaces:

BlockOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

public final class Block
extends GeneratedMessageV3
implements BlockOrBuilder

 Logical element on the page.
 

Protobuf type google.cloud.vision.v1.Block

See Also:

Serialized Form

Property Summary

Type	Property and Description
boolean	has Additional information detected for the block.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Block.BlockType Type of a block (text, image etc) as identified by OCR.
static class	Block.Builder Logical element on the page.

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

Field Summary

Fields

Modifier and Type	Field and Description
static int	BLOCK_TYPE_FIELD_NUMBER
static int	BOUNDING_BOX_FIELD_NUMBER
static int	CONFIDENCE_FIELD_NUMBER
static int	PARAGRAPHS_FIELD_NUMBER
static int	PROPERTY_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

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
Block.BlockType	getBlockType() Detected block type (text, image etc) for this block.
int	getBlockTypeValue() Detected block type (text, image etc) for this block.
BoundingPoly	getBoundingBox() The bounding box for the block.
BoundingPolyOrBuilder	getBoundingBoxOrBuilder() The bounding box for the block.
float	getConfidence() Confidence of the OCR results on the block.
static Block	getDefaultInstance()
Block	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Paragraph	getParagraphs(int index) List of paragraphs in this block (if this blocks is of type text).
int	getParagraphsCount() List of paragraphs in this block (if this blocks is of type text).
java.util.List<Paragraph>	getParagraphsList() List of paragraphs in this block (if this blocks is of type text).
ParagraphOrBuilder	getParagraphsOrBuilder(int index) List of paragraphs in this block (if this blocks is of type text).
java.util.List<? extends ParagraphOrBuilder>	getParagraphsOrBuilderList() List of paragraphs in this block (if this blocks is of type text).
Parser<Block>	getParserForType()
TextAnnotation.TextProperty	getProperty() Additional information detected for the block.
TextAnnotation.TextPropertyOrBuilder	getPropertyOrBuilder() Additional information detected for the block.
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
boolean	hasBoundingBox() The bounding box for the block.
int	hashCode()
boolean	hasProperty() Additional information detected for the block.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Block.Builder	newBuilder()
static Block.Builder	newBuilder(Block prototype)
Block.Builder	newBuilderForType()
protected Block.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static Block	parseDelimitedFrom(java.io.InputStream input)
static Block	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Block	parseFrom(byte[] data)
static Block	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Block	parseFrom(java.nio.ByteBuffer data)
static Block	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Block	parseFrom(ByteString data)
static Block	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Block	parseFrom(CodedInputStream input)
static Block	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Block	parseFrom(java.io.InputStream input)
static Block	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<Block>	parser()
Block.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, newBuilderForType, 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

Property Detail

has

public boolean hasProperty

 Additional information detected for the block.
 

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

Specified by:

hasProperty in interface BlockOrBuilder

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

PARAGRAPHS_FIELD_NUMBER

public static final int PARAGRAPHS_FIELD_NUMBER

See Also:

Constant Field Values

BLOCK_TYPE_FIELD_NUMBER

public static final int BLOCK_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

CONFIDENCE_FIELD_NUMBER

public static final int CONFIDENCE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

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

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

Specified by:

hasProperty in interface BlockOrBuilder

getProperty

public TextAnnotation.TextProperty getProperty()

 Additional information detected for the block.
 

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

Specified by:

getProperty in interface BlockOrBuilder

getPropertyOrBuilder

public TextAnnotation.TextPropertyOrBuilder getPropertyOrBuilder()

 Additional information detected for the block.
 

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

Specified by:

getPropertyOrBuilder in interface BlockOrBuilder

hasBoundingBox

public boolean hasBoundingBox()

 The bounding box for the block.
 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.v1.BoundingPoly bounding_box = 2;

Specified by:

hasBoundingBox in interface BlockOrBuilder

getBoundingBox

public BoundingPoly getBoundingBox()

 The bounding box for the block.
 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.v1.BoundingPoly bounding_box = 2;

Specified by:

getBoundingBox in interface BlockOrBuilder

getBoundingBoxOrBuilder

public BoundingPolyOrBuilder getBoundingBoxOrBuilder()

 The bounding box for the block.
 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.v1.BoundingPoly bounding_box = 2;

Specified by:

getBoundingBoxOrBuilder in interface BlockOrBuilder

getParagraphsList

public java.util.List<Paragraph> getParagraphsList()

 List of paragraphs in this block (if this blocks is of type text).
 

repeated .google.cloud.vision.v1.Paragraph paragraphs = 3;

Specified by:

getParagraphsList in interface BlockOrBuilder

getParagraphsOrBuilderList

public java.util.List<? extends ParagraphOrBuilder> getParagraphsOrBuilderList()

 List of paragraphs in this block (if this blocks is of type text).
 

repeated .google.cloud.vision.v1.Paragraph paragraphs = 3;

Specified by:

getParagraphsOrBuilderList in interface BlockOrBuilder

getParagraphsCount

public int getParagraphsCount()

 List of paragraphs in this block (if this blocks is of type text).
 

repeated .google.cloud.vision.v1.Paragraph paragraphs = 3;

Specified by:

getParagraphsCount in interface BlockOrBuilder

getParagraphs

public Paragraph getParagraphs(int index)

 List of paragraphs in this block (if this blocks is of type text).
 

repeated .google.cloud.vision.v1.Paragraph paragraphs = 3;

Specified by:

getParagraphs in interface BlockOrBuilder

getParagraphsOrBuilder

public ParagraphOrBuilder getParagraphsOrBuilder(int index)

 List of paragraphs in this block (if this blocks is of type text).
 

repeated .google.cloud.vision.v1.Paragraph paragraphs = 3;

Specified by:

getParagraphsOrBuilder in interface BlockOrBuilder

getBlockTypeValue

public int getBlockTypeValue()

 Detected block type (text, image etc) for this block.
 

.google.cloud.vision.v1.Block.BlockType block_type = 4;

Specified by:

getBlockTypeValue in interface BlockOrBuilder

getBlockType

public Block.BlockType getBlockType()

 Detected block type (text, image etc) for this block.
 

.google.cloud.vision.v1.Block.BlockType block_type = 4;

Specified by:

getBlockType in interface BlockOrBuilder

getConfidence

public float getConfidence()

 Confidence of the OCR results on the block. Range [0, 1].
 

float confidence = 5;

Specified by:

getConfidence in interface BlockOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static Block parseFrom(java.nio.ByteBuffer data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Block parseFrom(java.nio.ByteBuffer data,
                              ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Block parseFrom(ByteString data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Block parseFrom(ByteString data,
                              ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Block parseFrom(byte[] data)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Block parseFrom(byte[] data,
                              ExtensionRegistryLite extensionRegistry)
                       throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Block parseFrom(java.io.InputStream input)
                       throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Block parseFrom(java.io.InputStream input,
                              ExtensionRegistryLite extensionRegistry)
                       throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Block parseDelimitedFrom(java.io.InputStream input)
                                throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Block parseDelimitedFrom(java.io.InputStream input,
                                       ExtensionRegistryLite extensionRegistry)
                                throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Block parseFrom(CodedInputStream input)
                       throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Block parseFrom(CodedInputStream input,
                              ExtensionRegistryLite extensionRegistry)
                       throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Block.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Block.Builder newBuilder()

newBuilder

public static Block.Builder newBuilder(Block prototype)

toBuilder

public Block.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Block.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Block getDefaultInstance()

parser

public static Parser<Block> parser()

getParserForType

public Parser<Block> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public Block getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder