« blib/lib/Paws/CodeBuild/ListReportGroupsOutput.pm
↑ Summary
blib/lib/Paws/CodeBuild/ListReportsForReportGroup.pm »
| 1 | |||
| 2 | package Paws::CodeBuild::ListReports; | ||
| 3 | use Moose; | ||
| 4 | has Filter => (is => 'ro', isa => 'Paws::CodeBuild::ReportFilter', traits => ['NameInRequest'], request_name => 'filter' ); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' ); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' ); | ||
| 7 | has SortOrder => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'sortOrder' ); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListReports'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeBuild::ListReportsOutput'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CodeBuild::ListReports - Arguments for method ListReports on L<Paws::CodeBuild> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method ListReports on the | ||
| 25 | L<AWS CodeBuild|Paws::CodeBuild> service. Use the attributes of this class | ||
| 26 | as arguments to method ListReports. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListReports. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $codebuild = Paws->service('CodeBuild'); | ||
| 33 | my $ListReportsOutput = $codebuild->ListReports( | ||
| 34 | Filter => { | ||
| 35 | Status => 'GENERATING' | ||
| 36 | , # values: GENERATING, SUCCEEDED, FAILED, INCOMPLETE, DELETING; OPTIONAL | ||
| 37 | }, # OPTIONAL | ||
| 38 | MaxResults => 1, # OPTIONAL | ||
| 39 | NextToken => 'MyString', # OPTIONAL | ||
| 40 | SortOrder => 'ASCENDING', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $NextToken = $ListReportsOutput->NextToken; | ||
| 45 | my $Reports = $ListReportsOutput->Reports; | ||
| 46 | |||
| 47 | # Returns a L<Paws::CodeBuild::ListReportsOutput> object. | ||
| 48 | |||
| 49 | 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. | ||
| 50 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codebuild/ListReports> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 Filter => L<Paws::CodeBuild::ReportFilter> | ||
| 56 | |||
| 57 | A C<ReportFilter> object used to filter the returned reports. | ||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head2 MaxResults => Int | ||
| 62 | |||
| 63 | The maximum number of paginated reports returned per response. Use | ||
| 64 | C<nextToken> to iterate pages in the list of returned C<Report> | ||
| 65 | objects. The default value is 100. | ||
| 66 | |||
| 67 | |||
| 68 | |||
| 69 | =head2 NextToken => Str | ||
| 70 | |||
| 71 | During a previous call, the maximum number of items that can be | ||
| 72 | returned is the value specified in C<maxResults>. If there more items | ||
| 73 | in the list, then a unique string called a I<nextToken> is returned. To | ||
| 74 | get the next batch of items in the list, call this operation again, | ||
| 75 | adding the next token to the call. To get all of the items in the list, | ||
| 76 | keep calling this operation with each subsequent next token that is | ||
| 77 | returned, until no more next tokens are returned. | ||
| 78 | |||
| 79 | |||
| 80 | |||
| 81 | =head2 SortOrder => Str | ||
| 82 | |||
| 83 | Specifies the sort order for the list of returned reports. Valid values | ||
| 84 | are: | ||
| 85 | |||
| 86 | =over | ||
| 87 | |||
| 88 | =item * | ||
| 89 | |||
| 90 | C<ASCENDING>: return reports in chronological order based on their | ||
| 91 | creation date. | ||
| 92 | |||
| 93 | =item * | ||
| 94 | |||
| 95 | C<DESCENDING>: return reports in the reverse chronological order based | ||
| 96 | on their creation date. | ||
| 97 | |||
| 98 | =back | ||
| 99 | |||
| 100 | |||
| 101 | Valid values are: C<"ASCENDING">, C<"DESCENDING"> | ||
| 102 | |||
| 103 | |||
| 104 | =head1 SEE ALSO | ||
| 105 | |||
| 106 | This class forms part of L<Paws>, documenting arguments for method ListReports in L<Paws::CodeBuild> | ||
| 107 | |||
| 108 | =head1 BUGS and CONTRIBUTIONS | ||
| 109 | |||
| 110 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 111 | |||
| 112 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 113 | |||
| 114 | =cut | ||
| 115 |