Package com.google.cloud.vision.v1

Class Block

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.vision.v1.Block
All Implemented Interfaces:
BlockOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Block extends com.google.protobuf.GeneratedMessage implements BlockOrBuilder
 Logical element on the page.
Protobuf type google.cloud.vision.v1.Block
See Also:

  • Nested Class Summary

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

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BLOCK_TYPE_FIELD_NUMBER
     
    static final int
    BOUNDING_BOX_FIELD_NUMBER
     
    static final int
    CONFIDENCE_FIELD_NUMBER
     
    static final int
    PARAGRAPHS_FIELD_NUMBER
     
    static final int
    PROPERTY_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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
    Description
    boolean
    equals(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 final com.google.protobuf.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).
    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).
    List<? extends ParagraphOrBuilder>
    getParagraphsOrBuilderList()
    List of paragraphs in this block (if this blocks is of type text).
    com.google.protobuf.Parser<Block>
    getParserForType()
     
    TextAnnotation.TextProperty
    getProperty()
    Additional information detected for the block.
    TextAnnotation.TextPropertyOrBuilder
    getPropertyOrBuilder()
    Additional information detected for the block.
    int
    getSerializedSize()
     
    boolean
    hasBoundingBox()
    The bounding box for the block.
    int
    hashCode()
     
    boolean
    hasProperty()
    Additional information detected for the block.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Block.Builder
    newBuilder()
     
    static Block.Builder
    newBuilder(Block prototype)
     
    Block.Builder
    newBuilderForType()
     
    protected Block.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Block
    parseDelimitedFrom(InputStream input)
     
    static Block
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Block
    parseFrom(byte[] data)
     
    static Block
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Block
    parseFrom(com.google.protobuf.ByteString data)
     
    static Block
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Block
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Block
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Block
    parseFrom(InputStream input)
     
    static Block
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Block
    parseFrom(ByteBuffer data)
     
    static Block
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Block>
    parser()
     
    Block.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

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

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • PROPERTY_FIELD_NUMBER

      public static final int PROPERTY_FIELD_NUMBER
      See Also:

    • BOUNDING_BOX_FIELD_NUMBER

      public static final int BOUNDING_BOX_FIELD_NUMBER
      See Also:

    • PARAGRAPHS_FIELD_NUMBER

      public static final int PARAGRAPHS_FIELD_NUMBER
      See Also:

    • BLOCK_TYPE_FIELD_NUMBER

      public static final int BLOCK_TYPE_FIELD_NUMBER
      See Also:

    • CONFIDENCE_FIELD_NUMBER

      public static final int CONFIDENCE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasProperty

      public boolean hasProperty()
       Additional information detected for the block.
      .google.cloud.vision.v1.TextAnnotation.TextProperty property = 1;
      Specified by:
      hasProperty in interface BlockOrBuilder
      Returns:
      Whether the property field is set.

    • 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
      Returns:
      The property.

    • 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 vertex order will still be (0, 1, 2, 3).
      .google.cloud.vision.v1.BoundingPoly bounding_box = 2;
      Specified by:
      hasBoundingBox in interface BlockOrBuilder
      Returns:
      Whether the boundingBox field is set.

    • 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 vertex order will still be (0, 1, 2, 3).
      .google.cloud.vision.v1.BoundingPoly bounding_box = 2;
      Specified by:
      getBoundingBox in interface BlockOrBuilder
      Returns:
      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 vertex order will still be (0, 1, 2, 3).
      .google.cloud.vision.v1.BoundingPoly bounding_box = 2;
      Specified by:
      getBoundingBoxOrBuilder in interface BlockOrBuilder

    • getParagraphsList

      public 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 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
      Returns:
      The enum numeric value on the wire for blockType.

    • 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
      Returns:
      The blockType.

    • getConfidence

      public float getConfidence()
       Confidence of the OCR results on the block. Range [0, 1].
      float confidence = 5;
      Specified by:
      getConfidence in interface BlockOrBuilder
      Returns:
      The confidence.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Block parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Block parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Block parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Block parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Block parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Block parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Block parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Block parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Block parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Block parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Block parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Block parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Block.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.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 com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Block.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Block getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Block> parser()

    • getParserForType

      public com.google.protobuf.Parser<Block> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Block getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder