File Coverage

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