blib/lib/Paws/Glacier/JobParameters.pm

filter: Statementstmt 100% 14 / 14 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 1 / 1 Podpod n/a totaltotal 100% 15 / 15 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/Glacier/InitiateVaultLock.pm ↑ Summary blib/lib/Paws/Glacier/ListJobs.pm »
1 # Generated by default/object.tt
2 package Paws::Glacier::JobParameters;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has ArchiveId => (is => 'ro', isa => 'Str');
5 1 has Description => (is => 'ro', isa => 'Str');
6 1 has Format => (is => 'ro', isa => 'Str');
7 1 has InventoryRetrievalParameters => (is => 'ro', isa => 'Paws::Glacier::InventoryRetrievalJobInput');
8 1 has OutputLocation => (is => 'ro', isa => 'Paws::Glacier::OutputLocation');
9 1 has RetrievalByteRange => (is => 'ro', isa => 'Str');
10 1 has SelectParameters => (is => 'ro', isa => 'Paws::Glacier::SelectParameters');
11 1 has SNSTopic => (is => 'ro', isa => 'Str');
12 1 has Tier => (is => 'ro', isa => 'Str');
13 1 has Type => (is => 'ro', isa => 'Str');
14  
15 1 1;
16  
17 ### main pod documentation begin ###
18  
19 =head1 NAME
20  
21 Paws::Glacier::JobParameters
22  
23 =head1 USAGE
24  
25 This class represents one of two things:
26  
27 =head3 Arguments in a call to a service
28  
29 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
30 Each attribute should be used as a named argument in the calls that expect this type of object.
31  
32 As an example, if Att1 is expected to be a Paws::Glacier::JobParameters object:
33  
34 $service_obj->Method(Att1 => { ArchiveId => $value, ..., Type => $value });
35  
36 =head3 Results returned from an API call
37  
38 Use accessors for each attribute. If Att1 is expected to be an Paws::Glacier::JobParameters object:
39  
40 $result = $service_obj->Method(...);
41 $result->Att1->ArchiveId
42  
43 =head1 DESCRIPTION
44  
45 Provides options for defining a job.
46  
47 =head1 ATTRIBUTES
48  
49  
50 =head2 ArchiveId => Str
51  
52 The ID of the archive that you want to retrieve. This field is required
53 only if C<Type> is set to C<select> or C<archive-retrieval>codeE<gt>.
54 An error occurs if you specify this request parameter for an inventory
55 retrieval job request.
56  
57  
58 =head2 Description => Str
59  
60 The optional description for the job. The description must be less than
61 or equal to 1,024 bytes. The allowable characters are 7-bit ASCII
62 without control codes-specifically, ASCII values 32-126 decimal or
63 0x20-0x7E hexadecimal.
64  
65  
66 =head2 Format => Str
67  
68 When initiating a job to retrieve a vault inventory, you can optionally
69 add this parameter to your request to specify the output format. If you
70 are initiating an inventory job and do not specify a Format field, JSON
71 is the default format. Valid values are "CSV" and "JSON".
72  
73  
74 =head2 InventoryRetrievalParameters => L<Paws::Glacier::InventoryRetrievalJobInput>
75  
76 Input parameters used for range inventory retrieval.
77  
78  
79 =head2 OutputLocation => L<Paws::Glacier::OutputLocation>
80  
81 Contains information about the location where the select job results
82 are stored.
83  
84  
85 =head2 RetrievalByteRange => Str
86  
87 The byte range to retrieve for an archive retrieval. in the form
88 "I<StartByteValue>-I<EndByteValue>" If not specified, the whole archive
89 is retrieved. If specified, the byte range must be megabyte (1024*1024)
90 aligned which means that I<StartByteValue> must be divisible by 1 MB
91 and I<EndByteValue> plus 1 must be divisible by 1 MB or be the end of
92 the archive specified as the archive byte size value minus 1. If
93 RetrievalByteRange is not megabyte aligned, this operation returns a
94 400 response.
95  
96 An error occurs if you specify this field for an inventory retrieval
97 job request.
98  
99  
100 =head2 SelectParameters => L<Paws::Glacier::SelectParameters>
101  
102 Contains the parameters that define a job.
103  
104  
105 =head2 SNSTopic => Str
106  
107 The Amazon SNS topic ARN to which Amazon S3 Glacier sends a
108 notification when the job is completed and the output is ready for you
109 to download. The specified topic publishes the notification to its
110 subscribers. The SNS topic must exist.
111  
112  
113 =head2 Tier => Str
114  
115 The tier to use for a select or an archive retrieval job. Valid values
116 are C<Expedited>, C<Standard>, or C<Bulk>. C<Standard> is the default.
117  
118  
119 =head2 Type => Str
120  
121 The job type. You can initiate a job to perform a select query on an
122 archive, retrieve an archive, or get an inventory of a vault. Valid
123 values are "select", "archive-retrieval" and "inventory-retrieval".
124  
125  
126  
127 =head1 SEE ALSO
128  
129 This class forms part of L<Paws>, describing an object used in L<Paws::Glacier>
130  
131 =head1 BUGS and CONTRIBUTIONS
132  
133 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
134  
135 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
136  
137 =cut
138  
« blib/lib/Paws/Glacier/InitiateVaultLock.pm ↑ Summary blib/lib/Paws/Glacier/ListJobs.pm »