« blib/lib/Paws/FSX/DataRepositoryTaskFailureDetails.pm
↑ Summary
blib/lib/Paws/FSX/DataRepositoryTaskStatus.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::FSX::DataRepositoryTaskFilter; | ||
| 3 | use Moose; | ||
| 4 | has Name => (is => 'ro', isa => 'Str'); | ||
| 5 | has Values => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::FSX::DataRepositoryTaskFilter | ||
| 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::FSX::DataRepositoryTaskFilter object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Name => $value, ..., Values => $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::FSX::DataRepositoryTaskFilter object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Name | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | (Optional) An array of filter objects you can use to filter the | ||
| 38 | response of data repository tasks you will see in the the response. You | ||
| 39 | can filter the tasks returned in the response by one or more file | ||
| 40 | system IDs, task lifecycles, and by task type. A filter object consists | ||
| 41 | of a filter C<Name>, and one or more C<Values> for the filter. | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 Name => Str | ||
| 47 | |||
| 48 | Name of the task property to use in filtering the tasks returned in the | ||
| 49 | response. | ||
| 50 | |||
| 51 | =over | ||
| 52 | |||
| 53 | =item * | ||
| 54 | |||
| 55 | Use C<file-system-id> to retrieve data repository tasks for specific | ||
| 56 | file systems. | ||
| 57 | |||
| 58 | =item * | ||
| 59 | |||
| 60 | Use C<task-lifecycle> to retrieve data repository tasks with one or | ||
| 61 | more specific lifecycle states, as follows: CANCELED, EXECUTING, | ||
| 62 | FAILED, PENDING, and SUCCEEDED. | ||
| 63 | |||
| 64 | =back | ||
| 65 | |||
| 66 | |||
| 67 | |||
| 68 | =head2 Values => ArrayRef[Str|Undef] | ||
| 69 | |||
| 70 | Use Values to include the specific file system IDs and task lifecycle | ||
| 71 | states for the filters you are using. | ||
| 72 | |||
| 73 | |||
| 74 | |||
| 75 | =head1 SEE ALSO | ||
| 76 | |||
| 77 | This class forms part of L<Paws>, describing an object used in L<Paws::FSX> | ||
| 78 | |||
| 79 | =head1 BUGS and CONTRIBUTIONS | ||
| 80 | |||
| 81 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 82 | |||
| 83 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 84 | |||
| 85 | =cut | ||
| 86 |