File Coverage

blib/lib/Paws/Glacier/InventoryRetrievalJobDescription.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 bran cond sub pod time code
1             package Paws::Glacier::InventoryRetrievalJobDescription;
2 1     1   714 use Moose;
  1         3  
  1         9  
3             has EndDate => (is => 'ro', isa => 'Str');
4             has Format => (is => 'ro', isa => 'Str');
5             has Limit => (is => 'ro', isa => 'Str');
6             has Marker => (is => 'ro', isa => 'Str');
7             has StartDate => (is => 'ro', isa => 'Str');
8             1;
9              
10             ### main pod documentation begin ###
11              
12             =head1 NAME
13              
14             Paws::Glacier::InventoryRetrievalJobDescription
15              
16             =head1 USAGE
17              
18             This class represents one of two things:
19              
20             =head3 Arguments in a call to a service
21              
22             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
23             Each attribute should be used as a named argument in the calls that expect this type of object.
24              
25             As an example, if Att1 is expected to be a Paws::Glacier::InventoryRetrievalJobDescription object:
26              
27             $service_obj->Method(Att1 => { EndDate => $value, ..., StartDate => $value });
28              
29             =head3 Results returned from an API call
30              
31             Use accessors for each attribute. If Att1 is expected to be an Paws::Glacier::InventoryRetrievalJobDescription object:
32              
33             $result = $service_obj->Method(...);
34             $result->Att1->EndDate
35              
36             =head1 DESCRIPTION
37              
38             Describes the options for a range inventory retrieval job.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 EndDate => Str
44              
45             The end of the date range in UTC for vault inventory retrieval that
46             includes archives created before this date. This value should be a
47             string in the ISO 8601 date format, for example
48             C<2013-03-20T17:03:43Z>.
49              
50              
51             =head2 Format => Str
52              
53             The output format for the vault inventory list, which is set by the
54             B<InitiateJob> request when initiating a job to retrieve a vault
55             inventory. Valid values are C<CSV> and C<JSON>.
56              
57              
58             =head2 Limit => Str
59              
60             The maximum number of inventory items returned per vault inventory
61             retrieval request. This limit is set when initiating the job with the a
62             B<InitiateJob> request.
63              
64              
65             =head2 Marker => Str
66              
67             An opaque string that represents where to continue pagination of the
68             vault inventory retrieval results. You use the marker in a new
69             B<InitiateJob> request to obtain additional inventory items. If there
70             are no more inventory items, this value is C<null>. For more
71             information, see Range Inventory Retrieval.
72              
73              
74             =head2 StartDate => Str
75              
76             The start of the date range in Universal Coordinated Time (UTC) for
77             vault inventory retrieval that includes archives created on or after
78             this date. This value should be a string in the ISO 8601 date format,
79             for example C<2013-03-20T17:03:43Z>.
80              
81              
82              
83             =head1 SEE ALSO
84              
85             This class forms part of L<Paws>, describing an object used in L<Paws::Glacier>
86              
87             =head1 BUGS and CONTRIBUTIONS
88              
89             The source code is located here: https://github.com/pplu/aws-sdk-perl
90              
91             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
92              
93             =cut
94