« blib/lib/Paws/PerformanceInsights/DimensionKeyDescription.pm
↑ Summary
blib/lib/Paws/PerformanceInsights/DimensionMap.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::PerformanceInsights::DimensionKeyDetail; | ||
| 3 | use Moose; | ||
| 4 | has Dimension => (is => 'ro', isa => 'Str'); | ||
| 5 | has Status => (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::PerformanceInsights::DimensionKeyDetail | ||
| 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::DimensionKeyDetail object: | ||
| 26 | |||
| 27 | $service_obj->Method(Att1 => { Dimension => $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::PerformanceInsights::DimensionKeyDetail object: | ||
| 32 | |||
| 33 | $result = $service_obj->Method(...); | ||
| 34 | $result->Att1->Dimension | ||
| 35 | |||
| 36 | =head1 DESCRIPTION | ||
| 37 | |||
| 38 | An object that describes the details for a specified dimension. | ||
| 39 | |||
| 40 | =head1 ATTRIBUTES | ||
| 41 | |||
| 42 | |||
| 43 | =head2 Dimension => Str | ||
| 44 | |||
| 45 | The full name of the dimension. The full name includes the group name | ||
| 46 | and key name. The only valid value is C<db.sql.statement>. | ||
| 47 | |||
| 48 | |||
| 49 | =head2 Status => Str | ||
| 50 | |||
| 51 | The status of the dimension detail data. Possible values include the | ||
| 52 | following: | ||
| 53 | |||
| 54 | =over | ||
| 55 | |||
| 56 | =item * | ||
| 57 | |||
| 58 | C<AVAILABLE> - The dimension detail data is ready to be retrieved. | ||
| 59 | |||
| 60 | =item * | ||
| 61 | |||
| 62 | C<PROCESSING> - The dimension detail data isn't ready to be retrieved | ||
| 63 | because more processing time is required. If the requested detail data | ||
| 64 | for C<db.sql.statement> has the status C<PROCESSING>, Performance | ||
| 65 | Insights returns the truncated query. | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | C<UNAVAILABLE> - The dimension detail data could not be collected | ||
| 70 | successfully. | ||
| 71 | |||
| 72 | =back | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 Value => Str | ||
| 77 | |||
| 78 | The value of the dimension detail data. For the C<db.sql.statement> | ||
| 79 | dimension, this value is either the full or truncated SQL query, | ||
| 80 | depending on the return status. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, describing an object used in L<Paws::PerformanceInsights> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |