Block (AWS SDK for Android

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

All Implemented Interfaces:

java.io.Serializable
```
public class Block
extends java.lang.Object
implements java.io.Serializable
```
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:

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
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getBlockType()` The type of text item that's recognized.
`java.lang.Integer`	`getColumnIndex()` The column in which a table cell appears.
`java.lang.Integer`	`getColumnSpan()` The number of columns that a table cell spans.
`java.lang.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.
`java.util.List<java.lang.String>`	`getEntityTypes()` The type of entity.
`Geometry`	`getGeometry()` The location of the recognized text on the image.
`java.lang.String`	`getId()` The identifier for the recognized text.
`java.lang.Integer`	`getPage()` The page on which a block was detected.
`java.util.List<Relationship>`	`getRelationships()` A list of child blocks of the current block.
`java.lang.Integer`	`getRowIndex()` The row in which a table cell is located.
`java.lang.Integer`	`getRowSpan()` The number of rows that a table cell spans.
`java.lang.String`	`getSelectionStatus()` The selection status of a selection element, such as an option button or check box.
`java.lang.String`	`getText()` The word or line of text that's recognized by Amazon Textract.
`java.lang.String`	`getTextType()` The kind of text that Amazon Textract has detected.
`int`	`hashCode()`
`void`	`setBlockType(BlockType blockType)` The type of text item that's recognized.
`void`	`setBlockType(java.lang.String blockType)` The type of text item that's recognized.
`void`	`setColumnIndex(java.lang.Integer columnIndex)` The column in which a table cell appears.
`void`	`setColumnSpan(java.lang.Integer columnSpan)` The number of columns that a table cell spans.
`void`	`setConfidence(java.lang.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(java.util.Collection<java.lang.String> entityTypes)` The type of entity.
`void`	`setGeometry(Geometry geometry)` The location of the recognized text on the image.
`void`	`setId(java.lang.String id)` The identifier for the recognized text.
`void`	`setPage(java.lang.Integer page)` The page on which a block was detected.
`void`	`setRelationships(java.util.Collection<Relationship> relationships)` A list of child blocks of the current block.
`void`	`setRowIndex(java.lang.Integer rowIndex)` The row in which a table cell is located.
`void`	`setRowSpan(java.lang.Integer rowSpan)` The number of rows that a table cell spans.
`void`	`setSelectionStatus(SelectionStatus selectionStatus)` The selection status of a selection element, such as an option button or check box.
`void`	`setSelectionStatus(java.lang.String selectionStatus)` The selection status of a selection element, such as an option button or check box.
`void`	`setText(java.lang.String text)` The word or line of text that's recognized by Amazon Textract.
`void`	`setTextType(java.lang.String textType)` The kind of text that Amazon Textract has detected.
`void`	`setTextType(TextType textType)` The kind of text that Amazon Textract has detected.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`Block`	`withBlockType(BlockType blockType)` The type of text item that's recognized.
`Block`	`withBlockType(java.lang.String blockType)` The type of text item that's recognized.
`Block`	`withColumnIndex(java.lang.Integer columnIndex)` The column in which a table cell appears.
`Block`	`withColumnSpan(java.lang.Integer columnSpan)` The number of columns that a table cell spans.
`Block`	`withConfidence(java.lang.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(java.util.Collection<java.lang.String> entityTypes)` The type of entity.
`Block`	`withEntityTypes(java.lang.String... entityTypes)` The type of entity.
`Block`	`withGeometry(Geometry geometry)` The location of the recognized text on the image.
`Block`	`withId(java.lang.String id)` The identifier for the recognized text.
`Block`	`withPage(java.lang.Integer page)` The page on which a block was detected.
`Block`	`withRelationships(java.util.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(java.lang.Integer rowIndex)` The row in which a table cell is located.
`Block`	`withRowSpan(java.lang.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(java.lang.String selectionStatus)` The selection status of a selection element, such as an option button or check box.
`Block`	`withText(java.lang.String text)` The word or line of text that's recognized by Amazon Textract.
`Block`	`withTextType(java.lang.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
  - getBlockType
```
public java.lang.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.
    Constraints:
    Allowed Values: KEY_VALUE_SET, PAGE, LINE, WORD, TABLE, CELL, 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
  - setBlockType
```
public void setBlockType(java.lang.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.
    Constraints:
    Allowed Values: KEY_VALUE_SET, PAGE, LINE, WORD, TABLE, CELL, 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
  - withBlockType
```
public Block withBlockType(java.lang.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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: KEY_VALUE_SET, PAGE, LINE, WORD, TABLE, CELL, 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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    BlockType
  - setBlockType
```
public void setBlockType(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.
    Constraints:
    Allowed Values: KEY_VALUE_SET, PAGE, LINE, WORD, TABLE, CELL, 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
  - 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.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: KEY_VALUE_SET, PAGE, LINE, WORD, TABLE, CELL, 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:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    BlockType
  - getConfidence
```
public java.lang.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.
    
    Constraints:
    Length: 0 - 100
    
    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.
  - setConfidence
```
public void setConfidence(java.lang.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.
    
    Constraints:
    Length: 0 - 100
    
    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.
  - withConfidence
```
public Block withConfidence(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 0 - 100
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getText
```
public java.lang.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.
  - setText
```
public void setText(java.lang.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.
  - withText
```
public Block withText(java.lang.String text)
```
    The word or line of text that's recognized by Amazon Textract.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    text -
    The word or line of text that's recognized by Amazon Textract.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getTextType
```
public java.lang.String getTextType()
```
    The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
    
    Constraints:
    Allowed Values: HANDWRITING, PRINTED
    
    Returns:
    
    The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
    
    See Also:
    
    TextType
  - setTextType
```
public void setTextType(java.lang.String textType)
```
    The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
    
    Constraints:
    Allowed Values: HANDWRITING, PRINTED
    
    Parameters:
    
    textType -
    The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
    
    See Also:
    
    TextType
  - withTextType
```
public Block withTextType(java.lang.String textType)
```
    The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: HANDWRITING, PRINTED
    
    Parameters:
    
    textType -
    The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    TextType
  - setTextType
```
public void setTextType(TextType textType)
```
    The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
    
    Constraints:
    Allowed Values: HANDWRITING, PRINTED
    
    Parameters:
    
    textType -
    The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
    
    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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: HANDWRITING, PRINTED
    
    Parameters:
    
    textType -
    The kind of text that Amazon Textract has detected. Can check for handwritten text and printed text.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    TextType
  - getRowIndex
```
public java.lang.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.
    
    Constraints:
    Range: 0 -
    
    Returns:
    
    The row in which a table cell is located. The first row position is 1. RowIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
  - setRowIndex
```
public void setRowIndex(java.lang.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.
    
    Constraints:
    Range: 0 -
    
    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.
  - withRowIndex
```
public Block withRowIndex(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 -
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getColumnIndex
```
public java.lang.Integer getColumnIndex()
```
    The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
    
    Constraints:
    Range: 0 -
    
    Returns:
    
    The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection.
  - setColumnIndex
```
public void setColumnIndex(java.lang.Integer columnIndex)
```
    The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
    
    Constraints:
    Range: 0 -
    
    Parameters:
    
    columnIndex -
    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(java.lang.Integer columnIndex)
```
    The column in which a table cell appears. The first column position is 1. ColumnIndex isn't returned by DetectDocumentText and GetDocumentTextDetection .
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 -
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getRowSpan
```
public java.lang.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.
    
    Constraints:
    Range: 0 -
    
    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.
  - setRowSpan
```
public void setRowSpan(java.lang.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.
    
    Constraints:
    Range: 0 -
    
    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.
  - withRowSpan
```
public Block withRowSpan(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 -
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getColumnSpan
```
public java.lang.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.
    
    Constraints:
    Range: 0 -
    
    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.
  - setColumnSpan
```
public void setColumnSpan(java.lang.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.
    
    Constraints:
    Range: 0 -
    
    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.
  - withColumnSpan
```
public Block withColumnSpan(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 -
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    Returns a reference to this object so that method calls can be chained together.
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getId
```
public java.lang.String getId()
```
    The identifier for the recognized text. The identifier is only unique for a single operation.
    
    Constraints:
    Pattern: .*\S.*
    
    Returns:
    
    The identifier for the recognized text. The identifier is only unique for a single operation.
  - setId
```
public void setId(java.lang.String id)
```
    The identifier for the recognized text. The identifier is only unique for a single operation.
    
    Constraints:
    Pattern: .*\S.*
    
    Parameters:
    
    id -
    The identifier for the recognized text. The identifier is only unique for a single operation.
  - withId
```
public Block withId(java.lang.String id)
```
    The identifier for the recognized text. The identifier is only unique for a single operation.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Pattern: .*\S.*
    
    Parameters:
    
    id -
    The identifier for the recognized text. The identifier is only unique for a single operation.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getRelationships
```
public java.util.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(java.util.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.
    Returns a reference to this object so that method calls can be chained together.
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - withRelationships
```
public Block withRelationships(java.util.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.
    Returns a reference to this object so that method calls can be chained together.
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getEntityTypes
```
public java.util.List<java.lang.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.
  - setEntityTypes
```
public void setEntityTypes(java.util.Collection<java.lang.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.
  - withEntityTypes
```
public Block withEntityTypes(java.lang.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 .
    
    Returns a reference to this object so that method calls can be chained together.
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - withEntityTypes
```
public Block withEntityTypes(java.util.Collection<java.lang.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 .
    
    Returns a reference to this object so that method calls can be chained together.
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - getSelectionStatus
```
public java.lang.String getSelectionStatus()
```
    The selection status of a selection element, such as an option button or check box.
    
    Constraints:
    Allowed Values: SELECTED, NOT_SELECTED
    
    Returns:
    
    The selection status of a selection element, such as an option button or check box.
    
    See Also:
    
    SelectionStatus
  - setSelectionStatus
```
public void setSelectionStatus(java.lang.String selectionStatus)
```
    The selection status of a selection element, such as an option button or check box.
    
    Constraints:
    Allowed Values: SELECTED, NOT_SELECTED
    
    Parameters:
    
    selectionStatus -
    The selection status of a selection element, such as an option button or check box.
    
    See Also:
    
    SelectionStatus
  - withSelectionStatus
```
public Block withSelectionStatus(java.lang.String selectionStatus)
```
    The selection status of a selection element, such as an option button or check box.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SELECTED, NOT_SELECTED
    
    Parameters:
    
    selectionStatus -
    The selection status of a selection element, such as an option button or check box.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    SelectionStatus
  - setSelectionStatus
```
public void setSelectionStatus(SelectionStatus selectionStatus)
```
    The selection status of a selection element, such as an option button or check box.
    
    Constraints:
    Allowed Values: SELECTED, NOT_SELECTED
    
    Parameters:
    
    selectionStatus -
    The selection status of a selection element, such as an option button or check box.
    
    See Also:
    
    SelectionStatus
  - withSelectionStatus
```
public Block withSelectionStatus(SelectionStatus selectionStatus)
```
    The selection status of a selection element, such as an option button or check box.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: SELECTED, NOT_SELECTED
    
    Parameters:
    
    selectionStatus -
    The selection status of a selection element, such as an option button or check box.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    SelectionStatus
  - getPage
```
public java.lang.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.
    
    Constraints:
    Range: 0 -
    
    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.
  - setPage
```
public void setPage(java.lang.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.
    
    Constraints:
    Range: 0 -
    
    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.
  - withPage
```
public Block withPage(java.lang.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.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Range: 0 -
    
    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:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class Block

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Block

Method Detail

getBlockType

setBlockType

withBlockType

setBlockType

withBlockType

getConfidence

setConfidence

withConfidence

getText

setText

withText

getTextType

setTextType

withTextType

setTextType

withTextType

getRowIndex

setRowIndex

withRowIndex

getColumnIndex

setColumnIndex

withColumnIndex

getRowSpan

setRowSpan

withRowSpan

getColumnSpan

setColumnSpan

withColumnSpan

getGeometry

setGeometry

withGeometry

getId

setId

withId

getRelationships

setRelationships

withRelationships

withRelationships

getEntityTypes

setEntityTypes

withEntityTypes

withEntityTypes

getSelectionStatus

setSelectionStatus

withSelectionStatus

setSelectionStatus

withSelectionStatus

getPage

setPage

withPage

toString

hashCode

equals