| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Textract::Relationship; | ||
| 3 | use Moose; | ||
| 4 | has Ids => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has Type => (is => 'ro', isa => 'Str'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Textract::Relationship | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::Textract::Relationship object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Ids => $value, ..., Type => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::Textract::Relationship object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Ids | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | Information about how blocks are related to each other. A C<Block> | ||
| 38 | object contains 0 or more C<Relation> objects in a list, | ||
| 39 | C<Relationships>. For more information, see Block. | ||
| 40 | |||
| 41 | The C<Type> element provides the type of the relationship for all | ||
| 42 | blocks in the C<IDs> array. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 Ids => ArrayRef[Str|Undef] | ||
| 48 | |||
| 49 | An array of IDs for related blocks. You can get the type of the | ||
| 50 | relationship from the C<Type> element. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 Type => Str | ||
| 54 | |||
| 55 | The type of relationship that the blocks in the IDs array have with the | ||
| 56 | current block. The relationship can be C<VALUE> or C<CHILD>. A | ||
| 57 | relationship of type VALUE is a list that contains the ID of the VALUE | ||
| 58 | block that's associated with the KEY of a key-value pair. A | ||
| 59 | relationship of type CHILD is a list of IDs that identify WORD blocks | ||
| 60 | in the case of lines Cell blocks in the case of Tables, and WORD blocks | ||
| 61 | in the case of Selection Elements. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head1 SEE ALSO | ||
| 66 | |||
| 67 | This class forms part of L<Paws>, describing an object used in L<Paws::Textract> | ||
| 68 | |||
| 69 | =head1 BUGS and CONTRIBUTIONS | ||
| 70 | |||
| 71 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 72 | |||
| 73 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 74 | |||
| 75 | =cut | ||
| 76 |