File Coverage

blib/lib/Paws/Snowball/DataTransfer.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::DataTransfer;
2 1     1   539 use Moose;
  1         2  
  1         9  
3             has BytesTransferred => (is => 'ro', isa => 'Int');
4             has ObjectsTransferred => (is => 'ro', isa => 'Int');
5             has TotalBytes => (is => 'ro', isa => 'Int');
6             has TotalObjects => (is => 'ro', isa => 'Int');
7             1;
8              
9             ### main pod documentation begin ###
10              
11             =head1 NAME
12              
13             Paws::Snowball::DataTransfer
14              
15             =head1 USAGE
16              
17             This class represents one of two things:
18              
19             =head3 Arguments in a call to a service
20              
21             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
22             Each attribute should be used as a named argument in the calls that expect this type of object.
23              
24             As an example, if Att1 is expected to be a Paws::Snowball::DataTransfer object:
25              
26             $service_obj->Method(Att1 => { BytesTransferred => $value, ..., TotalObjects => $value });
27              
28             =head3 Results returned from an API call
29              
30             Use accessors for each attribute. If Att1 is expected to be an Paws::Snowball::DataTransfer object:
31              
32             $result = $service_obj->Method(...);
33             $result->Att1->BytesTransferred
34              
35             =head1 DESCRIPTION
36              
37             Defines the real-time status of a Snowball's data transfer while the
38             appliance is at AWS. This data is only available while a job has a
39             C<JobState> value of C<InProgress>, for both import and export jobs.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 BytesTransferred => Int
45              
46             The number of bytes transferred between a Snowball and Amazon S3.
47              
48              
49             =head2 ObjectsTransferred => Int
50              
51             The number of objects transferred between a Snowball and Amazon S3.
52              
53              
54             =head2 TotalBytes => Int
55              
56             The total bytes of data for a transfer between a Snowball and Amazon
57             S3. This value is set to 0 (zero) until all the keys that will be
58             transferred have been listed.
59              
60              
61             =head2 TotalObjects => Int
62              
63             The total number of objects for a transfer between a Snowball and
64             Amazon S3. This value is set to 0 (zero) until all the keys that will
65             be transferred have been listed.
66              
67              
68              
69             =head1 SEE ALSO
70              
71             This class forms part of L<Paws>, describing an object used in L<Paws::Snowball>
72              
73             =head1 BUGS and CONTRIBUTIONS
74              
75             The source code is located here: https://github.com/pplu/aws-sdk-perl
76              
77             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
78              
79             =cut
80