File Coverage

blib/lib/Paws/Snowball/JobListEntry.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::Snowball::JobListEntry;
2 1     1   559 use Moose;
  1         3  
  1         9  
3             has CreationDate => (is => 'ro', isa => 'Str');
4             has Description => (is => 'ro', isa => 'Str');
5             has IsMaster => (is => 'ro', isa => 'Bool');
6             has JobId => (is => 'ro', isa => 'Str');
7             has JobState => (is => 'ro', isa => 'Str');
8             has JobType => (is => 'ro', isa => 'Str');
9             has SnowballType => (is => 'ro', isa => 'Str');
10             1;
11              
12             ### main pod documentation begin ###
13              
14             =head1 NAME
15              
16             Paws::Snowball::JobListEntry
17              
18             =head1 USAGE
19              
20             This class represents one of two things:
21              
22             =head3 Arguments in a call to a service
23              
24             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
25             Each attribute should be used as a named argument in the calls that expect this type of object.
26              
27             As an example, if Att1 is expected to be a Paws::Snowball::JobListEntry object:
28              
29             $service_obj->Method(Att1 => { CreationDate => $value, ..., SnowballType => $value });
30              
31             =head3 Results returned from an API call
32              
33             Use accessors for each attribute. If Att1 is expected to be an Paws::Snowball::JobListEntry object:
34              
35             $result = $service_obj->Method(...);
36             $result->Att1->CreationDate
37              
38             =head1 DESCRIPTION
39              
40             Each C<JobListEntry> object contains a job's state, a job's ID, and a
41             value that indicates whether the job is a job part, in the case of an
42             export job.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 CreationDate => Str
48              
49             The creation date for this job.
50              
51              
52             =head2 Description => Str
53              
54             The optional description of this specific job, for example C<Important
55             Photos 2016-08-11>.
56              
57              
58             =head2 IsMaster => Bool
59              
60             A value that indicates that this job is a master job. A master job
61             represents a successful request to create an export job. Master jobs
62             aren't associated with any Snowballs. Instead, each master job will
63             have at least one job part, and each job part is associated with a
64             Snowball. It might take some time before the job parts associated with
65             a particular master job are listed, because they are created after the
66             master job is created.
67              
68              
69             =head2 JobId => Str
70              
71             The automatically generated ID for a job, for example
72             C<JID123e4567-e89b-12d3-a456-426655440000>.
73              
74              
75             =head2 JobState => Str
76              
77             The current state of this job.
78              
79              
80             =head2 JobType => Str
81              
82             The type of job.
83              
84              
85             =head2 SnowballType => Str
86              
87             The type of appliance used with this job.
88              
89              
90              
91             =head1 SEE ALSO
92              
93             This class forms part of L<Paws>, describing an object used in L<Paws::Snowball>
94              
95             =head1 BUGS and CONTRIBUTIONS
96              
97             The source code is located here: https://github.com/pplu/aws-sdk-perl
98              
99             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
100              
101             =cut
102