« blib/lib/Paws/CodeCommit/PostCommentForComparedCommitOutput.pm
↑ Summary
blib/lib/Paws/CodeCommit/PostCommentForPullRequestOutput.pm »
| 1 | |||
| 2 | package Paws::CodeCommit::PostCommentForPullRequest; | ||
| 3 | use Moose; | ||
| 4 | has AfterCommitId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'afterCommitId' , required => 1); | ||
| 5 | has BeforeCommitId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'beforeCommitId' , required => 1); | ||
| 6 | has ClientRequestToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientRequestToken' ); | ||
| 7 | has Content => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'content' , required => 1); | ||
| 8 | has Location => (is => 'ro', isa => 'Paws::CodeCommit::Location', traits => ['NameInRequest'], request_name => 'location' ); | ||
| 9 | has PullRequestId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'pullRequestId' , required => 1); | ||
| 10 | has RepositoryName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'repositoryName' , required => 1); | ||
| 11 | |||
| 12 | use MooseX::ClassAttribute; | ||
| 13 | |||
| 14 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PostCommentForPullRequest'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeCommit::PostCommentForPullRequestOutput'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::CodeCommit::PostCommentForPullRequest - Arguments for method PostCommentForPullRequest on L<Paws::CodeCommit> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method PostCommentForPullRequest on the | ||
| 28 | L<AWS CodeCommit|Paws::CodeCommit> service. Use the attributes of this class | ||
| 29 | as arguments to method PostCommentForPullRequest. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PostCommentForPullRequest. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $codecommit = Paws->service('CodeCommit'); | ||
| 36 | my $PostCommentForPullRequestOutput = | ||
| 37 | $codecommit->PostCommentForPullRequest( | ||
| 38 | AfterCommitId => 'MyCommitId', | ||
| 39 | BeforeCommitId => 'MyCommitId', | ||
| 40 | Content => 'MyContent', | ||
| 41 | PullRequestId => 'MyPullRequestId', | ||
| 42 | RepositoryName => 'MyRepositoryName', | ||
| 43 | ClientRequestToken => 'MyClientRequestToken', # OPTIONAL | ||
| 44 | Location => { | ||
| 45 | FilePath => 'MyPath', # OPTIONAL | ||
| 46 | FilePosition => 1, # OPTIONAL | ||
| 47 | RelativeFileVersion => 'BEFORE', # values: BEFORE, AFTER; OPTIONAL | ||
| 48 | }, # OPTIONAL | ||
| 49 | ); | ||
| 50 | |||
| 51 | # Results: | ||
| 52 | my $AfterBlobId = $PostCommentForPullRequestOutput->AfterBlobId; | ||
| 53 | my $AfterCommitId = $PostCommentForPullRequestOutput->AfterCommitId; | ||
| 54 | my $BeforeBlobId = $PostCommentForPullRequestOutput->BeforeBlobId; | ||
| 55 | my $BeforeCommitId = $PostCommentForPullRequestOutput->BeforeCommitId; | ||
| 56 | my $Comment = $PostCommentForPullRequestOutput->Comment; | ||
| 57 | my $Location = $PostCommentForPullRequestOutput->Location; | ||
| 58 | my $PullRequestId = $PostCommentForPullRequestOutput->PullRequestId; | ||
| 59 | my $RepositoryName = $PostCommentForPullRequestOutput->RepositoryName; | ||
| 60 | |||
| 61 | # Returns a L<Paws::CodeCommit::PostCommentForPullRequestOutput> object. | ||
| 62 | |||
| 63 | 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. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codecommit/PostCommentForPullRequest> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 B<REQUIRED> AfterCommitId => Str | ||
| 70 | |||
| 71 | The full commit ID of the commit in the source branch that is the | ||
| 72 | current tip of the branch for the pull request when you post the | ||
| 73 | comment. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> BeforeCommitId => Str | ||
| 78 | |||
| 79 | The full commit ID of the commit in the destination branch that was the | ||
| 80 | tip of the branch at the time the pull request was created. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 ClientRequestToken => Str | ||
| 85 | |||
| 86 | A unique, client-generated idempotency token that, when provided in a | ||
| 87 | request, ensures the request cannot be repeated with a changed | ||
| 88 | parameter. If a request is received with the same parameters and a | ||
| 89 | token is included, the request returns information about the initial | ||
| 90 | request that used that token. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 B<REQUIRED> Content => Str | ||
| 95 | |||
| 96 | The content of your comment on the change. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head2 Location => L<Paws::CodeCommit::Location> | ||
| 101 | |||
| 102 | The location of the change where you want to post your comment. If no | ||
| 103 | location is provided, the comment is posted as a general comment on the | ||
| 104 | pull request difference between the before commit ID and the after | ||
| 105 | commit ID. | ||
| 106 | |||
| 107 | |||
| 108 | |||
| 109 | =head2 B<REQUIRED> PullRequestId => Str | ||
| 110 | |||
| 111 | The system-generated ID of the pull request. To get this ID, use | ||
| 112 | ListPullRequests. | ||
| 113 | |||
| 114 | |||
| 115 | |||
| 116 | =head2 B<REQUIRED> RepositoryName => Str | ||
| 117 | |||
| 118 | The name of the repository where you want to post a comment on a pull | ||
| 119 | request. | ||
| 120 | |||
| 121 | |||
| 122 | |||
| 123 | |||
| 124 | =head1 SEE ALSO | ||
| 125 | |||
| 126 | This class forms part of L<Paws>, documenting arguments for method PostCommentForPullRequest in L<Paws::CodeCommit> | ||
| 127 | |||
| 128 | =head1 BUGS and CONTRIBUTIONS | ||
| 129 | |||
| 130 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 131 | |||
| 132 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 133 | |||
| 134 | =cut | ||
| 135 |