« blib/lib/Paws/CodeCommit/CreateCommitOutput.pm
↑ Summary
blib/lib/Paws/CodeCommit/CreatePullRequestApprovalRule.pm »
| 1 | |||
| 2 | package Paws::CodeCommit::CreatePullRequest; | ||
| 3 | use Moose; | ||
| 4 | has ClientRequestToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'clientRequestToken' ); | ||
| 5 | has Description => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'description' ); | ||
| 6 | has Targets => (is => 'ro', isa => 'ArrayRef[Paws::CodeCommit::Target]', traits => ['NameInRequest'], request_name => 'targets' , required => 1); | ||
| 7 | has Title => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'title' , required => 1); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'CreatePullRequest'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeCommit::CreatePullRequestOutput'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CodeCommit::CreatePullRequest - Arguments for method CreatePullRequest on L<Paws::CodeCommit> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method CreatePullRequest on the | ||
| 25 | L<AWS CodeCommit|Paws::CodeCommit> service. Use the attributes of this class | ||
| 26 | as arguments to method CreatePullRequest. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CreatePullRequest. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $codecommit = Paws->service('CodeCommit'); | ||
| 33 | my $CreatePullRequestOutput = $codecommit->CreatePullRequest( | ||
| 34 | Targets => [ | ||
| 35 | { | ||
| 36 | RepositoryName => 'MyRepositoryName', # min: 1, max: 100 | ||
| 37 | SourceReference => 'MyReferenceName', | ||
| 38 | DestinationReference => 'MyReferenceName', | ||
| 39 | }, | ||
| 40 | ... | ||
| 41 | ], | ||
| 42 | Title => 'MyTitle', | ||
| 43 | ClientRequestToken => 'MyClientRequestToken', # OPTIONAL | ||
| 44 | Description => 'MyDescription', # OPTIONAL | ||
| 45 | ); | ||
| 46 | |||
| 47 | # Results: | ||
| 48 | my $PullRequest = $CreatePullRequestOutput->PullRequest; | ||
| 49 | |||
| 50 | # Returns a L<Paws::CodeCommit::CreatePullRequestOutput> 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/CreatePullRequest> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 ClientRequestToken => Str | ||
| 59 | |||
| 60 | A unique, client-generated idempotency token that, when provided in a | ||
| 61 | request, ensures the request cannot be repeated with a changed | ||
| 62 | parameter. If a request is received with the same parameters and a | ||
| 63 | token is included, the request returns information about the initial | ||
| 64 | request that used that token. | ||
| 65 | |||
| 66 | The AWS SDKs prepopulate client request tokens. If you are using an AWS | ||
| 67 | SDK, an idempotency token is created for you. | ||
| 68 | |||
| 69 | |||
| 70 | |||
| 71 | =head2 Description => Str | ||
| 72 | |||
| 73 | A description of the pull request. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | =head2 B<REQUIRED> Targets => ArrayRef[L<Paws::CodeCommit::Target>] | ||
| 78 | |||
| 79 | The targets for the pull request, including the source of the code to | ||
| 80 | be reviewed (the source branch) and the destination where the creator | ||
| 81 | of the pull request intends the code to be merged after the pull | ||
| 82 | request is closed (the destination branch). | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 B<REQUIRED> Title => Str | ||
| 87 | |||
| 88 | The title of the pull request. This title is used to identify the pull | ||
| 89 | request to other users in the repository. | ||
| 90 | |||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head1 SEE ALSO | ||
| 95 | |||
| 96 | This class forms part of L<Paws>, documenting arguments for method CreatePullRequest in L<Paws::CodeCommit> | ||
| 97 | |||
| 98 | =head1 BUGS and CONTRIBUTIONS | ||
| 99 | |||
| 100 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 101 | |||
| 102 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 103 | |||
| 104 | =cut | ||
| 105 |