File Coverage

blib/lib/Paws/Glacier/ListJobs.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 bran cond sub pod time code
1              
2             package Paws::Glacier::ListJobs;
3 1     1   359 use Moose;
  1         3  
  1         8  
4             has AccountId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'accountId' , required => 1);
5             has Completed => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'completed' );
6             has Limit => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'limit' );
7             has Marker => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'marker' );
8             has Statuscode => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'statuscode' );
9             has VaultName => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'vaultName' , required => 1);
10              
11 1     1   5450 use MooseX::ClassAttribute;
  1         3  
  1         5  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListJobs');
14             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/{accountId}/vaults/{vaultName}/jobs');
15             class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET');
16             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Glacier::ListJobsOutput');
17             class_has _result_key => (isa => 'Str', is => 'ro');
18             1;
19              
20             ### main pod documentation begin ###
21              
22             =head1 NAME
23              
24             Paws::Glacier::ListJobs - Arguments for method ListJobs on Paws::Glacier
25              
26             =head1 DESCRIPTION
27              
28             This class represents the parameters used for calling the method ListJobs on the
29             Amazon Glacier service. Use the attributes of this class
30             as arguments to method ListJobs.
31              
32             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListJobs.
33              
34             As an example:
35              
36             $service_obj->ListJobs(Att1 => $value1, Att2 => $value2, ...);
37              
38             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.
39              
40             =head1 ATTRIBUTES
41              
42              
43             =head2 B<REQUIRED> AccountId => Str
44              
45             The C<AccountId> value is the AWS account ID of the account that owns
46             the vault. You can either specify an AWS account ID or optionally a
47             single 'C<->' (hyphen), in which case Amazon Glacier uses the AWS
48             account ID associated with the credentials used to sign the request. If
49             you use an account ID, do not include any hyphens ('-') in the ID.
50              
51              
52              
53             =head2 Completed => Str
54              
55             The state of the jobs to return. You can specify C<true> or C<false>.
56              
57              
58              
59             =head2 Limit => Str
60              
61             The maximum number of jobs to be returned. The default limit is 1000.
62             The number of jobs returned might be fewer than the specified limit,
63             but the number of returned jobs never exceeds the limit.
64              
65              
66              
67             =head2 Marker => Str
68              
69             An opaque string used for pagination. This value specifies the job at
70             which the listing of jobs should begin. Get the marker value from a
71             previous List Jobs response. You only need to include the marker if you
72             are continuing the pagination of results started in a previous List
73             Jobs request.
74              
75              
76              
77             =head2 Statuscode => Str
78              
79             The type of job status to return. You can specify the following values:
80             C<InProgress>, C<Succeeded>, or C<Failed>.
81              
82              
83              
84             =head2 B<REQUIRED> VaultName => Str
85              
86             The name of the vault.
87              
88              
89              
90              
91             =head1 SEE ALSO
92              
93             This class forms part of L<Paws>, documenting arguments for method ListJobs in L<Paws::Glacier>
94              
95             =head1 BUGS and CONTRIBUTIONS
96              
97             The source code is located here: https://github.com/pplu/aws-sdk-perl
98              
99             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
100              
101             =cut
102