« blib/lib/Paws/CodeCommit/GetCommentsForComparedCommitOutput.pm
↑ Summary
blib/lib/Paws/CodeCommit/GetCommentsForPullRequestOutput.pm »
| 1 | |||
| 2 | package Paws::CodeCommit::GetCommentsForPullRequest; | ||
| 3 | use Moose; | ||
| 4 | has AfterCommitId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'afterCommitId' ); | ||
| 5 | has BeforeCommitId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'beforeCommitId' ); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' ); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' ); | ||
| 8 | has PullRequestId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'pullRequestId' , required => 1); | ||
| 9 | has RepositoryName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'repositoryName' ); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetCommentsForPullRequest'); | ||
| 14 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeCommit::GetCommentsForPullRequestOutput'); | ||
| 15 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::CodeCommit::GetCommentsForPullRequest - Arguments for method GetCommentsForPullRequest on L<Paws::CodeCommit> | ||
| 23 | |||
| 24 | =head1 DESCRIPTION | ||
| 25 | |||
| 26 | This class represents the parameters used for calling the method GetCommentsForPullRequest on the | ||
| 27 | L<AWS CodeCommit|Paws::CodeCommit> service. Use the attributes of this class | ||
| 28 | as arguments to method GetCommentsForPullRequest. | ||
| 29 | |||
| 30 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetCommentsForPullRequest. | ||
| 31 | |||
| 32 | =head1 SYNOPSIS | ||
| 33 | |||
| 34 | my $codecommit = Paws->service('CodeCommit'); | ||
| 35 | my $GetCommentsForPullRequestOutput = | ||
| 36 | $codecommit->GetCommentsForPullRequest( | ||
| 37 | PullRequestId => 'MyPullRequestId', | ||
| 38 | AfterCommitId => 'MyCommitId', # OPTIONAL | ||
| 39 | BeforeCommitId => 'MyCommitId', # OPTIONAL | ||
| 40 | MaxResults => 1, # OPTIONAL | ||
| 41 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 42 | RepositoryName => 'MyRepositoryName', # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $CommentsForPullRequestData = | ||
| 47 | $GetCommentsForPullRequestOutput->CommentsForPullRequestData; | ||
| 48 | my $NextToken = $GetCommentsForPullRequestOutput->NextToken; | ||
| 49 | |||
| 50 | # Returns a L<Paws::CodeCommit::GetCommentsForPullRequestOutput> 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/codecommit/GetCommentsForPullRequest> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 AfterCommitId => Str | ||
| 59 | |||
| 60 | The full commit ID of the commit in the source branch that was the tip | ||
| 61 | of the branch at the time the comment was made. | ||
| 62 | |||
| 63 | |||
| 64 | |||
| 65 | =head2 BeforeCommitId => Str | ||
| 66 | |||
| 67 | The full commit ID of the commit in the destination branch that was the | ||
| 68 | tip of the branch at the time the pull request was created. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 MaxResults => Int | ||
| 73 | |||
| 74 | A non-zero, non-negative integer used to limit the number of returned | ||
| 75 | results. The default is 100 comments. You can return up to 500 comments | ||
| 76 | with a single request. | ||
| 77 | |||
| 78 | |||
| 79 | |||
| 80 | =head2 NextToken => Str | ||
| 81 | |||
| 82 | An enumeration token that, when provided in a request, returns the next | ||
| 83 | batch of the results. | ||
| 84 | |||
| 85 | |||
| 86 | |||
| 87 | =head2 B<REQUIRED> PullRequestId => Str | ||
| 88 | |||
| 89 | The system-generated ID of the pull request. To get this ID, use | ||
| 90 | ListPullRequests. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 RepositoryName => Str | ||
| 95 | |||
| 96 | The name of the repository that contains the pull request. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head1 SEE ALSO | ||
| 102 | |||
| 103 | This class forms part of L<Paws>, documenting arguments for method GetCommentsForPullRequest in L<Paws::CodeCommit> | ||
| 104 | |||
| 105 | =head1 BUGS and CONTRIBUTIONS | ||
| 106 | |||
| 107 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 108 | |||
| 109 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 110 | |||
| 111 | =cut | ||
| 112 |