blib/lib/Paws/CodeCommit/DeleteFile.pm untested

filter: Statementstmt 0.0% 0 / 25 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 27 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::CodeCommit::DeleteFile;
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 FilePath => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'filePath' , required => 1);
8 has KeepEmptyFolders => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'keepEmptyFolders' );
9 has Name => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'name' );
10 has ParentCommitId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'parentCommitId' , required => 1);
11 has RepositoryName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'repositoryName' , required => 1);
12  
13 use MooseX::ClassAttribute;
14  
15 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DeleteFile');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CodeCommit::DeleteFileOutput');
17 class_has _result_key => (isa => 'Str', is => 'ro');
18 1;
19  
20 ### main pod documentation begin ###
21  
22 =head1 NAME
23  
24 Paws::CodeCommit::DeleteFile - Arguments for method DeleteFile on L<Paws::CodeCommit>
25  
26 =head1 DESCRIPTION
27  
28 This class represents the parameters used for calling the method DeleteFile on the
29 L<AWS CodeCommit|Paws::CodeCommit> service. Use the attributes of this class
30 as arguments to method DeleteFile.
31  
32 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DeleteFile.
33  
34 =head1 SYNOPSIS
35  
36 my $codecommit = Paws->service('CodeCommit');
37 my $DeleteFileOutput = $codecommit->DeleteFile(
38 BranchName => 'MyBranchName',
39 FilePath => 'MyPath',
40 ParentCommitId => 'MyCommitId',
41 RepositoryName => 'MyRepositoryName',
42 CommitMessage => 'MyMessage', # OPTIONAL
43 Email => 'MyEmail', # OPTIONAL
44 KeepEmptyFolders => 1, # OPTIONAL
45 Name => 'MyName', # OPTIONAL
46 );
47  
48 # Results:
49 my $BlobId = $DeleteFileOutput->BlobId;
50 my $CommitId = $DeleteFileOutput->CommitId;
51 my $FilePath = $DeleteFileOutput->FilePath;
52 my $TreeId = $DeleteFileOutput->TreeId;
53  
54 # Returns a L<Paws::CodeCommit::DeleteFileOutput> object.
55  
56 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.
57 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/codecommit/DeleteFile>
58  
59 =head1 ATTRIBUTES
60  
61  
62 =head2 B<REQUIRED> BranchName => Str
63  
64 The name of the branch where the commit that deletes the file is made.
65  
66  
67  
68 =head2 CommitMessage => Str
69  
70 The commit message you want to include as part of deleting the file.
71 Commit messages are limited to 256 KB. If no message is specified, a
72 default message is used.
73  
74  
75  
76 =head2 Email => Str
77  
78 The email address for the commit that deletes the file. If no email
79 address is specified, the email address is left blank.
80  
81  
82  
83 =head2 B<REQUIRED> FilePath => Str
84  
85 The fully qualified path to the file that to be deleted, including the
86 full name and extension of that file. For example, /examples/file.md is
87 a fully qualified path to a file named file.md in a folder named
88 examples.
89  
90  
91  
92 =head2 KeepEmptyFolders => Bool
93  
94 If a file is the only object in the folder or directory, specifies
95 whether to delete the folder or directory that contains the file. By
96 default, empty folders are deleted. This includes empty folders that
97 are part of the directory structure. For example, if the path to a file
98 is dir1/dir2/dir3/dir4, and dir2 and dir3 are empty, deleting the last
99 file in dir4 also deletes the empty folders dir4, dir3, and dir2.
100  
101  
102  
103 =head2 Name => Str
104  
105 The name of the author of the commit that deletes the file. If no name
106 is specified, the user's ARN is used as the author name and committer
107 name.
108  
109  
110  
111 =head2 B<REQUIRED> ParentCommitId => Str
112  
113 The ID of the commit that is the tip of the branch where you want to
114 create the commit that deletes the file. This must be the HEAD commit
115 for the branch. The commit that deletes the file is created from this
116 commit ID.
117  
118  
119  
120 =head2 B<REQUIRED> RepositoryName => Str
121  
122 The name of the repository that contains the file to delete.
123  
124  
125  
126  
127 =head1 SEE ALSO
128  
129 This class forms part of L<Paws>, documenting arguments for method DeleteFile in L<Paws::CodeCommit>
130  
131 =head1 BUGS and CONTRIBUTIONS
132  
133 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
134  
135 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
136  
137 =cut
138