Amazonka.Textract.Types.Relationship

Documentation

data Relationship

Information about how blocks are related to each other. A Block object contains 0 or more Relation objects in a list, Relationships. For more information, see Block.

The Type element provides the type of the relationship for all blocks in the IDs array.

See: newRelationship smart constructor.

Constructors

Relationship'

Fields

• ids :: Maybe [Text]

  An array of IDs for related blocks. You can get the type of the relationship from the Type element.

• type' :: Maybe RelationshipType

  The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD. A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.

Instances

FromJSON Relationship

Defined in Amazonka.Textract.Types.Relationship

Methods

parseJSON :: Value -> Parser Relationship

parseJSONList :: Value -> Parser [Relationship]

Generic Relationship

Defined in Amazonka.Textract.Types.Relationship

Associated Types

type Rep Relationship :: Type -> Type

Methods

from :: Relationship -> Rep Relationship x

to :: Rep Relationship x -> Relationship

Read Relationship

Defined in Amazonka.Textract.Types.Relationship

Methods

readsPrec :: Int -> ReadS Relationship

readList :: ReadS [Relationship]

readPrec :: ReadPrec Relationship

readListPrec :: ReadPrec [Relationship]

Show Relationship

Defined in Amazonka.Textract.Types.Relationship

Methods

showsPrec :: Int -> Relationship -> ShowS

show :: Relationship -> String

showList :: [Relationship] -> ShowS

NFData Relationship

Defined in Amazonka.Textract.Types.Relationship

Methods

rnf :: Relationship -> ()

Eq Relationship

Defined in Amazonka.Textract.Types.Relationship

Methods

(==) :: Relationship -> Relationship -> Bool

(/=) :: Relationship -> Relationship -> Bool

Hashable Relationship

Defined in Amazonka.Textract.Types.Relationship

Methods

hashWithSalt :: Int -> Relationship -> Int

hash :: Relationship -> Int

type Rep Relationship

Defined in Amazonka.Textract.Types.Relationship

type Rep Relationship = D1 ('MetaData "Relationship" "Amazonka.Textract.Types.Relationship" "amazonka-textract-2.0-6i5mJlqzS4xCepXxXFK6UK" 'False) (C1 ('MetaCons "Relationship'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RelationshipType))))

newRelationship :: Relationship

Create a value of Relationship with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:ids:Relationship', relationship_ids - An array of IDs for related blocks. You can get the type of the relationship from the Type element.

$sel:type':Relationship', relationship_type - The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD. A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.

relationship_ids :: Lens' Relationship (Maybe [Text])

An array of IDs for related blocks. You can get the type of the relationship from the Type element.

relationship_type :: Lens' Relationship (Maybe RelationshipType)

The type of relationship that the blocks in the IDs array have with the current block. The relationship can be VALUE or CHILD. A relationship of type VALUE is a list that contains the ID of the VALUE block that's associated with the KEY of a key-value pair. A relationship of type CHILD is a list of IDs that identify WORD blocks in the case of lines Cell blocks in the case of Tables, and WORD blocks in the case of Selection Elements.