blib/lib/Paws/Glacier/InitiateMultipartUpload.pm

filter: Statementstmt 100% 15 / 15 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 17 / 17 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/Glacier/InitiateJob.pm ↑ Summary blib/lib/Paws/Glacier/InitiateMultipartUploadOutput.pm »
1  
2 package Paws::Glacier::InitiateMultipartUpload;
3 3 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 3 has AccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'accountId', required => 1);
5 3 has ArchiveDescription => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-archive-description');
6 3 has PartSize => (is => 'ro', isa => 'Str', traits => ['ParamInHeader'], header_name => 'x-amz-part-size');
7 3 has VaultName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'vaultName', required => 1);
8  
9 3 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
10  
11 3 class_has _api_call => (isa => 'Str', is => 'ro', default => 'InitiateMultipartUpload');
12 3 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{accountId}/vaults/{vaultName}/multipart-uploads');
13 3 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
14 3 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Glacier::InitiateMultipartUploadOutput');
15 3 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::Glacier::InitiateMultipartUpload - Arguments for method InitiateMultipartUpload on L<Paws::Glacier>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method InitiateMultipartUpload on the
26 L<Amazon Glacier|Paws::Glacier> service. Use the attributes of this class
27 as arguments to method InitiateMultipartUpload.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to InitiateMultipartUpload.
30  
31 =head1 SYNOPSIS
32  
33 my $glacier = Paws->service('Glacier');
34 # To initiate a multipart upload
35 # The example initiates a multipart upload to a vault named my-vault with a part
36 # size of 1 MiB (1024 x 1024 bytes) per file.
37 my $InitiateMultipartUploadOutput = $glacier->InitiateMultipartUpload(
38 'AccountId' => '-',
39 'PartSize' => 1048576,
40 'VaultName' => 'my-vault'
41 );
42  
43 # Results:
44 my $location = $InitiateMultipartUploadOutput->location;
45 my $uploadId = $InitiateMultipartUploadOutput->uploadId;
46  
47 # Returns a L<Paws::Glacier::InitiateMultipartUploadOutput> object.
48  
49 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.
50 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/glacier/InitiateMultipartUpload>
51  
52 =head1 ATTRIBUTES
53  
54  
55 =head2 B<REQUIRED> AccountId => Str
56  
57 The C<AccountId> value is the AWS account ID of the account that owns
58 the vault. You can either specify an AWS account ID or optionally a
59 single 'C<->' (hyphen), in which case Amazon S3 Glacier uses the AWS
60 account ID associated with the credentials used to sign the request. If
61 you use an account ID, do not include any hyphens ('-') in the ID.
62  
63  
64  
65 =head2 ArchiveDescription => Str
66  
67 The archive description that you are uploading in parts.
68  
69 The part size must be a megabyte (1024 KB) multiplied by a power of 2,
70 for example 1048576 (1 MB), 2097152 (2 MB), 4194304 (4 MB), 8388608 (8
71 MB), and so on. The minimum allowable part size is 1 MB, and the
72 maximum is 4 GB (4096 MB).
73  
74  
75  
76 =head2 PartSize => Str
77  
78 The size of each part except the last, in bytes. The last part can be
79 smaller than this part size.
80  
81  
82  
83 =head2 B<REQUIRED> VaultName => Str
84  
85 The name of the vault.
86  
87  
88  
89  
90 =head1 SEE ALSO
91  
92 This class forms part of L<Paws>, documenting arguments for method InitiateMultipartUpload in L<Paws::Glacier>
93  
94 =head1 BUGS and CONTRIBUTIONS
95  
96 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
97  
98 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
99  
100 =cut
101  
« blib/lib/Paws/Glacier/InitiateJob.pm ↑ Summary blib/lib/Paws/Glacier/InitiateMultipartUploadOutput.pm »