« blib/lib/Paws/CodeCommit/PutCommentReaction.pm
↑ Summary
blib/lib/Paws/CodeCommit/PutFileEntry.pm »
| 1 | |||
| 2 | package Paws::CodeCommit::PutFile; | ||
| 3 | use Moose; | ||
| 4 | has BranchName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'branchName' , required => 1); | ||
| 5 | has CommitMessage => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'commitMessage' ); | ||
| 6 | has Email => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'email' ); | ||
| 7 | has FileContent => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'fileContent' , required => 1); | ||
| 8 | has FileMode => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'fileMode' ); | ||
| 9 | has FilePath => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'filePath' , required => 1); | ||
| 10 | has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name' ); | ||
| 11 | has ParentCommitId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'parentCommitId' ); | ||
| 12 | has RepositoryName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'repositoryName' , required => 1); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'PutFile'); | ||
| 17 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeCommit::PutFileOutput'); | ||
| 18 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::CodeCommit::PutFile - Arguments for method PutFile on L<Paws::CodeCommit> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method PutFile on the | ||
| 30 | L<AWS CodeCommit|Paws::CodeCommit> service. Use the attributes of this class | ||
| 31 | as arguments to method PutFile. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PutFile. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $codecommit = Paws->service('CodeCommit'); | ||
| 38 | my $PutFileOutput = $codecommit->PutFile( | ||
| 39 | BranchName => 'MyBranchName', | ||
| 40 | FileContent => 'BlobFileContent', | ||
| 41 | FilePath => 'MyPath', | ||
| 42 | RepositoryName => 'MyRepositoryName', | ||
| 43 | CommitMessage => 'MyMessage', # OPTIONAL | ||
| 44 | Email => 'MyEmail', # OPTIONAL | ||
| 45 | FileMode => 'EXECUTABLE', # OPTIONAL | ||
| 46 | Name => 'MyName', # OPTIONAL | ||
| 47 | ParentCommitId => 'MyCommitId', # OPTIONAL | ||
| 48 | ); | ||
| 49 | |||
| 50 | # Results: | ||
| 51 | my $BlobId = $PutFileOutput->BlobId; | ||
| 52 | my $CommitId = $PutFileOutput->CommitId; | ||
| 53 | my $TreeId = $PutFileOutput->TreeId; | ||
| 54 | |||
| 55 | # Returns a L<Paws::CodeCommit::PutFileOutput> object. | ||
| 56 | |||
| 57 | 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. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codecommit/PutFile> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 B<REQUIRED> BranchName => Str | ||
| 64 | |||
| 65 | The name of the branch where you want to add or update the file. If | ||
| 66 | this is an empty repository, this branch is created. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 CommitMessage => Str | ||
| 71 | |||
| 72 | A message about why this file was added or updated. Although it is | ||
| 73 | optional, a message makes the commit history for your repository more | ||
| 74 | useful. | ||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head2 Email => Str | ||
| 79 | |||
| 80 | An email address for the person adding or updating the file. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> FileContent => Str | ||
| 85 | |||
| 86 | The content of the file, in binary object format. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | =head2 FileMode => Str | ||
| 91 | |||
| 92 | The file mode permissions of the blob. Valid file mode permissions are | ||
| 93 | listed here. | ||
| 94 | |||
| 95 | Valid values are: C<"EXECUTABLE">, C<"NORMAL">, C<"SYMLINK"> | ||
| 96 | |||
| 97 | =head2 B<REQUIRED> FilePath => Str | ||
| 98 | |||
| 99 | The name of the file you want to add or update, including the relative | ||
| 100 | path to the file in the repository. | ||
| 101 | |||
| 102 | If the path does not currently exist in the repository, the path is | ||
| 103 | created as part of adding the file. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 Name => Str | ||
| 108 | |||
| 109 | The name of the person adding or updating the file. Although it is | ||
| 110 | optional, a name makes the commit history for your repository more | ||
| 111 | useful. | ||
| 112 | |||
| 113 | |||
| 114 | |||
| 115 | =head2 ParentCommitId => Str | ||
| 116 | |||
| 117 | The full commit ID of the head commit in the branch where you want to | ||
| 118 | add or update the file. If this is an empty repository, no commit ID is | ||
| 119 | required. If this is not an empty repository, a commit ID is required. | ||
| 120 | |||
| 121 | The commit ID must match the ID of the head commit at the time of the | ||
| 122 | operation. Otherwise, an error occurs, and the file is not added or | ||
| 123 | updated. | ||
| 124 | |||
| 125 | |||
| 126 | |||
| 127 | =head2 B<REQUIRED> RepositoryName => Str | ||
| 128 | |||
| 129 | The name of the repository where you want to add or update the file. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | |||
| 134 | =head1 SEE ALSO | ||
| 135 | |||
| 136 | This class forms part of L<Paws>, documenting arguments for method PutFile in L<Paws::CodeCommit> | ||
| 137 | |||
| 138 | =head1 BUGS and CONTRIBUTIONS | ||
| 139 | |||
| 140 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 141 | |||
| 142 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 143 | |||
| 144 | =cut | ||
| 145 |