File Coverage

blib/lib/Paws/Glacier/GetJobOutput.pm

Criterion	Covered	Total	%
statement	6	6	100.0
branch			n/a
condition			n/a
subroutine	2	2	100.0
pod			n/a
total	8	8	100.0

line	stmt	sub	time	code
1
2				package Paws::Glacier::GetJobOutput;
3	1	1	315	use Moose;
	1		4
	1		6
4				has AccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'accountId' , required => 1);
5				has JobId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'jobId' , required => 1);
6				has Range => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'range' );
7				has VaultName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'vaultName' , required => 1);
8
9	1	1	5501	use MooseX::ClassAttribute;
	1		3
	1		7
10
11				class_has _api_call => (isa => 'Str', is => 'ro', default => 'GetJobOutput');
12				class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{accountId}/vaults/{vaultName}/jobs/{jobId}/output');
13				class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
14				class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Glacier::GetJobOutputOutput');
15				class_has _result_key => (isa => 'Str', is => 'ro');
16				1;
17
18				### main pod documentation begin ###
19
20				=head1 NAME
21
22				Paws::Glacier::GetJobOutput - Arguments for method GetJobOutput on Paws::Glacier
23
24				=head1 DESCRIPTION
25
26				This class represents the parameters used for calling the method GetJobOutput on the
27				Amazon Glacier service. Use the attributes of this class
28				as arguments to method GetJobOutput.
29
30				You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetJobOutput.
31
32				As an example:
33
34				$service_obj->GetJobOutput(Att1 => $value1, Att2 => $value2, ...);
35
36				Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
37
38				=head1 ATTRIBUTES
39
40
41				=head2 B<REQUIRED> AccountId => Str
42
43				The C<AccountId> value is the AWS account ID of the account that owns
44				the vault. You can either specify an AWS account ID or optionally a
45				single 'C<->' (hyphen), in which case Amazon Glacier uses the AWS
46				account ID associated with the credentials used to sign the request. If
47				you use an account ID, do not include any hyphens ('-') in the ID.
48
49
50
51				=head2 B<REQUIRED> JobId => Str
52
53				The job ID whose data is downloaded.
54
55
56
57				=head2 Range => Str
58
59				The range of bytes to retrieve from the output. For example, if you
60				want to download the first 1,048,576 bytes, specify the range as
61				C<bytes=0-1048575>. By default, this operation downloads the entire
62				output.
63
64				If the job output is large, then you can use a range to retrieve a
65				portion of the output. This allows you to download the entire output in
66				smaller chunks of bytes. For example, suppose you have 1 GB of job
67				output you want to download and you decide to download 128 MB chunks of
68				data at a time, which is a total of eight Get Job Output requests. You
69				use the following process to download the job output:
70
71				=over
72
73				=item 1.
74
75				Download a 128 MB chunk of output by specifying the appropriate byte
76				range. Verify that all 128 MB of data was received.
77
78				=item 2.
79
80				Along with the data, the response includes a SHA256 tree hash of the
81				payload. You compute the checksum of the payload on the client and
82				compare it with the checksum you received in the response to ensure you
83				received all the expected data.
84
85				=item 3.
86
87				Repeat steps 1 and 2 for all the eight 128 MB chunks of output data,
88				each time specifying the appropriate byte range.
89
90				=item 4.
91
92				After downloading all the parts of the job output, you have a list of
93				eight checksum values. Compute the tree hash of these values to find
94				the checksum of the entire output. Using the DescribeJob API, obtain
95				job information of the job that provided you the output. The response
96				includes the checksum of the entire archive stored in Amazon Glacier.
97				You compare this value with the checksum you computed to ensure you
98				have downloaded the entire archive content with no errors.
99
100				=back
101
102
103
104
105				=head2 B<REQUIRED> VaultName => Str
106
107				The name of the vault.
108
109
110
111
112				=head1 SEE ALSO
113
114				This class forms part of L<Paws>, documenting arguments for method GetJobOutput in L<Paws::Glacier>
115
116				=head1 BUGS and CONTRIBUTIONS
117
118				The source code is located here: https://github.com/pplu/aws-sdk-perl
119
120				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
121
122				=cut
123