File Coverage

blib/lib/Paws/Glacier/GlacierJobDescription.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	sub	time	code
1
2				package Paws::Glacier::GlacierJobDescription;
3	1	1	762	use Moose;
	1		3
	1		9
4				has Action => (is => 'ro', isa => 'Str');
5				has ArchiveId => (is => 'ro', isa => 'Str');
6				has ArchiveSHA256TreeHash => (is => 'ro', isa => 'Str');
7				has ArchiveSizeInBytes => (is => 'ro', isa => 'Int');
8				has Completed => (is => 'ro', isa => 'Bool');
9				has CompletionDate => (is => 'ro', isa => 'Str');
10				has CreationDate => (is => 'ro', isa => 'Str');
11				has InventoryRetrievalParameters => (is => 'ro', isa => 'Paws::Glacier::InventoryRetrievalJobDescription');
12				has InventorySizeInBytes => (is => 'ro', isa => 'Int');
13				has JobDescription => (is => 'ro', isa => 'Str');
14				has JobId => (is => 'ro', isa => 'Str');
15				has RetrievalByteRange => (is => 'ro', isa => 'Str');
16				has SHA256TreeHash => (is => 'ro', isa => 'Str');
17				has SNSTopic => (is => 'ro', isa => 'Str');
18				has StatusCode => (is => 'ro', isa => 'Str');
19				has StatusMessage => (is => 'ro', isa => 'Str');
20				has Tier => (is => 'ro', isa => 'Str');
21				has VaultARN => (is => 'ro', isa => 'Str');
22
23				has _request_id => (is => 'ro', isa => 'Str');
24				1;
25
26				### main pod documentation begin ###
27
28				=head1 NAME
29
30				Paws::Glacier::GlacierJobDescription
31
32				=head1 ATTRIBUTES
33
34
35				=head2 Action => Str
36
37				The job type. It is either ArchiveRetrieval or InventoryRetrieval.
38
39				Valid values are: C<"ArchiveRetrieval">, C<"InventoryRetrieval">
40				=head2 ArchiveId => Str
41
42				For an ArchiveRetrieval job, this is the archive ID requested for
43				download. Otherwise, this field is null.
44
45
46				=head2 ArchiveSHA256TreeHash => Str
47
48				The SHA256 tree hash of the entire archive for an archive retrieval.
49				For inventory retrieval jobs, this field is null.
50
51
52				=head2 ArchiveSizeInBytes => Int
53
54				For an ArchiveRetrieval job, this is the size in bytes of the archive
55				being requested for download. For the InventoryRetrieval job, the value
56				is null.
57
58
59				=head2 Completed => Bool
60
61				The job status. When a job is completed, you get the job's output.
62
63
64				=head2 CompletionDate => Str
65
66				The UTC time that the archive retrieval request completed. While the
67				job is in progress, the value will be null.
68
69
70				=head2 CreationDate => Str
71
72				The UTC date when the job was created. A string representation of ISO
73				8601 date format, for example, "2012-03-20T17:03:43.221Z".
74
75
76				=head2 InventoryRetrievalParameters => L<Paws::Glacier::InventoryRetrievalJobDescription>
77
78				Parameters used for range inventory retrieval.
79
80
81				=head2 InventorySizeInBytes => Int
82
83				For an InventoryRetrieval job, this is the size in bytes of the
84				inventory requested for download. For the ArchiveRetrieval job, the
85				value is null.
86
87
88				=head2 JobDescription => Str
89
90				The job description you provided when you initiated the job.
91
92
93				=head2 JobId => Str
94
95				An opaque string that identifies an Amazon Glacier job.
96
97
98				=head2 RetrievalByteRange => Str
99
100				The retrieved byte range for archive retrieval jobs in the form
101				"I<StartByteValue>-I<EndByteValue>" If no range was specified in the
102				archive retrieval, then the whole archive is retrieved and
103				I<StartByteValue> equals 0 and I<EndByteValue> equals the size of the
104				archive minus 1. For inventory retrieval jobs this field is null.
105
106
107				=head2 SHA256TreeHash => Str
108
109				For an ArchiveRetrieval job, it is the checksum of the archive.
110				Otherwise, the value is null.
111
112				The SHA256 tree hash value for the requested range of an archive. If
113				the Initiate a Job request for an archive specified a tree-hash aligned
114				range, then this field returns a value.
115
116				For the specific case when the whole archive is retrieved, this value
117				is the same as the ArchiveSHA256TreeHash value.
118
119				This field is null in the following situations:
120
121				=over
122
123				=item *
124
125				Archive retrieval jobs that specify a range that is not tree-hash
126				aligned.
127
128				=back
129
130				=over
131
132				=item *
133
134				Archival jobs that specify a range that is equal to the whole archive
135				and the job status is InProgress.
136
137				=back
138
139				=over
140
141				=item *
142
143				Inventory jobs.
144
145				=back
146
147
148
149				=head2 SNSTopic => Str
150
151				An Amazon Simple Notification Service (Amazon SNS) topic that receives
152				notification.
153
154
155				=head2 StatusCode => Str
156
157				The status code can be InProgress, Succeeded, or Failed, and indicates
158				the status of the job.
159
160				Valid values are: C<"InProgress">, C<"Succeeded">, C<"Failed">
161				=head2 StatusMessage => Str
162
163				A friendly message that describes the job status.
164
165
166				=head2 Tier => Str
167
168				The retrieval option to use for the archive retrieval. Valid values are
169				C<Expedited>, C<Standard>, or C<Bulk>. C<Standard> is the default.
170
171
172				=head2 VaultARN => Str
173
174				The Amazon Resource Name (ARN) of the vault from which the archive
175				retrieval was requested.
176
177
178				=head2 _request_id => Str
179
180
181				=cut
182