« blib/lib/Paws/Kendra/AdditionalResultAttributeValue.pm
↑ Summary
blib/lib/Paws/Kendra/AuthenticationConfiguration.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Kendra::AttributeFilter; | ||
| 3 | use Moose; | ||
| 4 | has AndAllFilters => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::AttributeFilter]'); | ||
| 5 | has ContainsAll => (is => 'ro', isa => 'Paws::Kendra::DocumentAttribute'); | ||
| 6 | has ContainsAny => (is => 'ro', isa => 'Paws::Kendra::DocumentAttribute'); | ||
| 7 | has EqualsTo => (is => 'ro', isa => 'Paws::Kendra::DocumentAttribute'); | ||
| 8 | has GreaterThan => (is => 'ro', isa => 'Paws::Kendra::DocumentAttribute'); | ||
| 9 | has GreaterThanOrEquals => (is => 'ro', isa => 'Paws::Kendra::DocumentAttribute'); | ||
| 10 | has LessThan => (is => 'ro', isa => 'Paws::Kendra::DocumentAttribute'); | ||
| 11 | has LessThanOrEquals => (is => 'ro', isa => 'Paws::Kendra::DocumentAttribute'); | ||
| 12 | has NotFilter => (is => 'ro', isa => 'Paws::Kendra::AttributeFilter'); | ||
| 13 | has OrAllFilters => (is => 'ro', isa => 'ArrayRef[Paws::Kendra::AttributeFilter]'); | ||
| 14 | |||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::Kendra::AttributeFilter | ||
| 22 | |||
| 23 | =head1 USAGE | ||
| 24 | |||
| 25 | This class represents one of two things: | ||
| 26 | |||
| 27 | =head3 Arguments in a call to a service | ||
| 28 | |||
| 29 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 30 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 31 | |||
| 32 | As an example, if Att1 is expected to be a Paws::Kendra::AttributeFilter object: | ||
| 33 | |||
| 34 | $service_obj->Method(Att1 => { AndAllFilters => $value, ..., OrAllFilters => $value }); | ||
| 35 | |||
| 36 | =head3 Results returned from an API call | ||
| 37 | |||
| 38 | Use accessors for each attribute. If Att1 is expected to be an Paws::Kendra::AttributeFilter object: | ||
| 39 | |||
| 40 | $result = $service_obj->Method(...); | ||
| 41 | $result->Att1->AndAllFilters | ||
| 42 | |||
| 43 | =head1 DESCRIPTION | ||
| 44 | |||
| 45 | Provides filtering the query results based on document attributes. | ||
| 46 | |||
| 47 | When you use the C<AndAllFilters> or C<OrAllFilters>, filters you can | ||
| 48 | use 2 layers under the first attribute filter. For example, you can | ||
| 49 | use: | ||
| 50 | |||
| 51 | C<E<lt>AndAllFiltersE<gt>> | ||
| 52 | |||
| 53 | =over | ||
| 54 | |||
| 55 | =item 1. | ||
| 56 | |||
| 57 | C<E<lt>OrAllFiltersE<gt>> | ||
| 58 | |||
| 59 | =item 2. | ||
| 60 | |||
| 61 | C<E<lt>EqualToE<gt>> | ||
| 62 | |||
| 63 | =back | ||
| 64 | |||
| 65 | If you use more than 2 layers, you receive a C<ValidationException> | ||
| 66 | exception with the message "C<AttributeFilter> cannot have a depth of | ||
| 67 | more than 2." | ||
| 68 | |||
| 69 | =head1 ATTRIBUTES | ||
| 70 | |||
| 71 | |||
| 72 | =head2 AndAllFilters => ArrayRef[L<Paws::Kendra::AttributeFilter>] | ||
| 73 | |||
| 74 | Performs a logical C<AND> operation on all supplied filters. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 ContainsAll => L<Paws::Kendra::DocumentAttribute> | ||
| 78 | |||
| 79 | Returns true when a document contains all of the specified document | ||
| 80 | attributes. This filter is only applicable to C<StringListValue> | ||
| 81 | metadata. | ||
| 82 | |||
| 83 | |||
| 84 | =head2 ContainsAny => L<Paws::Kendra::DocumentAttribute> | ||
| 85 | |||
| 86 | Returns true when a document contains any of the specified document | ||
| 87 | attributes. This filter is only applicable to C<StringListValue> | ||
| 88 | metadata. | ||
| 89 | |||
| 90 | |||
| 91 | =head2 EqualsTo => L<Paws::Kendra::DocumentAttribute> | ||
| 92 | |||
| 93 | Performs an equals operation on two document attributes. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 GreaterThan => L<Paws::Kendra::DocumentAttribute> | ||
| 97 | |||
| 98 | Performs a greater than operation on two document attributes. Use with | ||
| 99 | a document attribute of type C<Integer> or C<Long>. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 GreaterThanOrEquals => L<Paws::Kendra::DocumentAttribute> | ||
| 103 | |||
| 104 | Performs a greater or equals than operation on two document attributes. | ||
| 105 | Use with a document attribute of type C<Integer> or C<Long>. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 LessThan => L<Paws::Kendra::DocumentAttribute> | ||
| 109 | |||
| 110 | Performs a less than operation on two document attributes. Use with a | ||
| 111 | document attribute of type C<Integer> or C<Long>. | ||
| 112 | |||
| 113 | |||
| 114 | =head2 LessThanOrEquals => L<Paws::Kendra::DocumentAttribute> | ||
| 115 | |||
| 116 | Performs a less than or equals operation on two document attributes. | ||
| 117 | Use with a document attribute of type C<Integer> or C<Long>. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 NotFilter => L<Paws::Kendra::AttributeFilter> | ||
| 121 | |||
| 122 | Performs a logical C<NOT> operation on all supplied filters. | ||
| 123 | |||
| 124 | |||
| 125 | =head2 OrAllFilters => ArrayRef[L<Paws::Kendra::AttributeFilter>] | ||
| 126 | |||
| 127 | Performs a logical C<OR> operation on all supplied filters. | ||
| 128 | |||
| 129 | |||
| 130 | |||
| 131 | =head1 SEE ALSO | ||
| 132 | |||
| 133 | This class forms part of L<Paws>, describing an object used in L<Paws::Kendra> | ||
| 134 | |||
| 135 | =head1 BUGS and CONTRIBUTIONS | ||
| 136 | |||
| 137 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 138 | |||
| 139 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 140 | |||
| 141 | =cut | ||
| 142 |