| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::SageMaker::SearchExpression; | ||
| 3 | use Moose; | ||
| 4 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::Filter]'); | ||
| 5 | has NestedFilters => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::NestedFilters]'); | ||
| 6 | has Operator => (is => 'ro', isa => 'Str'); | ||
| 7 | has SubExpressions => (is => 'ro', isa => 'ArrayRef[Paws::SageMaker::SearchExpression]'); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::SageMaker::SearchExpression | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::SageMaker::SearchExpression object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { Filters => $value, ..., SubExpressions => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::SageMaker::SearchExpression object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->Filters | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | A multi-expression that searches for the specified resource or | ||
| 40 | resources in a search. All resource objects that satisfy the | ||
| 41 | expression's condition are included in the search results. You must | ||
| 42 | specify at least one subexpression, filter, or nested filter. A | ||
| 43 | C<SearchExpression> can contain up to twenty elements. | ||
| 44 | |||
| 45 | A C<SearchExpression> contains the following components: | ||
| 46 | |||
| 47 | =over | ||
| 48 | |||
| 49 | =item * | ||
| 50 | |||
| 51 | A list of C<Filter> objects. Each filter defines a simple Boolean | ||
| 52 | expression comprised of a resource property name, Boolean operator, and | ||
| 53 | value. | ||
| 54 | |||
| 55 | =item * | ||
| 56 | |||
| 57 | A list of C<NestedFilter> objects. Each nested filter defines a list of | ||
| 58 | Boolean expressions using a list of resource properties. A nested | ||
| 59 | filter is satisfied if a single object in the list satisfies all | ||
| 60 | Boolean expressions. | ||
| 61 | |||
| 62 | =item * | ||
| 63 | |||
| 64 | A list of C<SearchExpression> objects. A search expression object can | ||
| 65 | be nested in a list of search expression objects. | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | A Boolean operator: C<And> or C<Or>. | ||
| 70 | |||
| 71 | =back | ||
| 72 | |||
| 73 | |||
| 74 | =head1 ATTRIBUTES | ||
| 75 | |||
| 76 | |||
| 77 | =head2 Filters => ArrayRef[L<Paws::SageMaker::Filter>] | ||
| 78 | |||
| 79 | A list of filter objects. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 NestedFilters => ArrayRef[L<Paws::SageMaker::NestedFilters>] | ||
| 83 | |||
| 84 | A list of nested filter objects. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 Operator => Str | ||
| 88 | |||
| 89 | A Boolean operator used to evaluate the search expression. If you want | ||
| 90 | every conditional statement in all lists to be satisfied for the entire | ||
| 91 | search expression to be true, specify C<And>. If only a single | ||
| 92 | conditional statement needs to be true for the entire search expression | ||
| 93 | to be true, specify C<Or>. The default value is C<And>. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 SubExpressions => ArrayRef[L<Paws::SageMaker::SearchExpression>] | ||
| 97 | |||
| 98 | A list of search expression objects. | ||
| 99 | |||
| 100 | |||
| 101 | |||
| 102 | =head1 SEE ALSO | ||
| 103 | |||
| 104 | This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker> | ||
| 105 | |||
| 106 | =head1 BUGS and CONTRIBUTIONS | ||
| 107 | |||
| 108 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 109 | |||
| 110 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 111 | |||
| 112 | =cut | ||
| 113 |