Skip to content

BlockReference

Source code in docs_src/capo_comprehend/types/block_reference.py
class BlockReference(TypedDict, closed=True):
    block_id: NotRequired["capo_comprehend.types.string.String"]
    """<p>Unique identifier for the block.</p>"""
    begin_offset: NotRequired["capo_comprehend.types.integer.Integer"]
    """<p>Offset of the start of the block within its parent block.</p>"""
    end_offset: NotRequired["capo_comprehend.types.integer.Integer"]
    """<p>Offset of the end of the block within its parent block.</p>"""
    child_blocks: NotRequired[
        "capo_comprehend.types.list_of_child_blocks.ListOfChildBlocks"
    ]
    """<p>List of child blocks within this block.</p>"""

begin_offset instance-attribute

begin_offset: NotRequired[Integer]

Offset of the start of the block within its parent block.

block_id instance-attribute

block_id: NotRequired[String]

Unique identifier for the block.

child_blocks instance-attribute

child_blocks: NotRequired[ListOfChildBlocks]

List of child blocks within this block.

end_offset instance-attribute

end_offset: NotRequired[Integer]

Offset of the end of the block within its parent block.