blib/lib/Paws/Glacier/CompleteMultipartUpload.pm

filter: Statementstmt 100% 16 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 18 / 18 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/Glacier/ArchiveCreationOutput.pm ↑ Summary blib/lib/Paws/Glacier/CreateVault.pm »
1  
2 package Paws::Glacier::CompleteMultipartUpload;
3 2 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 2 has AccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'accountId', required => 1);
5 2 has ArchiveSize => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-archive-size');
6 2 has Checksum => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-sha256-tree-hash');
7 2 has UploadId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'uploadId', required => 1);
8 2 has VaultName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'vaultName', required => 1);
9  
10 2 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
11  
12 2 class_has _api_call => (isa => 'Str', is => 'ro', default => 'CompleteMultipartUpload');
13 2 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{accountId}/vaults/{vaultName}/multipart-uploads/{uploadId}');
14 2 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
15 2 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Glacier::ArchiveCreationOutput');
16 2 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::Glacier::CompleteMultipartUpload - Arguments for method CompleteMultipartUpload on L<Paws::Glacier>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method CompleteMultipartUpload on the
27 L<Amazon Glacier|Paws::Glacier> service. Use the attributes of this class
28 as arguments to method CompleteMultipartUpload.
29  
30 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to CompleteMultipartUpload.
31  
32 =head1 SYNOPSIS
33  
34 my $glacier = Paws->service('Glacier');
35 # To complete a multipart upload
36 # The example completes a multipart upload for a 3 MiB archive.
37 my $ArchiveCreationOutput = $glacier->CompleteMultipartUpload(
38 'AccountId' => '-',
39 'ArchiveSize' => 3145728,
40 'Checksum' =>
41 '9628195fcdbcbbe76cdde456d4646fa7de5f219fb39823836d81f0cc0e18aa67',
42 'UploadId' =>
43 '19gaRezEXAMPLES6Ry5YYdqthHOC_kGRCT03L9yetr220UmPtBYKk-OssZtLqyFu7sY1_lR7vgFuJV6NtcV5zpsJ',
44 'VaultName' => 'my-vault'
45 );
46  
47 # Results:
48 my $archiveId = $ArchiveCreationOutput->archiveId;
49 my $checksum = $ArchiveCreationOutput->checksum;
50 my $location = $ArchiveCreationOutput->location;
51  
52 # Returns a L<Paws::Glacier::ArchiveCreationOutput> object.
53  
54 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.
55 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/glacier/CompleteMultipartUpload>
56  
57 =head1 ATTRIBUTES
58  
59  
60 =head2 B<REQUIRED> AccountId => Str
61  
62 The C<AccountId> value is the AWS account ID of the account that owns
63 the vault. You can either specify an AWS account ID or optionally a
64 single 'C<->' (hyphen), in which case Amazon S3 Glacier uses the AWS
65 account ID associated with the credentials used to sign the request. If
66 you use an account ID, do not include any hyphens ('-') in the ID.
67  
68  
69  
70 =head2 ArchiveSize => Str
71  
72 The total size, in bytes, of the entire archive. This value should be
73 the sum of all the sizes of the individual parts that you uploaded.
74  
75  
76  
77 =head2 Checksum => Str
78  
79 The SHA256 tree hash of the entire archive. It is the tree hash of
80 SHA256 tree hash of the individual parts. If the value you specify in
81 the request does not match the SHA256 tree hash of the final assembled
82 archive as computed by Amazon S3 Glacier (Glacier), Glacier returns an
83 error and the request fails.
84  
85  
86  
87 =head2 B<REQUIRED> UploadId => Str
88  
89 The upload ID of the multipart upload.
90  
91  
92  
93 =head2 B<REQUIRED> VaultName => Str
94  
95 The name of the vault.
96  
97  
98  
99  
100 =head1 SEE ALSO
101  
102 This class forms part of L<Paws>, documenting arguments for method CompleteMultipartUpload in L<Paws::Glacier>
103  
104 =head1 BUGS and CONTRIBUTIONS
105  
106 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
107  
108 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
109  
110 =cut
111  
« blib/lib/Paws/Glacier/ArchiveCreationOutput.pm ↑ Summary blib/lib/Paws/Glacier/CreateVault.pm »