Class Block (3.21.0)

public final class Block extends GeneratedMessageV3 implements BlockOrBuilder

Logical element on the page.

Protobuf type google.cloud.vision.v1p2beta1.Block

Implements

BlockOrBuilder

Static Fields

BLOCK_TYPE_FIELD_NUMBER

public static final int BLOCK_TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

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

PARAGRAPHS_FIELD_NUMBER

public static final int PARAGRAPHS_FIELD_NUMBER
Field Value
TypeDescription
int

PROPERTY_FIELD_NUMBER

public static final int PROPERTY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Block getDefaultInstance()
Returns
TypeDescription
Block

getDescriptor()

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

newBuilder()

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

newBuilder(Block prototype)

public static Block.Builder newBuilder(Block prototype)
Parameter
NameDescription
prototypeBlock
Returns
TypeDescription
Block.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBlockType()

public Block.BlockType getBlockType()

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

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

Returns
TypeDescription
Block.BlockType

The blockType.

getBlockTypeValue()

public int getBlockTypeValue()

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

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

Returns
TypeDescription
int

The enum numeric value on the wire for blockType.

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.v1p2beta1.BoundingPoly bounding_box = 2;

Returns
TypeDescription
BoundingPoly

The boundingBox.

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.v1p2beta1.BoundingPoly bounding_box = 2;

Returns
TypeDescription
BoundingPolyOrBuilder

getConfidence()

public float getConfidence()

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

float confidence = 5;

Returns
TypeDescription
float

The confidence.

getDefaultInstanceForType()

public Block getDefaultInstanceForType()
Returns
TypeDescription
Block

getParagraphs(int index)

public Paragraph getParagraphs(int index)

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
Paragraph

getParagraphsCount()

public int getParagraphsCount()

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

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

Returns
TypeDescription
int

getParagraphsList()

public List<Paragraph> getParagraphsList()

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

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

Returns
TypeDescription
List<Paragraph>

getParagraphsOrBuilder(int index)

public ParagraphOrBuilder getParagraphsOrBuilder(int index)

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

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

Parameter
NameDescription
indexint
Returns
TypeDescription
ParagraphOrBuilder

getParagraphsOrBuilderList()

public List<? extends ParagraphOrBuilder> getParagraphsOrBuilderList()

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

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

Returns
TypeDescription
List<? extends com.google.cloud.vision.v1p2beta1.ParagraphOrBuilder>

getParserForType()

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

getProperty()

public TextAnnotation.TextProperty getProperty()

Additional information detected for the block.

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

Returns
TypeDescription
TextAnnotation.TextProperty

The property.

getPropertyOrBuilder()

public TextAnnotation.TextPropertyOrBuilder getPropertyOrBuilder()

Additional information detected for the block.

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

Returns
TypeDescription
TextAnnotation.TextPropertyOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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.v1p2beta1.BoundingPoly bounding_box = 2;

Returns
TypeDescription
boolean

Whether the boundingBox field is set.

hasProperty()

public boolean hasProperty()

Additional information detected for the block.

.google.cloud.vision.v1p2beta1.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 Block.Builder newBuilderForType()
Returns
TypeDescription
Block.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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