Block (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.textract.model.Block

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Block
extends Object
implements Serializable, Cloneable, StructuredPojo
```
A Block represents items that are recognized in a document within a group of pixels close to each other. The information returned in a Block object depends on the type of operation. In text detection for documents (for example DetectDocumentText), you get information about the detected words and lines of text. In text analysis (for example AnalyzeDocument), you can also get information about the fields, tables, and selection elements that are detected in the document.

An array of Block objects is returned by both synchronous and asynchronous operations. In synchronous operations, such as DetectDocumentText, the array of Block objects is the entire set of results. In asynchronous operations, such as GetDocumentAnalysis, the array is returned over one or more responses.

For more information, see How Amazon Textract Works.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Block()

Constructors
Constructor and Description
`Block()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Block`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBlockType()` The type of text item that's recognized.
`Integer`	`getColumnIndex()` The column in which a table cell appears.
`Integer`	`getColumnSpan()` The number of columns that a table cell spans.
`Float`	`getConfidence()` The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
`List<String>`	`getEntityTypes()` The type of entity.
`Geometry`	`getGeometry()` The location of the recognized text on the image.
`String`	`getId()` The identifier for the recognized text.
`Integer`	`getPage()` The page on which a block was detected.
`List<Relationship>`	`getRelationships()` A list of child blocks of the current block.
`Integer`	`getRowIndex()` The row in which a table cell is located.
`Integer`	`getRowSpan()` The number of rows that a table cell spans.
`String`	`getSelectionStatus()` The selection status of a selection element, such as an option button or check box.
`String`	`getText()` The word or line of text that's recognized by Amazon Textract.
`String`	`getTextType()` The kind of text that Amazon Textract has detected.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBlockType(String blockType)` The type of text item that's recognized.
`void`	`setColumnIndex(Integer columnIndex)` The column in which a table cell appears.
`void`	`setColumnSpan(Integer columnSpan)` The number of columns that a table cell spans.
`void`	`setConfidence(Float confidence)` The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
`void`	`setEntityTypes(Collection<String> entityTypes)` The type of entity.
`void`	`setGeometry(Geometry geometry)` The location of the recognized text on the image.
`void`	`setId(String id)` The identifier for the recognized text.
`void`	`setPage(Integer page)` The page on which a block was detected.
`void`	`setRelationships(Collection<Relationship> relationships)` A list of child blocks of the current block.
`void`	`setRowIndex(Integer rowIndex)` The row in which a table cell is located.
`void`	`setRowSpan(Integer rowSpan)` The number of rows that a table cell spans.
`void`	`setSelectionStatus(String selectionStatus)` The selection status of a selection element, such as an option button or check box.
`void`	`setText(String text)` The word or line of text that's recognized by Amazon Textract.
`void`	`setTextType(String textType)` The kind of text that Amazon Textract has detected.
`String`	`toString()` Returns a string representation of this object.
`Block`	`withBlockType(BlockType blockType)` The type of text item that's recognized.
`Block`	`withBlockType(String blockType)` The type of text item that's recognized.
`Block`	`withColumnIndex(Integer columnIndex)` The column in which a table cell appears.
`Block`	`withColumnSpan(Integer columnSpan)` The number of columns that a table cell spans.
`Block`	`withConfidence(Float confidence)` The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
`Block`	`withEntityTypes(Collection<String> entityTypes)` The type of entity.
`Block`	`withEntityTypes(EntityType... entityTypes)` The type of entity.
`Block`	`withEntityTypes(String... entityTypes)` The type of entity.
`Block`	`withGeometry(Geometry geometry)` The location of the recognized text on the image.
`Block`	`withId(String id)` The identifier for the recognized text.
`Block`	`withPage(Integer page)` The page on which a block was detected.
`Block`	`withRelationships(Collection<Relationship> relationships)` A list of child blocks of the current block.
`Block`	`withRelationships(Relationship... relationships)` A list of child blocks of the current block.
`Block`	`withRowIndex(Integer rowIndex)` The row in which a table cell is located.
`Block`	`withRowSpan(Integer rowSpan)` The number of rows that a table cell spans.
`Block`	`withSelectionStatus(SelectionStatus selectionStatus)` The selection status of a selection element, such as an option button or check box.
`Block`	`withSelectionStatus(String selectionStatus)` The selection status of a selection element, such as an option button or check box.
`Block`	`withText(String text)` The word or line of text that's recognized by Amazon Textract.
`Block`	`withTextType(String textType)` The kind of text that Amazon Textract has detected.
`Block`	`withTextType(TextType textType)` The kind of text that Amazon Textract has detected.

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

- Constructor Detail
  - Block
```
public Block()
```
- Method Detail
  - setBlockType
```
public void setBlockType(String blockType)
```
    The type of text item that's recognized. In operations for text detection, the following types are returned:
    - PAGE - Contains a list of the LINE Block objects that are detected on a document page.
    - WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
    - LINE - A string of tab-delimited, contiguous words that are detected on a document page.
    In text analysis operations, the following types are returned:
    - PAGE - Contains a list of child Block objects that are detected on a document page.
    - KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
    - WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
    - LINE - A string of tab-delimited, contiguous words that are detected on a document page.
    - TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
    - CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
    - SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
    Parameters:
    blockType - The type of text item that's recognized. In operations for text detection, the following types are returned:
    
    PAGE - Contains a list of the LINE Block objects that are detected on a document page.
    
    WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
    
    LINE - A string of tab-delimited, contiguous words that are detected on a document page.
    
    In text analysis operations, the following types are returned:
    
    PAGE - Contains a list of child Block objects that are detected on a document page.
    
    KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
    
    WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
    
    LINE - A string of tab-delimited, contiguous words that are detected on a document page.
    
    TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
    
    CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
    
    SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
    See Also:
    
    BlockType
  - getBlockType
```
public String getBlockType()
```
    The type of text item that's recognized. In operations for text detection, the following types are returned:
    - PAGE - Contains a list of the LINE Block objects that are detected on a document page.
    - WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
    - LINE - A string of tab-delimited, contiguous words that are detected on a document page.
    In text analysis operations, the following types are returned:
    - PAGE - Contains a list of child Block objects that are detected on a document page.
    - KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
    - WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
    - LINE - A string of tab-delimited, contiguous words that are detected on a document page.
    - TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
    - CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
    - SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
    Returns:
    The type of text item that's recognized. In operations for text detection, the following types are returned:
    
    PAGE - Contains a list of the LINE Block objects that are detected on a document page.
    
    WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
    
    LINE - A string of tab-delimited, contiguous words that are detected on a document page.
    
    In text analysis operations, the following types are returned:
    
    PAGE - Contains a list of child Block objects that are detected on a document page.
    
    KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
    
    WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
    
    LINE - A string of tab-delimited, contiguous words that are detected on a document page.
    
    TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
    
    CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
    
    SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
    See Also:
    
    BlockType
  - withBlockType
```
public Block withBlockType(String blockType)
```
    The type of text item that's recognized. In operations for text detection, the following types are returned:
    - PAGE - Contains a list of the LINE Block objects that are detected on a document page.
    - WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
    - LINE - A string of tab-delimited, contiguous words that are detected on a document page.
    In text analysis operations, the following types are returned:
    - PAGE - Contains a list of child Block objects that are detected on a document page.
    - KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
    - WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
    - LINE - A string of tab-delimited, contiguous words that are detected on a document page.
    - TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
    - CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
    - SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
    Parameters:
    blockType - The type of text item that's recognized. In operations for text detection, the following types are returned:
    
    PAGE - Contains a list of the LINE Block objects that are detected on a document page.
    
    WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
    
    LINE - A string of tab-delimited, contiguous words that are detected on a document page.
    
    In text analysis operations, the following types are returned:
    
    PAGE - Contains a list of child Block objects that are detected on a document page.
    
    KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
    
    WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
    
    LINE - A string of tab-delimited, contiguous words that are detected on a document page.
    
    TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
    
    CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
    
    SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BlockType
  - withBlockType
```
public Block withBlockType(BlockType blockType)
```
    The type of text item that's recognized. In operations for text detection, the following types are returned:
    - PAGE - Contains a list of the LINE Block objects that are detected on a document page.
    - WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
    - LINE - A string of tab-delimited, contiguous words that are detected on a document page.
    In text analysis operations, the following types are returned:
    - PAGE - Contains a list of child Block objects that are detected on a document page.
    - KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
    - WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
    - LINE - A string of tab-delimited, contiguous words that are detected on a document page.
    - TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
    - CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
    - SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
    Parameters:
    blockType - The type of text item that's recognized. In operations for text detection, the following types are returned:
    
    PAGE - Contains a list of the LINE Block objects that are detected on a document page.
    
    WORD - A word detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
    
    LINE - A string of tab-delimited, contiguous words that are detected on a document page.
    
    In text analysis operations, the following types are returned:
    
    PAGE - Contains a list of child Block objects that are detected on a document page.
    
    KEY_VALUE_SET - Stores the KEY and VALUE Block objects for linked text that's detected on a document page. Use the EntityType field to determine if a KEY_VALUE_SET object is a KEY Block object or a VALUE Block object.
    
    WORD - A word that's detected on a document page. A word is one or more ISO basic Latin script characters that aren't separated by spaces.
    
    LINE - A string of tab-delimited, contiguous words that are detected on a document page.
    
    TABLE - A table that's detected on a document page. A table is grid-based information with two or more rows or columns, with a cell span of one row and one column each.
    
    CELL - A cell within a detected table. The cell is the parent of the block that contains the text in the cell.
    
    SELECTION_ELEMENT - A selection element such as an option button (radio button) or a check box that's detected on a document page. Use the value of SelectionStatus to determine the status of the selection element.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BlockType
  - setConfidence
```
public void setConfidence(Float confidence)
```
    The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
    
    Parameters:
    
    confidence - The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
  - getConfidence
```
public Float getConfidence()
```
    The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
    
    Returns:
    
    The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
  - withConfidence
```
public Block withConfidence(Float confidence)
```
    The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
    
    Parameters:
    
    confidence - The confidence score that Amazon Textract has in the accuracy of the recognized text and the accuracy of the geometry points around the recognized text.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setText
```
public void setText(String text)
```
    The word or line of text that's recognized by Amazon Textract.
    
    Parameters:
    
    text - The word or line of text that's recognized by Amazon Textract.
  - getText
```
public String getText()
```
    The word or line of text that's recognized by Amazon Textract.
    
    Returns:
    
    The word or line of text that's recognized by Amazon Textract.
  - withText
```
public Block withText(String text)
```
    The word or line of text that's recognized by Amazon Textract.
    
    Parameters:
    
    text - The word or line of text that's recognized by Amazon Textract.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTextType
```
public void setTextType(String textType)
```
    The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
    
    Parameters:
    
    textType - The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
    
    See Also:
    
    TextType
  - getTextType
```
public String getTextType()
```
    The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
    
    Returns:
    
    The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
    
    See Also:
    
    TextType
  - withTextType
```
public Block withTextType(String textType)
```
    The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
    
    Parameters:
    
    textType - The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TextType
  - withTextType
```
public Block withTextType(TextType textType)
```
    The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
    
    Parameters:
    
    textType - The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TextType
  - setRowIndex
```
public void setRowIndex(Integer rowIndex)
```
    The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
    
    Parameters:
    
    rowIndex - The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
  - getRowIndex
```
public Integer getRowIndex()
```
    The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
    
    Returns:
    
    The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
  - withRowIndex
```
public Block withRowIndex(Integer rowIndex)
```
    The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
    
    Parameters:
    
    rowIndex - The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setColumnIndex
```
public void setColumnIndex(Integer columnIndex)
```
    The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
    
    Parameters:
    
    columnIndex - The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
  - getColumnIndex
```
public Integer getColumnIndex()
```
    The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
    
    Returns:
    
    The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
  - withColumnIndex
```
public Block withColumnIndex(Integer columnIndex)
```
    The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
    
    Parameters:
    
    columnIndex - The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRowSpan
```
public void setRowSpan(Integer rowSpan)
```
    The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
    
    Parameters:
    
    rowSpan - The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
  - getRowSpan
```
public Integer getRowSpan()
```
    The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
    
    Returns:
    
    The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
  - withRowSpan
```
public Block withRowSpan(Integer rowSpan)
```
    The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
    
    Parameters:
    
    rowSpan - The number of rows that a table cell spans. Currently this value is always 1, even if the number of rows spanned is greater than 1. RowSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setColumnSpan
```
public void setColumnSpan(Integer columnSpan)
```
    The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
    
    Parameters:
    
    columnSpan - The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
  - getColumnSpan
```
public Integer getColumnSpan()
```
    The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
    
    Returns:
    
    The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
  - withColumnSpan
```
public Block withColumnSpan(Integer columnSpan)
```
    The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
    
    Parameters:
    
    columnSpan - The number of columns that a table cell spans. Currently this value is always 1, even if the number of columns spanned is greater than 1. ColumnSpan isn't returned by DetectDocumentText and GetDocumentTextDetection.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGeometry
```
public void setGeometry(Geometry geometry)
```
    The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.
    
    Parameters:
    
    geometry - The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.
  - getGeometry
```
public Geometry getGeometry()
```
    The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.
    
    Returns:
    
    The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.
  - withGeometry
```
public Block withGeometry(Geometry geometry)
```
    The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.
    
    Parameters:
    
    geometry - The location of the recognized text on the image. It includes an axis-aligned, coarse bounding box that surrounds the text, and a finer-grain polygon for more accurate spatial information.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    The identifier for the recognized text. The identifier is only unique for a single operation.
    
    Parameters:
    
    id - The identifier for the recognized text. The identifier is only unique for a single operation.
  - getId
```
public String getId()
```
    The identifier for the recognized text. The identifier is only unique for a single operation.
    
    Returns:
    
    The identifier for the recognized text. The identifier is only unique for a single operation.
  - withId
```
public Block withId(String id)
```
    The identifier for the recognized text. The identifier is only unique for a single operation.
    
    Parameters:
    
    id - The identifier for the recognized text. The identifier is only unique for a single operation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRelationships
```
public List<Relationship> getRelationships()
```
    A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
    - 0 - The block has no child blocks.
    - 1 - The block has child blocks.
    Returns:
    A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
    
    0 - The block has no child blocks.
    
    1 - The block has child blocks.
  - setRelationships
```
public void setRelationships(Collection<Relationship> relationships)
```
    A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
    - 0 - The block has no child blocks.
    - 1 - The block has child blocks.
    Parameters:
    relationships - A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
    
    0 - The block has no child blocks.
    
    1 - The block has child blocks.
  - withRelationships
```
public Block withRelationships(Relationship... relationships)
```
    A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
    - 0 - The block has no child blocks.
    - 1 - The block has child blocks.
    NOTE: This method appends the values to the existing list (if any). Use setRelationships(java.util.Collection) or withRelationships(java.util.Collection) if you want to override the existing values.
    Parameters:
    relationships - A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
    
    0 - The block has no child blocks.
    
    1 - The block has child blocks.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRelationships
```
public Block withRelationships(Collection<Relationship> relationships)
```
    A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
    - 0 - The block has no child blocks.
    - 1 - The block has child blocks.
    Parameters:
    relationships - A list of child blocks of the current block. For example, a LINE object has child blocks for each WORD block that's part of the line of text. There aren't Relationship objects in the list for relationships that don't exist, such as when the current block has no child blocks. The list size can be the following:
    
    0 - The block has no child blocks.
    
    1 - The block has child blocks.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getEntityTypes
```
public List<String> getEntityTypes()
```
    The type of entity. The following can be returned:
    - KEY - An identifier for a field on the document.
    - VALUE - The field text.
    EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.
    Returns:
    The type of entity. The following can be returned:
    
    KEY - An identifier for a field on the document.
    
    VALUE - The field text.
    
    EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.
    See Also:
    
    EntityType
  - setEntityTypes
```
public void setEntityTypes(Collection<String> entityTypes)
```
    The type of entity. The following can be returned:
    - KEY - An identifier for a field on the document.
    - VALUE - The field text.
    EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.
    Parameters:
    entityTypes - The type of entity. The following can be returned:
    
    KEY - An identifier for a field on the document.
    
    VALUE - The field text.
    
    EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.
    See Also:
    
    EntityType
  - withEntityTypes
```
public Block withEntityTypes(String... entityTypes)
```
    The type of entity. The following can be returned:
    - KEY - An identifier for a field on the document.
    - VALUE - The field text.
    EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.
    
    NOTE: This method appends the values to the existing list (if any). Use setEntityTypes(java.util.Collection) or withEntityTypes(java.util.Collection) if you want to override the existing values.
    Parameters:
    entityTypes - The type of entity. The following can be returned:
    
    KEY - An identifier for a field on the document.
    
    VALUE - The field text.
    
    EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EntityType
  - withEntityTypes
```
public Block withEntityTypes(Collection<String> entityTypes)
```
    The type of entity. The following can be returned:
    - KEY - An identifier for a field on the document.
    - VALUE - The field text.
    EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.
    Parameters:
    entityTypes - The type of entity. The following can be returned:
    
    KEY - An identifier for a field on the document.
    
    VALUE - The field text.
    
    EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EntityType
  - withEntityTypes
```
public Block withEntityTypes(EntityType... entityTypes)
```
    The type of entity. The following can be returned:
    - KEY - An identifier for a field on the document.
    - VALUE - The field text.
    EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.
    Parameters:
    entityTypes - The type of entity. The following can be returned:
    
    KEY - An identifier for a field on the document.
    
    VALUE - The field text.
    
    EntityTypes isn't returned by DetectDocumentText and GetDocumentTextDetection.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EntityType
  - setSelectionStatus
```
public void setSelectionStatus(String selectionStatus)
```
    The selection status of a selection element, such as an option button or check box.
    
    Parameters:
    
    selectionStatus - The selection status of a selection element, such as an option button or check box.
    
    See Also:
    
    SelectionStatus
  - getSelectionStatus
```
public String getSelectionStatus()
```
    The selection status of a selection element, such as an option button or check box.
    
    Returns:
    
    The selection status of a selection element, such as an option button or check box.
    
    See Also:
    
    SelectionStatus
  - withSelectionStatus
```
public Block withSelectionStatus(String selectionStatus)
```
    The selection status of a selection element, such as an option button or check box.
    
    Parameters:
    
    selectionStatus - The selection status of a selection element, such as an option button or check box.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SelectionStatus
  - withSelectionStatus
```
public Block withSelectionStatus(SelectionStatus selectionStatus)
```
    The selection status of a selection element, such as an option button or check box.
    
    Parameters:
    
    selectionStatus - The selection status of a selection element, such as an option button or check box.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SelectionStatus
  - setPage
```
public void setPage(Integer page)
```
    The page on which a block was detected. Page is returned by asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is considered to be a single-page document. The value of Page is always 1. Synchronous operations don't return Page because every input document is considered to be a single-page document.
    
    Parameters:
    
    page - The page on which a block was detected. Page is returned by asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is considered to be a single-page document. The value of Page is always 1. Synchronous operations don't return Page because every input document is considered to be a single-page document.
  - getPage
```
public Integer getPage()
```
    The page on which a block was detected. Page is returned by asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is considered to be a single-page document. The value of Page is always 1. Synchronous operations don't return Page because every input document is considered to be a single-page document.
    
    Returns:
    
    The page on which a block was detected. Page is returned by asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is considered to be a single-page document. The value of Page is always 1. Synchronous operations don't return Page because every input document is considered to be a single-page document.
  - withPage
```
public Block withPage(Integer page)
```
    The page on which a block was detected. Page is returned by asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is considered to be a single-page document. The value of Page is always 1. Synchronous operations don't return Page because every input document is considered to be a single-page document.
    
    Parameters:
    
    page - The page on which a block was detected. Page is returned by asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF format. A scanned image (JPEG/PNG), even if it contains multiple document pages, is considered to be a single-page document. The value of Page is always 1. Synchronous operations don't return Page because every input document is considered to be a single-page document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Block clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Block

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Block

Method Detail

setBlockType

getBlockType

withBlockType

withBlockType

setConfidence

getConfidence

withConfidence

setText

getText

withText

setTextType

getTextType

withTextType

withTextType

setRowIndex

getRowIndex

withRowIndex

setColumnIndex

getColumnIndex

withColumnIndex

setRowSpan

getRowSpan

withRowSpan

setColumnSpan

getColumnSpan

withColumnSpan

setGeometry

getGeometry

withGeometry

setId

getId

withId

getRelationships

setRelationships

withRelationships

withRelationships

getEntityTypes

setEntityTypes

withEntityTypes

withEntityTypes

withEntityTypes

setSelectionStatus

getSelectionStatus

withSelectionStatus

withSelectionStatus

setPage

getPage

withPage

toString

equals

hashCode

clone

marshall