« blib/lib/Paws/CodeBuild/DeleteWebhookOutput.pm
↑ Summary
blib/lib/Paws/CodeBuild/DescribeCodeCoveragesOutput.pm »
| 1 | |||
| 2 | package Paws::CodeBuild::DescribeCodeCoverages; | ||
| 3 | use Moose; | ||
| 4 | has MaxLineCoveragePercentage => (is => 'ro', isa => 'Num', traits => ['NameInRequest'], request_name => 'maxLineCoveragePercentage' ); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' ); | ||
| 6 | has MinLineCoveragePercentage => (is => 'ro', isa => 'Num', traits => ['NameInRequest'], request_name => 'minLineCoveragePercentage' ); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' ); | ||
| 8 | has ReportArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'reportArn' , required => 1); | ||
| 9 | has SortBy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'sortBy' ); | ||
| 10 | has SortOrder => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'sortOrder' ); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeCodeCoverages'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeBuild::DescribeCodeCoveragesOutput'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::CodeBuild::DescribeCodeCoverages - Arguments for method DescribeCodeCoverages on L<Paws::CodeBuild> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method DescribeCodeCoverages on the | ||
| 28 | L<AWS CodeBuild|Paws::CodeBuild> service. Use the attributes of this class | ||
| 29 | as arguments to method DescribeCodeCoverages. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeCodeCoverages. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $codebuild = Paws->service('CodeBuild'); | ||
| 36 | my $DescribeCodeCoveragesOutput = $codebuild->DescribeCodeCoverages( | ||
| 37 | ReportArn => 'MyNonEmptyString', | ||
| 38 | MaxLineCoveragePercentage => 1, # OPTIONAL | ||
| 39 | MaxResults => 1, # OPTIONAL | ||
| 40 | MinLineCoveragePercentage => 1, # OPTIONAL | ||
| 41 | NextToken => 'MyString', # OPTIONAL | ||
| 42 | SortBy => 'LINE_COVERAGE_PERCENTAGE', # OPTIONAL | ||
| 43 | SortOrder => 'ASCENDING', # OPTIONAL | ||
| 44 | ); | ||
| 45 | |||
| 46 | # Results: | ||
| 47 | my $CodeCoverages = $DescribeCodeCoveragesOutput->CodeCoverages; | ||
| 48 | my $NextToken = $DescribeCodeCoveragesOutput->NextToken; | ||
| 49 | |||
| 50 | # Returns a L<Paws::CodeBuild::DescribeCodeCoveragesOutput> object. | ||
| 51 | |||
| 52 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codebuild/DescribeCodeCoverages> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 MaxLineCoveragePercentage => Num | ||
| 59 | |||
| 60 | The maximum line coverage percentage to report. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 MaxResults => Int | ||
| 65 | |||
| 66 | The maximum number of results to return. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 MinLineCoveragePercentage => Num | ||
| 71 | |||
| 72 | The minimum line coverage percentage to report. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 NextToken => Str | ||
| 77 | |||
| 78 | The C<nextToken> value returned from a previous call to | ||
| 79 | C<DescribeCodeCoverages>. This specifies the next item to return. To | ||
| 80 | return the beginning of the list, exclude this parameter. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> ReportArn => Str | ||
| 85 | |||
| 86 | The ARN of the report for which test cases are returned. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 SortBy => Str | ||
| 91 | |||
| 92 | Specifies how the results are sorted. Possible values are: | ||
| 93 | |||
| 94 | =over | ||
| 95 | |||
| 96 | =item FILE_PATH | ||
| 97 | |||
| 98 | The results are sorted by file path. | ||
| 99 | |||
| 100 | =item LINE_COVERAGE_PERCENTAGE | ||
| 101 | |||
| 102 | The results are sorted by the percentage of lines that are covered. | ||
| 103 | |||
| 104 | =back | ||
| 105 | |||
| 106 | |||
| 107 | Valid values are: C<"LINE_COVERAGE_PERCENTAGE">, C<"FILE_PATH"> | ||
| 108 | |||
| 109 | =head2 SortOrder => Str | ||
| 110 | |||
| 111 | Specifies if the results are sorted in ascending or descending order. | ||
| 112 | |||
| 113 | Valid values are: C<"ASCENDING">, C<"DESCENDING"> | ||
| 114 | |||
| 115 | |||
| 116 | =head1 SEE ALSO | ||
| 117 | |||
| 118 | This class forms part of L<Paws>, documenting arguments for method DescribeCodeCoverages in L<Paws::CodeBuild> | ||
| 119 | |||
| 120 | =head1 BUGS and CONTRIBUTIONS | ||
| 121 | |||
| 122 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 123 | |||
| 124 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 125 | |||
| 126 | =cut | ||
| 127 |