« blib/lib/Paws/CodeCommit/GetCommentReactionsOutput.pm
↑ Summary
blib/lib/Paws/CodeCommit/GetCommentsForComparedCommitOutput.pm »
| 1 | |||
| 2 | package Paws::CodeCommit::GetCommentsForComparedCommit; | ||
| 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' ); | ||
| 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 RepositoryName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'repositoryName' , required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetCommentsForComparedCommit'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeCommit::GetCommentsForComparedCommitOutput'); | ||
| 14 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 15 | 1; | ||
| 16 | |||
| 17 | ### main pod documentation begin ### | ||
| 18 | |||
| 19 | =head1 NAME | ||
| 20 | |||
| 21 | Paws::CodeCommit::GetCommentsForComparedCommit - Arguments for method GetCommentsForComparedCommit on L<Paws::CodeCommit> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method GetCommentsForComparedCommit on the | ||
| 26 | L<AWS CodeCommit|Paws::CodeCommit> service. Use the attributes of this class | ||
| 27 | as arguments to method GetCommentsForComparedCommit. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetCommentsForComparedCommit. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $codecommit = Paws->service('CodeCommit'); | ||
| 34 | my $GetCommentsForComparedCommitOutput = | ||
| 35 | $codecommit->GetCommentsForComparedCommit( | ||
| 36 | AfterCommitId => 'MyCommitId', | ||
| 37 | RepositoryName => 'MyRepositoryName', | ||
| 38 | BeforeCommitId => 'MyCommitId', # OPTIONAL | ||
| 39 | MaxResults => 1, # OPTIONAL | ||
| 40 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $CommentsForComparedCommitData = | ||
| 45 | $GetCommentsForComparedCommitOutput->CommentsForComparedCommitData; | ||
| 46 | my $NextToken = $GetCommentsForComparedCommitOutput->NextToken; | ||
| 47 | |||
| 48 | # Returns a L<Paws::CodeCommit::GetCommentsForComparedCommitOutput> object. | ||
| 49 | |||
| 50 | 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. | ||
| 51 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codecommit/GetCommentsForComparedCommit> | ||
| 52 | |||
| 53 | =head1 ATTRIBUTES | ||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> AfterCommitId => Str | ||
| 57 | |||
| 58 | To establish the directionality of the comparison, the full commit ID | ||
| 59 | of the after commit. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 BeforeCommitId => Str | ||
| 64 | |||
| 65 | To establish the directionality of the comparison, the full commit ID | ||
| 66 | of the before commit. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 MaxResults => Int | ||
| 71 | |||
| 72 | A non-zero, non-negative integer used to limit the number of returned | ||
| 73 | results. The default is 100 comments, but you can configure up to 500. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 NextToken => Str | ||
| 78 | |||
| 79 | An enumeration token that when provided in a request, returns the next | ||
| 80 | batch of the results. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> RepositoryName => Str | ||
| 85 | |||
| 86 | The name of the repository where you want to compare commits. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, documenting arguments for method GetCommentsForComparedCommit in L<Paws::CodeCommit> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |