File Coverage

blib/lib/Paws/StorageGateway/CachediSCSIVolume.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::StorageGateway::CachediSCSIVolume;
2 1     1   344 use Moose;
  1         3  
  1         7  
3             has CreatedDate => (is => 'ro', isa => 'Str');
4             has SourceSnapshotId => (is => 'ro', isa => 'Str');
5             has VolumeARN => (is => 'ro', isa => 'Str');
6             has VolumeId => (is => 'ro', isa => 'Str');
7             has VolumeiSCSIAttributes => (is => 'ro', isa => 'Paws::StorageGateway::VolumeiSCSIAttributes');
8             has VolumeProgress => (is => 'ro', isa => 'Num');
9             has VolumeSizeInBytes => (is => 'ro', isa => 'Int');
10             has VolumeStatus => (is => 'ro', isa => 'Str');
11             has VolumeType => (is => 'ro', isa => 'Str');
12             1;
13              
14             ### main pod documentation begin ###
15              
16             =head1 NAME
17              
18             Paws::StorageGateway::CachediSCSIVolume
19              
20             =head1 USAGE
21              
22             This class represents one of two things:
23              
24             =head3 Arguments in a call to a service
25              
26             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
27             Each attribute should be used as a named argument in the calls that expect this type of object.
28              
29             As an example, if Att1 is expected to be a Paws::StorageGateway::CachediSCSIVolume object:
30              
31             $service_obj->Method(Att1 => { CreatedDate => $value, ..., VolumeType => $value });
32              
33             =head3 Results returned from an API call
34              
35             Use accessors for each attribute. If Att1 is expected to be an Paws::StorageGateway::CachediSCSIVolume object:
36              
37             $result = $service_obj->Method(...);
38             $result->Att1->CreatedDate
39              
40             =head1 DESCRIPTION
41              
42             Describes an iSCSI cached volume.
43              
44             =head1 ATTRIBUTES
45              
46              
47             =head2 CreatedDate => Str
48              
49             The date the volume was created. Volumes created prior to March 28,
50             2017 donE<rsquo>t have this time stamp.
51              
52              
53             =head2 SourceSnapshotId => Str
54              
55             If the cached volume was created from a snapshot, this field contains
56             the snapshot ID used, e.g. snap-78e22663. Otherwise, this field is not
57             included.
58              
59              
60             =head2 VolumeARN => Str
61              
62             The Amazon Resource Name (ARN) of the storage volume.
63              
64              
65             =head2 VolumeId => Str
66              
67             The unique identifier of the volume, e.g. vol-AE4B946D.
68              
69              
70             =head2 VolumeiSCSIAttributes => L<Paws::StorageGateway::VolumeiSCSIAttributes>
71              
72             An VolumeiSCSIAttributes object that represents a collection of iSCSI
73             attributes for one stored volume.
74              
75              
76             =head2 VolumeProgress => Num
77              
78             Represents the percentage complete if the volume is restoring or
79             bootstrapping that represents the percent of data transferred. This
80             field does not appear in the response if the cached volume is not
81             restoring or bootstrapping.
82              
83              
84             =head2 VolumeSizeInBytes => Int
85              
86             The size, in bytes, of the volume capacity.
87              
88              
89             =head2 VolumeStatus => Str
90              
91             One of the VolumeStatus values that indicates the state of the storage
92             volume.
93              
94              
95             =head2 VolumeType => Str
96              
97             One of the VolumeType enumeration values that describes the type of the
98             volume.
99              
100              
101              
102             =head1 SEE ALSO
103              
104             This class forms part of L<Paws>, describing an object used in L<Paws::StorageGateway>
105              
106             =head1 BUGS and CONTRIBUTIONS
107              
108             The source code is located here: https://github.com/pplu/aws-sdk-perl
109              
110             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
111              
112             =cut
113