| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::StorageGateway::Tape; | ||
| 3 | use Moose; | ||
| 4 | has KMSKey => (is => 'ro', isa => 'Str'); | ||
| 5 | has PoolEntryDate => (is => 'ro', isa => 'Str'); | ||
| 6 | has PoolId => (is => 'ro', isa => 'Str'); | ||
| 7 | has Progress => (is => 'ro', isa => 'Num'); | ||
| 8 | has RetentionStartDate => (is => 'ro', isa => 'Str'); | ||
| 9 | has TapeARN => (is => 'ro', isa => 'Str'); | ||
| 10 | has TapeBarcode => (is => 'ro', isa => 'Str'); | ||
| 11 | has TapeCreatedDate => (is => 'ro', isa => 'Str'); | ||
| 12 | has TapeSizeInBytes => (is => 'ro', isa => 'Int'); | ||
| 13 | has TapeStatus => (is => 'ro', isa => 'Str'); | ||
| 14 | has TapeUsedInBytes => (is => 'ro', isa => 'Int'); | ||
| 15 | has VTLDevice => (is => 'ro', isa => 'Str'); | ||
| 16 | has Worm => (is => 'ro', isa => 'Bool'); | ||
| 17 | |||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::StorageGateway::Tape | ||
| 25 | |||
| 26 | =head1 USAGE | ||
| 27 | |||
| 28 | This class represents one of two things: | ||
| 29 | |||
| 30 | =head3 Arguments in a call to a service | ||
| 31 | |||
| 32 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 33 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 34 | |||
| 35 | As an example, if Att1 is expected to be a Paws::StorageGateway::Tape object: | ||
| 36 | |||
| 37 | $service_obj->Method(Att1 => { KMSKey => $value, ..., Worm => $value }); | ||
| 38 | |||
| 39 | =head3 Results returned from an API call | ||
| 40 | |||
| 41 | Use accessors for each attribute. If Att1 is expected to be an Paws::StorageGateway::Tape object: | ||
| 42 | |||
| 43 | $result = $service_obj->Method(...); | ||
| 44 | $result->Att1->KMSKey | ||
| 45 | |||
| 46 | =head1 DESCRIPTION | ||
| 47 | |||
| 48 | Describes a virtual tape object. | ||
| 49 | |||
| 50 | =head1 ATTRIBUTES | ||
| 51 | |||
| 52 | |||
| 53 | =head2 KMSKey => Str | ||
| 54 | |||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 PoolEntryDate => Str | ||
| 59 | |||
| 60 | The date that the tape enters a custom tape pool. | ||
| 61 | |||
| 62 | |||
| 63 | =head2 PoolId => Str | ||
| 64 | |||
| 65 | The ID of the pool that contains tapes that will be archived. The tapes | ||
| 66 | in this pool are archived in the S3 storage class that is associated | ||
| 67 | with the pool. When you use your backup application to eject the tape, | ||
| 68 | the tape is archived directly into the storage class (S3 Glacier or S3 | ||
| 69 | Glacier Deep Archive) that corresponds to the pool. | ||
| 70 | |||
| 71 | Valid Values: C<GLACIER> | C<DEEP_ARCHIVE> | ||
| 72 | |||
| 73 | |||
| 74 | =head2 Progress => Num | ||
| 75 | |||
| 76 | For archiving virtual tapes, indicates how much data remains to be | ||
| 77 | uploaded before archiving is complete. | ||
| 78 | |||
| 79 | Range: 0 (not started) to 100 (complete). | ||
| 80 | |||
| 81 | |||
| 82 | =head2 RetentionStartDate => Str | ||
| 83 | |||
| 84 | The date that the tape is first archived with tape retention lock | ||
| 85 | enabled. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 TapeARN => Str | ||
| 89 | |||
| 90 | The Amazon Resource Name (ARN) of the virtual tape. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 TapeBarcode => Str | ||
| 94 | |||
| 95 | The barcode that identifies a specific virtual tape. | ||
| 96 | |||
| 97 | |||
| 98 | =head2 TapeCreatedDate => Str | ||
| 99 | |||
| 100 | The date the virtual tape was created. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 TapeSizeInBytes => Int | ||
| 104 | |||
| 105 | The size, in bytes, of the virtual tape capacity. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 TapeStatus => Str | ||
| 109 | |||
| 110 | The current state of the virtual tape. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 TapeUsedInBytes => Int | ||
| 114 | |||
| 115 | The size, in bytes, of data stored on the virtual tape. | ||
| 116 | |||
| 117 | This value is not available for tapes created prior to May 13, 2015. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 VTLDevice => Str | ||
| 121 | |||
| 122 | The virtual tape library (VTL) device that the virtual tape is | ||
| 123 | associated with. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 Worm => Bool | ||
| 127 | |||
| 128 | If the tape is archived as write-once-read-many (WORM), this value is | ||
| 129 | C<true>. | ||
| 130 | |||
| 131 | |||
| 132 | |||
| 133 | =head1 SEE ALSO | ||
| 134 | |||
| 135 | This class forms part of L<Paws>, describing an object used in L<Paws::StorageGateway> | ||
| 136 | |||
| 137 | =head1 BUGS and CONTRIBUTIONS | ||
| 138 | |||
| 139 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 140 | |||
| 141 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 142 | |||
| 143 | =cut | ||
| 144 |