« blib/lib/Paws/RedShift/RestoreFromClusterSnapshotResult.pm
↑ Summary
blib/lib/Paws/RedShift/RevokeClusterSecurityGroupIngress.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::RedShift::RestoreStatus; | ||
| 3 | 1 | ▶ | use Moose; |
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||
| 4 | 1 | has CurrentRestoreRateInMegaBytesPerSecond => (is => 'ro', isa => 'Num'); | |
| 5 | 1 | has ElapsedTimeInSeconds => (is => 'ro', isa => 'Int'); | |
| 6 | 1 | has EstimatedTimeToCompletionInSeconds => (is => 'ro', isa => 'Int'); | |
| 7 | 1 | has ProgressInMegaBytes => (is => 'ro', isa => 'Int'); | |
| 8 | 1 | has SnapshotSizeInMegaBytes => (is => 'ro', isa => 'Int'); | |
| 9 | 1 | has Status => (is => 'ro', isa => 'Str'); | |
| 10 | |||
| 11 | 1 | 1; | |
| 12 | |||
| 13 | ### main pod documentation begin ### | ||
| 14 | |||
| 15 | =head1 NAME | ||
| 16 | |||
| 17 | Paws::RedShift::RestoreStatus | ||
| 18 | |||
| 19 | =head1 USAGE | ||
| 20 | |||
| 21 | This class represents one of two things: | ||
| 22 | |||
| 23 | =head3 Arguments in a call to a service | ||
| 24 | |||
| 25 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 26 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 27 | |||
| 28 | As an example, if Att1 is expected to be a Paws::RedShift::RestoreStatus object: | ||
| 29 | |||
| 30 | $service_obj->Method(Att1 => { CurrentRestoreRateInMegaBytesPerSecond => $value, ..., Status => $value }); | ||
| 31 | |||
| 32 | =head3 Results returned from an API call | ||
| 33 | |||
| 34 | Use accessors for each attribute. If Att1 is expected to be an Paws::RedShift::RestoreStatus object: | ||
| 35 | |||
| 36 | $result = $service_obj->Method(...); | ||
| 37 | $result->Att1->CurrentRestoreRateInMegaBytesPerSecond | ||
| 38 | |||
| 39 | =head1 DESCRIPTION | ||
| 40 | |||
| 41 | Describes the status of a cluster restore action. Returns null if the | ||
| 42 | cluster was not created by restoring a snapshot. | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 CurrentRestoreRateInMegaBytesPerSecond => Num | ||
| 48 | |||
| 49 | The number of megabytes per second being transferred from the backup | ||
| 50 | storage. Returns the average rate for a completed backup. This field is | ||
| 51 | only updated when you restore to DC2 and DS2 node types. | ||
| 52 | |||
| 53 | |||
| 54 | =head2 ElapsedTimeInSeconds => Int | ||
| 55 | |||
| 56 | The amount of time an in-progress restore has been running, or the | ||
| 57 | amount of time it took a completed restore to finish. This field is | ||
| 58 | only updated when you restore to DC2 and DS2 node types. | ||
| 59 | |||
| 60 | |||
| 61 | =head2 EstimatedTimeToCompletionInSeconds => Int | ||
| 62 | |||
| 63 | The estimate of the time remaining before the restore will complete. | ||
| 64 | Returns 0 for a completed restore. This field is only updated when you | ||
| 65 | restore to DC2 and DS2 node types. | ||
| 66 | |||
| 67 | |||
| 68 | =head2 ProgressInMegaBytes => Int | ||
| 69 | |||
| 70 | The number of megabytes that have been transferred from snapshot | ||
| 71 | storage. This field is only updated when you restore to DC2 and DS2 | ||
| 72 | node types. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 SnapshotSizeInMegaBytes => Int | ||
| 76 | |||
| 77 | The size of the set of snapshot data used to restore the cluster. This | ||
| 78 | field is only updated when you restore to DC2 and DS2 node types. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 Status => Str | ||
| 82 | |||
| 83 | The status of the restore action. Returns starting, restoring, | ||
| 84 | completed, or failed. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head1 SEE ALSO | ||
| 89 | |||
| 90 | This class forms part of L<Paws>, describing an object used in L<Paws::RedShift> | ||
| 91 | |||
| 92 | =head1 BUGS and CONTRIBUTIONS | ||
| 93 | |||
| 94 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 95 | |||
| 96 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 97 | |||
| 98 | =cut | ||
| 99 | |||