| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Honeycode::ResultSet; | ||
| 3 | use Moose; | ||
| 4 | has Headers => (is => 'ro', isa => 'ArrayRef[Paws::Honeycode::ColumnMetadata]', request_name => 'headers', traits => ['NameInRequest'], required => 1); | ||
| 5 | has Rows => (is => 'ro', isa => 'ArrayRef[Paws::Honeycode::ResultRow]', request_name => 'rows', traits => ['NameInRequest'], required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Honeycode::ResultSet | ||
| 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::Honeycode::ResultSet object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Headers => $value, ..., Rows => $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::Honeycode::ResultSet object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Headers | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | ResultSet contains the results of the request for a single block or | ||
| 38 | list defined on the screen. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 B<REQUIRED> Headers => ArrayRef[L<Paws::Honeycode::ColumnMetadata>] | ||
| 44 | |||
| 45 | List of headers for all the data cells in the block. The header | ||
| 46 | identifies the name and default format of the data cell. Data cells | ||
| 47 | appear in the same order in all rows as defined in the header. The | ||
| 48 | names and formats are not repeated in the rows. If a particular row | ||
| 49 | does not have a value for a data cell, a blank value is used. | ||
| 50 | |||
| 51 | For example, a task list that displays the task name, due date and | ||
| 52 | assigned person might have headers [ { "name": "Task Name"}, {"name": | ||
| 53 | "Due Date", "format": "DATE"}, {"name": "Assigned", "format": | ||
| 54 | "CONTACT"} ]. Every row in the result will have the task name as the | ||
| 55 | first item, due date as the second item and assigned person as the | ||
| 56 | third item. If a particular task does not have a due date, that row | ||
| 57 | will still have a blank value in the second element and the assigned | ||
| 58 | person will still be in the third element. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> Rows => ArrayRef[L<Paws::Honeycode::ResultRow>] | ||
| 62 | |||
| 63 | List of rows returned by the request. Each row has a row Id and a list | ||
| 64 | of data cells in that row. The data cells will be present in the same | ||
| 65 | order as they are defined in the header. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head1 SEE ALSO | ||
| 70 | |||
| 71 | This class forms part of L<Paws>, describing an object used in L<Paws::Honeycode> | ||
| 72 | |||
| 73 | =head1 BUGS and CONTRIBUTIONS | ||
| 74 | |||
| 75 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 76 | |||
| 77 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 78 | |||
| 79 | =cut | ||
| 80 |