« blib/lib/Paws/Honeycode/ListTablesResult.pm
↑ Summary
blib/lib/Paws/Honeycode/QueryTableRowsResult.pm »
| 1 | |||
| 2 | package Paws::Honeycode::QueryTableRows; | ||
| 3 | use Moose; | ||
| 4 | has FilterFormula => (is => 'ro', isa => 'Paws::Honeycode::Filter', traits => ['NameInRequest'], request_name => 'filterFormula', required => 1); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken'); | ||
| 7 | has TableId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'tableId', required => 1); | ||
| 8 | has WorkbookId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'workbookId', required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'QueryTableRows'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/workbooks/{workbookId}/tables/{tableId}/rows/query'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Honeycode::QueryTableRowsResult'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::Honeycode::QueryTableRows - Arguments for method QueryTableRows on L<Paws::Honeycode> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method QueryTableRows on the | ||
| 27 | L<Amazon Honeycode|Paws::Honeycode> service. Use the attributes of this class | ||
| 28 | as arguments to method QueryTableRows. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to QueryTableRows. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $honeycode = Paws->service('Honeycode'); | ||
| 35 | my $QueryTableRowsResult = $honeycode->QueryTableRows( | ||
| 36 | FilterFormula => { | ||
| 37 | Formula => 'MyFormula', # max: 8192 | ||
| 38 | ContextRowId => 'MyRowId', # min: 77, max: 77; OPTIONAL | ||
| 39 | }, | ||
| 40 | TableId => 'MyResourceId', | ||
| 41 | WorkbookId => 'MyResourceId', | ||
| 42 | MaxResults => 1, # OPTIONAL | ||
| 43 | NextToken => 'MyPaginationToken', # OPTIONAL | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $ColumnIds = $QueryTableRowsResult->ColumnIds; | ||
| 48 | my $NextToken = $QueryTableRowsResult->NextToken; | ||
| 49 | my $Rows = $QueryTableRowsResult->Rows; | ||
| 50 | my $WorkbookCursor = $QueryTableRowsResult->WorkbookCursor; | ||
| 51 | |||
| 52 | # Returns a L<Paws::Honeycode::QueryTableRowsResult> object. | ||
| 53 | |||
| 54 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/honeycode/QueryTableRows> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> FilterFormula => L<Paws::Honeycode::Filter> | ||
| 61 | |||
| 62 | An object that represents a filter formula along with the id of the | ||
| 63 | context row under which the filter function needs to evaluate. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 MaxResults => Int | ||
| 68 | |||
| 69 | The maximum number of rows to return in each page of the results. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 NextToken => Str | ||
| 74 | |||
| 75 | This parameter is optional. If a nextToken is not specified, the API | ||
| 76 | returns the first page of data. | ||
| 77 | |||
| 78 | Pagination tokens expire after 1 hour. If you use a token that was | ||
| 79 | returned more than an hour back, the API will throw | ||
| 80 | ValidationException. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> TableId => Str | ||
| 85 | |||
| 86 | The ID of the table whose rows are being queried. | ||
| 87 | |||
| 88 | If a table with the specified id could not be found, this API throws | ||
| 89 | ResourceNotFoundException. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head2 B<REQUIRED> WorkbookId => Str | ||
| 94 | |||
| 95 | The ID of the workbook whose table rows are being queried. | ||
| 96 | |||
| 97 | If a workbook with the specified id could not be found, this API throws | ||
| 98 | ResourceNotFoundException. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | |||
| 103 | =head1 SEE ALSO | ||
| 104 | |||
| 105 | This class forms part of L<Paws>, documenting arguments for method QueryTableRows in L<Paws::Honeycode> | ||
| 106 | |||
| 107 | =head1 BUGS and CONTRIBUTIONS | ||
| 108 | |||
| 109 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 110 | |||
| 111 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 112 | |||
| 113 | =cut | ||
| 114 |