Block.Builder (AWS Java SDK :: Services

All Superinterfaces:

Buildable, CopyableBuilder<Block.Builder,Block>, SdkBuilder<Block.Builder,Block>, SdkPojo

Enclosing class:

Block
```
public static interface Block.Builder
extends SdkPojo, CopyableBuilder<Block.Builder,Block>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`Block.Builder`	`blockType(BlockType blockType)` The type of text item that's recognized.
`Block.Builder`	`blockType(String blockType)` The type of text item that's recognized.
`Block.Builder`	`columnIndex(Integer columnIndex)` The column in which a table cell appears.
`Block.Builder`	`columnSpan(Integer columnSpan)` The number of columns that a table cell spans.
`Block.Builder`	`confidence(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.Builder`	`entityTypes(Collection<EntityType> entityTypes)` The type of entity.
`Block.Builder`	`entityTypes(EntityType... entityTypes)` The type of entity.
`Block.Builder`	`entityTypesWithStrings(Collection<String> entityTypes)` The type of entity.
`Block.Builder`	`entityTypesWithStrings(String... entityTypes)` The type of entity.
`default Block.Builder`	`geometry(Consumer<Geometry.Builder> geometry)` The location of the recognized text on the image.
`Block.Builder`	`geometry(Geometry geometry)` The location of the recognized text on the image.
`Block.Builder`	`id(String id)` The identifier for the recognized text.
`Block.Builder`	`page(Integer page)` The page on which a block was detected.
`default Block.Builder`	`query(Consumer<Query.Builder> query)` This is a convenience method that creates an instance of the `Query.Builder` avoiding the need to create one manually via `Query.builder()`.
`Block.Builder`	`query(Query query)`
`Block.Builder`	`relationships(Collection<Relationship> relationships)` A list of child blocks of the current block.
`Block.Builder`	`relationships(Consumer<Relationship.Builder>... relationships)` A list of child blocks of the current block.
`Block.Builder`	`relationships(Relationship... relationships)` A list of child blocks of the current block.
`Block.Builder`	`rowIndex(Integer rowIndex)` The row in which a table cell is located.
`Block.Builder`	`rowSpan(Integer rowSpan)` The number of rows that a table cell spans.
`Block.Builder`	`selectionStatus(SelectionStatus selectionStatus)` The selection status of a selection element, such as an option button or check box.
`Block.Builder`	`selectionStatus(String selectionStatus)` The selection status of a selection element, such as an option button or check box.
`Block.Builder`	`text(String text)` The word or line of text that's recognized by Amazon Textract.
`Block.Builder`	`textType(String textType)` The kind of text that Amazon Textract has detected.
`Block.Builder`	`textType(TextType textType)` The kind of text that Amazon Textract has detected.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - blockType
```
Block.Builder blockType(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.
    - SIGNATURE - The location and confidene score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.
    - QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
    - QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.
    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.
    
    SIGNATURE - The location and confidene score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.
    
    QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
    
    QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BlockType, BlockType
  - blockType
```
Block.Builder blockType(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.
    - SIGNATURE - The location and confidene score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.
    - QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
    - QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.
    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.
    
    SIGNATURE - The location and confidene score of a signature detected on a document page. Can be returned as part of a Key-Value pair or a detected cell.
    
    QUERY - A question asked during the call of AnalyzeDocument. Contains an alias and an ID that attaches it to its answer.
    
    QUERY_RESULT - A response to a question asked during the call of analyze document. Comes with an alias and ID for ease of locating in a response. Also contains location and confidence score.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BlockType, BlockType
  - confidence
```
Block.Builder confidence(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.
  - text
```
Block.Builder text(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.
  - textType
```
Block.Builder textType(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, TextType
  - textType
```
Block.Builder textType(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, TextType
  - rowIndex
```
Block.Builder rowIndex(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.
  - columnIndex
```
Block.Builder columnIndex(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.
  - rowSpan
```
Block.Builder rowSpan(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.
  - columnSpan
```
Block.Builder columnSpan(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.
  - geometry
```
Block.Builder geometry(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.
  - geometry
```
default Block.Builder geometry(Consumer<Geometry.Builder> 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.
    This is a convenience method that creates an instance of the Geometry.Builder avoiding the need to create one manually via Geometry.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to geometry(Geometry).
    
    Parameters:
    
    geometry - a consumer that will call methods on Geometry.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    geometry(Geometry)
  - id
```
Block.Builder id(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.
  - relationships
```
Block.Builder relationships(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.
  - relationships
```
Block.Builder relationships(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.
  - relationships
```
Block.Builder relationships(Consumer<Relationship.Builder>... 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.
    This is a convenience method that creates an instance of the Relationship.Builder avoiding the need to create one manually via Relationship.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #relationships(List).
    Parameters:
    
    relationships - a consumer that will call methods on Relationship.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #relationships(java.util.Collection)
  - entityTypesWithStrings
```
Block.Builder entityTypesWithStrings(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.
  - entityTypesWithStrings
```
Block.Builder entityTypesWithStrings(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.
  - entityTypes
```
Block.Builder entityTypes(Collection<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.
  - entityTypes
```
Block.Builder entityTypes(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.
  - selectionStatus
```
Block.Builder selectionStatus(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, SelectionStatus
  - selectionStatus
```
Block.Builder selectionStatus(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, SelectionStatus
  - page
```
Block.Builder page(Integer page)
```
    The page on which a block was detected. Page is returned by synchronous and asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an asynchronous operation, even if it contains multiple document pages, is considered a single-page document. This means that for scanned images the value of Page is always 1. Synchronous operations operations will also return a Page value of 1 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 synchronous and asynchronous operations. Page values greater than 1 are only returned for multipage documents that are in PDF or TIFF format. A scanned image (JPEG/PNG) provided to an asynchronous operation, even if it contains multiple document pages, is considered a single-page document. This means that for scanned images the value of Page is always 1. Synchronous operations operations will also return a Page value of 1 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.
  - query
```
Block.Builder query(Query query)
```
    Parameters:
    
    query -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - query
```
default Block.Builder query(Consumer<Query.Builder> query)
```
    This is a convenience method that creates an instance of the Query.Builder avoiding the need to create one manually via Query.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to query(Query).
    
    Parameters:
    
    query - a consumer that will call methods on Query.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    query(Query)

Interface Block.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

blockType

blockType

confidence

text

textType

textType

rowIndex

columnIndex

rowSpan

columnSpan

geometry

geometry

id

relationships

relationships

relationships

entityTypesWithStrings

entityTypesWithStrings

entityTypes

entityTypes

selectionStatus

selectionStatus

page

query

query