File Coverage

blib/lib/Paws/DataPipeline/Operator.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::DataPipeline::Operator;
2 1     1   643 use Moose;
  1         3  
  1         11  
3             has Type => (is => 'ro', isa => 'Str', request_name => 'type', traits => ['NameInRequest']);
4             has Values => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'values', traits => ['NameInRequest']);
5             1;
6              
7             ### main pod documentation begin ###
8              
9             =head1 NAME
10              
11             Paws::DataPipeline::Operator
12              
13             =head1 USAGE
14              
15             This class represents one of two things:
16              
17             =head3 Arguments in a call to a service
18              
19             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
20             Each attribute should be used as a named argument in the calls that expect this type of object.
21              
22             As an example, if Att1 is expected to be a Paws::DataPipeline::Operator object:
23              
24             $service_obj->Method(Att1 => { Type => $value, ..., Values => $value });
25              
26             =head3 Results returned from an API call
27              
28             Use accessors for each attribute. If Att1 is expected to be an Paws::DataPipeline::Operator object:
29              
30             $result = $service_obj->Method(...);
31             $result->Att1->Type
32              
33             =head1 DESCRIPTION
34              
35             Contains a logical operation for comparing the value of a field with a
36             specified value.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 Type => Str
42              
43             The logical operation to be performed: equal (C<EQ>), equal reference
44             (C<REF_EQ>), less than or equal (C<LE>), greater than or equal (C<GE>),
45             or between (C<BETWEEN>). Equal reference (C<REF_EQ>) can be used only
46             with reference fields. The other comparison types can be used only with
47             String fields. The comparison types you can use apply only to certain
48             object fields, as detailed below.
49              
50             The comparison operators EQ and REF_EQ act on the following fields:
51              
52             =over
53              
54             =item * name
55              
56             =item * @sphere
57              
58             =item * parent
59              
60             =item * @componentParent
61              
62             =item * @instanceParent
63              
64             =item * @status
65              
66             =item * @scheduledStartTime
67              
68             =item * @scheduledEndTime
69              
70             =item * @actualStartTime
71              
72             =item * @actualEndTime
73              
74             =back
75              
76             The comparison operators C<GE>, C<LE>, and C<BETWEEN> act on the
77             following fields:
78              
79             =over
80              
81             =item * @scheduledStartTime
82              
83             =item * @scheduledEndTime
84              
85             =item * @actualStartTime
86              
87             =item * @actualEndTime
88              
89             =back
90              
91             Note that fields beginning with the at sign (@) are read-only and set
92             by the web service. When you name fields, you should choose names
93             containing only alpha-numeric values, as symbols may be reserved by AWS
94             Data Pipeline. User-defined fields that you add to a pipeline should
95             prefix their name with the string "my".
96              
97              
98             =head2 Values => ArrayRef[Str|Undef]
99              
100             The value that the actual field value will be compared with.
101              
102              
103              
104             =head1 SEE ALSO
105              
106             This class forms part of L<Paws>, describing an object used in L<Paws::DataPipeline>
107              
108             =head1 BUGS and CONTRIBUTIONS
109              
110             The source code is located here: https://github.com/pplu/aws-sdk-perl
111              
112             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
113              
114             =cut
115