File Coverage

blib/lib/Paws/CodeCommit/Commit.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::CodeCommit::Commit;
2 1     1   309 use Moose;
  1         2  
  1         6  
3             has AdditionalData => (is => 'ro', isa => 'Str', request_name => 'additionalData', traits => ['NameInRequest']);
4             has Author => (is => 'ro', isa => 'Paws::CodeCommit::UserInfo', request_name => 'author', traits => ['NameInRequest']);
5             has Committer => (is => 'ro', isa => 'Paws::CodeCommit::UserInfo', request_name => 'committer', traits => ['NameInRequest']);
6             has Message => (is => 'ro', isa => 'Str', request_name => 'message', traits => ['NameInRequest']);
7             has Parents => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'parents', traits => ['NameInRequest']);
8             has TreeId => (is => 'ro', isa => 'Str', request_name => 'treeId', traits => ['NameInRequest']);
9             1;
10              
11             ### main pod documentation begin ###
12              
13             =head1 NAME
14              
15             Paws::CodeCommit::Commit
16              
17             =head1 USAGE
18              
19             This class represents one of two things:
20              
21             =head3 Arguments in a call to a service
22              
23             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
24             Each attribute should be used as a named argument in the calls that expect this type of object.
25              
26             As an example, if Att1 is expected to be a Paws::CodeCommit::Commit object:
27              
28             $service_obj->Method(Att1 => { AdditionalData => $value, ..., TreeId => $value });
29              
30             =head3 Results returned from an API call
31              
32             Use accessors for each attribute. If Att1 is expected to be an Paws::CodeCommit::Commit object:
33              
34             $result = $service_obj->Method(...);
35             $result->Att1->AdditionalData
36              
37             =head1 DESCRIPTION
38              
39             Returns information about a specific commit.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 AdditionalData => Str
45              
46             Any additional data associated with the specified commit.
47              
48              
49             =head2 Author => L<Paws::CodeCommit::UserInfo>
50              
51             Information about the author of the specified commit. Information
52             includes the date in timestamp format with GMT offset, the name of the
53             author, and the email address for the author, as configured in Git.
54              
55              
56             =head2 Committer => L<Paws::CodeCommit::UserInfo>
57              
58             Information about the person who committed the specified commit, also
59             known as the committer. Information includes the date in timestamp
60             format with GMT offset, the name of the committer, and the email
61             address for the committer, as configured in Git.
62              
63             For more information about the difference between an author and a
64             committer in Git, see Viewing the Commit History in Pro Git by Scott
65             Chacon and Ben Straub.
66              
67              
68             =head2 Message => Str
69              
70             The commit message associated with the specified commit.
71              
72              
73             =head2 Parents => ArrayRef[Str|Undef]
74              
75             The parent list for the specified commit.
76              
77              
78             =head2 TreeId => Str
79              
80             Tree information for the specified commit.
81              
82              
83              
84             =head1 SEE ALSO
85              
86             This class forms part of L<Paws>, describing an object used in L<Paws::CodeCommit>
87              
88             =head1 BUGS and CONTRIBUTIONS
89              
90             The source code is located here: https://github.com/pplu/aws-sdk-perl
91              
92             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
93              
94             =cut
95