blib/lib/Paws/PerformanceInsights/DimensionGroup.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::PerformanceInsights::DimensionGroup;
3 use Moose;
4 has Dimensions => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5 has Group => (is => 'ro', isa => 'Str', required => 1);
6 has Limit => (is => 'ro', isa => 'Int');
7  
8 1;
9  
10 ### main pod documentation begin ###
11  
12 =head1 NAME
13  
14 Paws::PerformanceInsights::DimensionGroup
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::PerformanceInsights::DimensionGroup object:
26  
27 $service_obj->Method(Att1 => { Dimensions => $value, ..., Limit => $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::PerformanceInsights::DimensionGroup object:
32  
33 $result = $service_obj->Method(...);
34 $result->Att1->Dimensions
35  
36 =head1 DESCRIPTION
37  
38 A logical grouping of Performance Insights metrics for a related
39 subject area. For example, the C<db.sql> dimension group consists of
40 the following dimensions: C<db.sql.id>, C<db.sql.db_id>,
41 C<db.sql.statement>, and C<db.sql.tokenized_id>.
42  
43 Each response element returns a maximum of 500 bytes. For larger
44 elements, such as SQL statements, only the first 500 bytes are
45 returned.
46  
47 =head1 ATTRIBUTES
48  
49  
50 =head2 Dimensions => ArrayRef[Str|Undef]
51  
52 A list of specific dimensions from a dimension group. If this parameter
53 is not present, then it signifies that all of the dimensions in the
54 group were requested, or are present in the response.
55  
56 Valid values for elements in the C<Dimensions> array are:
57  
58 =over
59  
60 =item *
61  
62 C<db.application.name> - The name of the application that is connected
63 to the database (only Aurora PostgreSQL and RDS PostgreSQL)
64  
65 =item *
66  
67 C<db.host.id> - The host ID of the connected client (all engines)
68  
69 =item *
70  
71 C<db.host.name> - The host name of the connected client (all engines)
72  
73 =item *
74  
75 C<db.name> - The name of the database to which the client is connected
76 (only Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, RDS MySQL, and
77 MariaDB)
78  
79 =item *
80  
81 C<db.session_type.name> - The type of the current session (only Aurora
82 PostgreSQL and RDS PostgreSQL)
83  
84 =item *
85  
86 C<db.sql.id> - The SQL ID generated by Performance Insights (all
87 engines)
88  
89 =item *
90  
91 C<db.sql.db_id> - The SQL ID generated by the database (all engines)
92  
93 =item *
94  
95 C<db.sql.statement> - The SQL text that is being executed (all engines)
96  
97 =item *
98  
99 C<db.sql.tokenized_id>
100  
101 =item *
102  
103 C<db.sql_tokenized.id> - The SQL digest ID generated by Performance
104 Insights (all engines)
105  
106 =item *
107  
108 C<db.sql_tokenized.db_id> - SQL digest ID generated by the database
109 (all engines)
110  
111 =item *
112  
113 C<db.sql_tokenized.statement> - The SQL digest text (all engines)
114  
115 =item *
116  
117 C<db.user.id> - The ID of the user logged in to the database (all
118 engines)
119  
120 =item *
121  
122 C<db.user.name> - The name of the user logged in to the database (all
123 engines)
124  
125 =item *
126  
127 C<db.wait_event.name> - The event for which the backend is waiting (all
128 engines)
129  
130 =item *
131  
132 C<db.wait_event.type> - The type of event for which the backend is
133 waiting (all engines)
134  
135 =item *
136  
137 C<db.wait_event_type.name> - The name of the event type for which the
138 backend is waiting (all engines)
139  
140 =back
141  
142  
143  
144 =head2 B<REQUIRED> Group => Str
145  
146 The name of the dimension group. Valid values are:
147  
148 =over
149  
150 =item *
151  
152 C<db> - The name of the database to which the client is connected (only
153 Aurora PostgreSQL, RDS PostgreSQL, Aurora MySQL, RDS MySQL, and
154 MariaDB)
155  
156 =item *
157  
158 C<db.application> - The name of the application that is connected to
159 the database (only Aurora PostgreSQL and RDS PostgreSQL)
160  
161 =item *
162  
163 C<db.host> - The host name of the connected client (all engines)
164  
165 =item *
166  
167 C<db.session_type> - The type of the current session (only Aurora
168 PostgreSQL and RDS PostgreSQL)
169  
170 =item *
171  
172 C<db.sql> - The SQL that is currently executing (all engines)
173  
174 =item *
175  
176 C<db.sql_tokenized> - The SQL digest (all engines)
177  
178 =item *
179  
180 C<db.wait_event> - The event for which the database backend is waiting
181 (all engines)
182  
183 =item *
184  
185 C<db.wait_event_type> - The type of event for which the database
186 backend is waiting (all engines)
187  
188 =item *
189  
190 C<db.user> - The user logged in to the database (all engines)
191  
192 =back
193  
194  
195  
196 =head2 Limit => Int
197  
198 The maximum number of items to fetch for this dimension group.
199  
200  
201  
202 =head1 SEE ALSO
203  
204 This class forms part of L<Paws>, describing an object used in L<Paws::PerformanceInsights>
205  
206 =head1 BUGS and CONTRIBUTIONS
207  
208 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
209  
210 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
211  
212 =cut
213