« blib/lib/Paws/Forecast/FieldStatistics.pm
↑ Summary
blib/lib/Paws/Forecast/ForecastExportJobSummary.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Forecast::Filter; | ||
| 3 | use Moose; | ||
| 4 | has Condition => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Key => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Value => (is => 'ro', isa => 'Str', required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::Forecast::Filter | ||
| 15 | |||
| 16 | =head1 USAGE | ||
| 17 | |||
| 18 | This class represents one of two things: | ||
| 19 | |||
| 20 | =head3 Arguments in a call to a service | ||
| 21 | |||
| 22 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 23 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 24 | |||
| 25 | As an example, if Att1 is expected to be a Paws::Forecast::Filter object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Condition => $value, ..., Value => $value }); | ||
| 28 | |||
| 29 | =head3 Results returned from an API call | ||
| 30 | |||
| 31 | Use accessors for each attribute. If Att1 is expected to be an Paws::Forecast::Filter object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Condition | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | Describes a filter for choosing a subset of objects. Each filter | ||
| 39 | consists of a condition and a match statement. The condition is either | ||
| 40 | C<IS> or C<IS_NOT>, which specifies whether to include or exclude the | ||
| 41 | objects that match the statement, respectively. The match statement | ||
| 42 | consists of a key and a value. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 B<REQUIRED> Condition => Str | ||
| 48 | |||
| 49 | The condition to apply. To include the objects that match the | ||
| 50 | statement, specify C<IS>. To exclude matching objects, specify | ||
| 51 | C<IS_NOT>. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 B<REQUIRED> Key => Str | ||
| 55 | |||
| 56 | The name of the parameter to filter on. | ||
| 57 | |||
| 58 | |||
| 59 | =head2 B<REQUIRED> Value => Str | ||
| 60 | |||
| 61 | The value to match. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head1 SEE ALSO | ||
| 66 | |||
| 67 | This class forms part of L<Paws>, describing an object used in L<Paws::Forecast> | ||
| 68 | |||
| 69 | =head1 BUGS and CONTRIBUTIONS | ||
| 70 | |||
| 71 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 72 | |||
| 73 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 74 | |||
| 75 | =cut | ||
| 76 |