File Coverage

blib/lib/Paws/RedShift/RestoreStatus.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1             package Paws::RedShift::RestoreStatus;
2 1     1   315 use Moose;
  1     1   3  
  1         5  
  1         337  
  1         2  
  1         7  
3             has CurrentRestoreRateInMegaBytesPerSecond => (is => 'ro', isa => 'Num');
4             has ElapsedTimeInSeconds => (is => 'ro', isa => 'Int');
5             has EstimatedTimeToCompletionInSeconds => (is => 'ro', isa => 'Int');
6             has ProgressInMegaBytes => (is => 'ro', isa => 'Int');
7             has SnapshotSizeInMegaBytes => (is => 'ro', isa => 'Int');
8             has Status => (is => 'ro', isa => 'Str');
9             1;
10              
11             ### main pod documentation begin ###
12              
13             =head1 NAME
14              
15             Paws::RedShift::RestoreStatus
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::RedShift::RestoreStatus object:
27              
28             $service_obj->Method(Att1 => { CurrentRestoreRateInMegaBytesPerSecond => $value, ..., Status => $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::RedShift::RestoreStatus object:
33              
34             $result = $service_obj->Method(...);
35             $result->Att1->CurrentRestoreRateInMegaBytesPerSecond
36              
37             =head1 DESCRIPTION
38              
39             Describes the status of a cluster restore action. Returns null if the
40             cluster was not created by restoring a snapshot.
41              
42             =head1 ATTRIBUTES
43              
44              
45             =head2 CurrentRestoreRateInMegaBytesPerSecond => Num
46              
47             The number of megabytes per second being transferred from the backup
48             storage. Returns the average rate for a completed backup.
49              
50              
51             =head2 ElapsedTimeInSeconds => Int
52              
53             The amount of time an in-progress restore has been running, or the
54             amount of time it took a completed restore to finish.
55              
56              
57             =head2 EstimatedTimeToCompletionInSeconds => Int
58              
59             The estimate of the time remaining before the restore will complete.
60             Returns 0 for a completed restore.
61              
62              
63             =head2 ProgressInMegaBytes => Int
64              
65             The number of megabytes that have been transferred from snapshot
66             storage.
67              
68              
69             =head2 SnapshotSizeInMegaBytes => Int
70              
71             The size of the set of snapshot data used to restore the cluster.
72              
73              
74             =head2 Status => Str
75              
76             The status of the restore action. Returns starting, restoring,
77             completed, or failed.
78              
79              
80              
81             =head1 SEE ALSO
82              
83             This class forms part of L<Paws>, describing an object used in L<Paws::RedShift>
84              
85             =head1 BUGS and CONTRIBUTIONS
86              
87             The source code is located here: https://github.com/pplu/aws-sdk-perl
88              
89             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
90              
91             =cut
92