« blib/lib/Paws/CodeCommit/CommentsForComparedCommit.pm
↑ Summary
blib/lib/Paws/CodeCommit/Commit.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::CodeCommit::CommentsForPullRequest; | ||
| 3 | use Moose; | ||
| 4 | has AfterBlobId => (is => 'ro', isa => 'Str', request_name => 'afterBlobId', traits => ['NameInRequest']); | ||
| 5 | has AfterCommitId => (is => 'ro', isa => 'Str', request_name => 'afterCommitId', traits => ['NameInRequest']); | ||
| 6 | has BeforeBlobId => (is => 'ro', isa => 'Str', request_name => 'beforeBlobId', traits => ['NameInRequest']); | ||
| 7 | has BeforeCommitId => (is => 'ro', isa => 'Str', request_name => 'beforeCommitId', traits => ['NameInRequest']); | ||
| 8 | has Comments => (is => 'ro', isa => 'ArrayRef[Paws::CodeCommit::Comment]', request_name => 'comments', traits => ['NameInRequest']); | ||
| 9 | has Location => (is => 'ro', isa => 'Paws::CodeCommit::Location', request_name => 'location', traits => ['NameInRequest']); | ||
| 10 | has PullRequestId => (is => 'ro', isa => 'Str', request_name => 'pullRequestId', traits => ['NameInRequest']); | ||
| 11 | has RepositoryName => (is => 'ro', isa => 'Str', request_name => 'repositoryName', traits => ['NameInRequest']); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::CodeCommit::CommentsForPullRequest | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::CodeCommit::CommentsForPullRequest object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { AfterBlobId => $value, ..., RepositoryName => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::CodeCommit::CommentsForPullRequest object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->AfterBlobId | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | Returns information about comments on a pull request. | ||
| 44 | |||
| 45 | =head1 ATTRIBUTES | ||
| 46 | |||
| 47 | |||
| 48 | =head2 AfterBlobId => Str | ||
| 49 | |||
| 50 | The full blob ID of the file on which you want to comment on the source | ||
| 51 | commit. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 AfterCommitId => Str | ||
| 55 | |||
| 56 | The full commit ID of the commit that was the tip of the source branch | ||
| 57 | at the time the comment was made. | ||
| 58 | |||
| 59 | |||
| 60 | =head2 BeforeBlobId => Str | ||
| 61 | |||
| 62 | The full blob ID of the file on which you want to comment on the | ||
| 63 | destination commit. | ||
| 64 | |||
| 65 | |||
| 66 | =head2 BeforeCommitId => Str | ||
| 67 | |||
| 68 | The full commit ID of the commit that was the tip of the destination | ||
| 69 | branch when the pull request was created. This commit is superceded by | ||
| 70 | the after commit in the source branch when and if you merge the source | ||
| 71 | branch into the destination branch. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 Comments => ArrayRef[L<Paws::CodeCommit::Comment>] | ||
| 75 | |||
| 76 | An array of comment objects. Each comment object contains information | ||
| 77 | about a comment on the pull request. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 Location => L<Paws::CodeCommit::Location> | ||
| 81 | |||
| 82 | Location information about the comment on the pull request, including | ||
| 83 | the file name, line number, and whether the version of the file where | ||
| 84 | the comment was made is BEFORE (destination branch) or AFTER (source | ||
| 85 | branch). | ||
| 86 | |||
| 87 | |||
| 88 | =head2 PullRequestId => Str | ||
| 89 | |||
| 90 | The system-generated ID of the pull request. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 RepositoryName => Str | ||
| 94 | |||
| 95 | The name of the repository that contains the pull request. | ||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head1 SEE ALSO | ||
| 100 | |||
| 101 | This class forms part of L<Paws>, describing an object used in L<Paws::CodeCommit> | ||
| 102 | |||
| 103 | =head1 BUGS and CONTRIBUTIONS | ||
| 104 | |||
| 105 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 106 | |||
| 107 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 108 | |||
| 109 | =cut | ||
| 110 |