« blib/lib/Paws/Datasync/TaskExecutionResultDetail.pm
↑ Summary
blib/lib/Paws/Datasync/TaskListEntry.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Datasync::TaskFilter; | ||
| 3 | use Moose; | ||
| 4 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Operator => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has Values => (is => 'ro', isa => 'ArrayRef[Str|Undef]', required => 1); | ||
| 7 | |||
| 8 | 1; | ||
| 9 | |||
| 10 | ### main pod documentation begin ### | ||
| 11 | |||
| 12 | =head1 NAME | ||
| 13 | |||
| 14 | Paws::Datasync::TaskFilter | ||
| 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::Datasync::TaskFilter object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Name => $value, ..., Values => $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::Datasync::TaskFilter object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Name | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | You can use API filters to narrow down the list of resources returned | ||
| 39 | by C<ListTasks>. For example, to retrieve all tasks on a source | ||
| 40 | location, you can use C<ListTasks> with filter name C<LocationId> and | ||
| 41 | C<Operator Equals> with the ARN for the location. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 B<REQUIRED> Name => Str | ||
| 47 | |||
| 48 | The name of the filter being used. Each API call supports a list of | ||
| 49 | filters that are available for it. For example, C<LocationId> for | ||
| 50 | C<ListTasks>. | ||
| 51 | |||
| 52 | |||
| 53 | =head2 B<REQUIRED> Operator => Str | ||
| 54 | |||
| 55 | The operator that is used to compare filter values (for example, | ||
| 56 | C<Equals> or C<Contains>). For more about API filtering operators, see | ||
| 57 | API filters for ListTasks and ListLocations | ||
| 58 | (https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html). | ||
| 59 | |||
| 60 | |||
| 61 | =head2 B<REQUIRED> Values => ArrayRef[Str|Undef] | ||
| 62 | |||
| 63 | The values that you want to filter for. For example, you might want to | ||
| 64 | display only tasks for a specific destination location. | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head1 SEE ALSO | ||
| 69 | |||
| 70 | This class forms part of L<Paws>, describing an object used in L<Paws::Datasync> | ||
| 71 | |||
| 72 | =head1 BUGS and CONTRIBUTIONS | ||
| 73 | |||
| 74 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 75 | |||
| 76 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 77 | |||
| 78 | =cut | ||
| 79 |