blib/lib/Paws/SageMaker/Filter.pm untested

filter: Statementstmt 0.0% 0 / 6 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 7 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::SageMaker::Filter;
3 use Moose;
4 has Name => (is => 'ro', isa => 'Str', required => 1);
5 has Operator => (is => 'ro', isa => 'Str');
6 has Value => (is => 'ro', isa => 'Str');
7  
8 1;
9  
10 ### main pod documentation begin ###
11  
12 =head1 NAME
13  
14 Paws::SageMaker::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::SageMaker::Filter object:
26  
27 $service_obj->Method(Att1 => { Name => $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::SageMaker::Filter object:
32  
33 $result = $service_obj->Method(...);
34 $result->Att1->Name
35  
36 =head1 DESCRIPTION
37  
38 A conditional statement for a search expression that includes a
39 resource property, a Boolean operator, and a value. Resources that
40 match the statement are returned in the results from the Search API.
41  
42 If you specify a C<Value>, but not an C<Operator>, Amazon SageMaker
43 uses the equals operator.
44  
45 In search, there are several property types:
46  
47 =over
48  
49 =item Metrics
50  
51 To define a metric filter, enter a value using the form
52 C<"Metrics.E<lt>nameE<gt>">, where C<E<lt>nameE<gt>> is a metric name.
53 For example, the following filter searches for training jobs with an
54 C<"accuracy"> metric greater than C<"0.9">:
55  
56 C<{>
57  
58 C<"Name": "Metrics.accuracy",>
59  
60 C<"Operator": "GreaterThan",>
61  
62 C<"Value": "0.9">
63  
64 C<}>
65  
66 =item HyperParameters
67  
68 To define a hyperparameter filter, enter a value with the form
69 C<"HyperParameters.E<lt>nameE<gt>">. Decimal hyperparameter values are
70 treated as a decimal in a comparison if the specified C<Value> is also
71 a decimal value. If the specified C<Value> is an integer, the decimal
72 hyperparameter values are treated as integers. For example, the
73 following filter is satisfied by training jobs with a
74 C<"learning_rate"> hyperparameter that is less than C<"0.5">:
75  
76 C<{>
77  
78 C<"Name": "HyperParameters.learning_rate",>
79  
80 C<"Operator": "LessThan",>
81  
82 C<"Value": "0.5">
83  
84 C<}>
85  
86 =item Tags
87  
88 To define a tag filter, enter a value with the form
89 C<Tags.E<lt>keyE<gt>>.
90  
91 =back
92  
93  
94 =head1 ATTRIBUTES
95  
96  
97 =head2 B<REQUIRED> Name => Str
98  
99 A resource property name. For example, C<TrainingJobName>. For valid
100 property names, see SearchRecord. You must specify a valid property for
101 the resource.
102  
103  
104 =head2 Operator => Str
105  
106 A Boolean binary operator that is used to evaluate the filter. The
107 operator field contains one of the following values:
108  
109 =over
110  
111 =item Equals
112  
113 The value of C<Name> equals C<Value>.
114  
115 =item NotEquals
116  
117 The value of C<Name> doesn't equal C<Value>.
118  
119 =item Exists
120  
121 The C<Name> property exists.
122  
123 =item NotExists
124  
125 The C<Name> property does not exist.
126  
127 =item GreaterThan
128  
129 The value of C<Name> is greater than C<Value>. Not supported for text
130 properties.
131  
132 =item GreaterThanOrEqualTo
133  
134 The value of C<Name> is greater than or equal to C<Value>. Not
135 supported for text properties.
136  
137 =item LessThan
138  
139 The value of C<Name> is less than C<Value>. Not supported for text
140 properties.
141  
142 =item LessThanOrEqualTo
143  
144 The value of C<Name> is less than or equal to C<Value>. Not supported
145 for text properties.
146  
147 =item In
148  
149 The value of C<Name> is one of the comma delimited strings in C<Value>.
150 Only supported for text properties.
151  
152 =item Contains
153  
154 The value of C<Name> contains the string C<Value>. Only supported for
155 text properties.
156  
157 A C<SearchExpression> can include the C<Contains> operator multiple
158 times when the value of C<Name> is one of the following:
159  
160 =over
161  
162 =item *
163  
164 C<Experiment.DisplayName>
165  
166 =item *
167  
168 C<Experiment.ExperimentName>
169  
170 =item *
171  
172 C<Experiment.Tags>
173  
174 =item *
175  
176 C<Trial.DisplayName>
177  
178 =item *
179  
180 C<Trial.TrialName>
181  
182 =item *
183  
184 C<Trial.Tags>
185  
186 =item *
187  
188 C<TrialComponent.DisplayName>
189  
190 =item *
191  
192 C<TrialComponent.TrialComponentName>
193  
194 =item *
195  
196 C<TrialComponent.Tags>
197  
198 =item *
199  
200 C<TrialComponent.InputArtifacts>
201  
202 =item *
203  
204 C<TrialComponent.OutputArtifacts>
205  
206 =back
207  
208 A C<SearchExpression> can include only one C<Contains> operator for all
209 other values of C<Name>. In these cases, if you include multiple
210 C<Contains> operators in the C<SearchExpression>, the result is the
211 following error message: "C<'CONTAINS' operator usage limit of 1
212 exceeded.>"
213  
214 =back
215  
216  
217  
218 =head2 Value => Str
219  
220 A value used with C<Name> and C<Operator> to determine which resources
221 satisfy the filter's condition. For numerical properties, C<Value> must
222 be an integer or floating-point decimal. For timestamp properties,
223 C<Value> must be an ISO 8601 date-time string of the following format:
224 C<YYYY-mm-dd'T'HH:MM:SS>.
225  
226  
227  
228 =head1 SEE ALSO
229  
230 This class forms part of L<Paws>, describing an object used in L<Paws::SageMaker>
231  
232 =head1 BUGS and CONTRIBUTIONS
233  
234 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
235  
236 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
237  
238 =cut
239