| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Honeycode::Filter; | ||
| 3 | use Moose; | ||
| 4 | has ContextRowId => (is => 'ro', isa => 'Str', request_name => 'contextRowId', traits => ['NameInRequest']); | ||
| 5 | has Formula => (is => 'ro', isa => 'Str', request_name => 'formula', traits => ['NameInRequest'], required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::Honeycode::Filter | ||
| 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::Filter object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { ContextRowId => $value, ..., Formula => $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::Filter object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->ContextRowId | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | An object that represents a filter formula along with the id of the | ||
| 38 | context row under which the filter function needs to evaluate. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 ContextRowId => Str | ||
| 44 | |||
| 45 | The optional contextRowId attribute can be used to specify the row id | ||
| 46 | of the context row if the filter formula contains unqualified | ||
| 47 | references to table columns and needs a context row to evaluate them | ||
| 48 | successfully. | ||
| 49 | |||
| 50 | |||
| 51 | =head2 B<REQUIRED> Formula => Str | ||
| 52 | |||
| 53 | A formula representing a filter function that returns zero or more | ||
| 54 | matching rows from a table. Valid formulas in this field return a list | ||
| 55 | of rows from a table. The most common ways of writing a formula to | ||
| 56 | return a list of rows are to use the FindRow() or Filter() functions. | ||
| 57 | Any other formula that returns zero or more rows is also acceptable. | ||
| 58 | For example, you can use a formula that points to a cell that contains | ||
| 59 | a filter function. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head1 SEE ALSO | ||
| 64 | |||
| 65 | This class forms part of L<Paws>, describing an object used in L<Paws::Honeycode> | ||
| 66 | |||
| 67 | =head1 BUGS and CONTRIBUTIONS | ||
| 68 | |||
| 69 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 70 | |||
| 71 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 72 | |||
| 73 | =cut | ||
| 74 |