blib/lib/Paws/Glacier/ListJobs.pm

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