« blib/lib/Paws/CodeCommit/DescribeMergeConflictsOutput.pm
↑ Summary
blib/lib/Paws/CodeCommit/DescribePullRequestEventsOutput.pm »
| 1 | |||
| 2 | package Paws::CodeCommit::DescribePullRequestEvents; | ||
| 3 | use Moose; | ||
| 4 | has ActorArn => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'actorArn' ); | ||
| 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 PullRequestEventType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'pullRequestEventType' ); | ||
| 8 | has PullRequestId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'pullRequestId' , required => 1); | ||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribePullRequestEvents'); | ||
| 13 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeCommit::DescribePullRequestEventsOutput'); | ||
| 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::DescribePullRequestEvents - Arguments for method DescribePullRequestEvents on L<Paws::CodeCommit> | ||
| 22 | |||
| 23 | =head1 DESCRIPTION | ||
| 24 | |||
| 25 | This class represents the parameters used for calling the method DescribePullRequestEvents on the | ||
| 26 | L<AWS CodeCommit|Paws::CodeCommit> service. Use the attributes of this class | ||
| 27 | as arguments to method DescribePullRequestEvents. | ||
| 28 | |||
| 29 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribePullRequestEvents. | ||
| 30 | |||
| 31 | =head1 SYNOPSIS | ||
| 32 | |||
| 33 | my $codecommit = Paws->service('CodeCommit'); | ||
| 34 | my $DescribePullRequestEventsOutput = | ||
| 35 | $codecommit->DescribePullRequestEvents( | ||
| 36 | PullRequestId => 'MyPullRequestId', | ||
| 37 | ActorArn => 'MyArn', # OPTIONAL | ||
| 38 | MaxResults => 1, # OPTIONAL | ||
| 39 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 40 | PullRequestEventType => 'PULL_REQUEST_CREATED', # OPTIONAL | ||
| 41 | ); | ||
| 42 | |||
| 43 | # Results: | ||
| 44 | my $NextToken = $DescribePullRequestEventsOutput->NextToken; | ||
| 45 | my $PullRequestEvents = $DescribePullRequestEventsOutput->PullRequestEvents; | ||
| 46 | |||
| 47 | # Returns a L<Paws::CodeCommit::DescribePullRequestEventsOutput> 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/codecommit/DescribePullRequestEvents> | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 ActorArn => Str | ||
| 56 | |||
| 57 | The Amazon Resource Name (ARN) of the user whose actions resulted in | ||
| 58 | the event. Examples include updating the pull request with more commits | ||
| 59 | or changing the status of a pull request. | ||
| 60 | |||
| 61 | |||
| 62 | |||
| 63 | =head2 MaxResults => Int | ||
| 64 | |||
| 65 | A non-zero, non-negative integer used to limit the number of returned | ||
| 66 | results. The default is 100 events, which is also the maximum number of | ||
| 67 | events that can be returned in a result. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 NextToken => Str | ||
| 72 | |||
| 73 | An enumeration token that, when provided in a request, returns the next | ||
| 74 | batch of the results. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 PullRequestEventType => Str | ||
| 79 | |||
| 80 | Optional. The pull request event type about which you want to return | ||
| 81 | information. | ||
| 82 | |||
| 83 | Valid values are: C<"PULL_REQUEST_CREATED">, C<"PULL_REQUEST_STATUS_CHANGED">, C<"PULL_REQUEST_SOURCE_REFERENCE_UPDATED">, C<"PULL_REQUEST_MERGE_STATE_CHANGED">, C<"PULL_REQUEST_APPROVAL_RULE_CREATED">, C<"PULL_REQUEST_APPROVAL_RULE_UPDATED">, C<"PULL_REQUEST_APPROVAL_RULE_DELETED">, C<"PULL_REQUEST_APPROVAL_RULE_OVERRIDDEN">, C<"PULL_REQUEST_APPROVAL_STATE_CHANGED"> | ||
| 84 | |||
| 85 | =head2 B<REQUIRED> PullRequestId => Str | ||
| 86 | |||
| 87 | The system-generated ID of the pull request. To get this ID, use | ||
| 88 | ListPullRequests. | ||
| 89 | |||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | =head1 SEE ALSO | ||
| 94 | |||
| 95 | This class forms part of L<Paws>, documenting arguments for method DescribePullRequestEvents in L<Paws::CodeCommit> | ||
| 96 | |||
| 97 | =head1 BUGS and CONTRIBUTIONS | ||
| 98 | |||
| 99 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 100 | |||
| 101 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 102 | |||
| 103 | =cut | ||
| 104 |