blib/lib/Paws/Batch/ListJobs.pm untested

filter: Statementstmt 0.0% 0 / 22 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 24 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Batch::ListJobs;
3 use Moose;
4 has ArrayJobId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'arrayJobId');
5 has JobQueue => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'jobQueue');
6 has JobStatus => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'jobStatus');
7 has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults');
8 has MultiNodeJobId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'multiNodeJobId');
9 has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken');
10  
11 use MooseX::ClassAttribute;
12  
13 class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListJobs');
14 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/listjobs');
15 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
16 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Batch::ListJobsResponse');
17 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::Batch::ListJobs - Arguments for method ListJobs on L<Paws::Batch>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method ListJobs on the
28 L<AWS Batch|Paws::Batch> 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 $batch = Paws->service('Batch');
36 # To list running jobs
37 # This example lists the running jobs in the HighPriority job queue.
38 my $ListJobsResponse = $batch->ListJobs( 'JobQueue' => 'HighPriority' );
39  
40 # Results:
41 my $jobSummaryList = $ListJobsResponse->jobSummaryList;
42  
43 # Returns a L<Paws::Batch::ListJobsResponse> object.
44 # To list submitted jobs
45 # This example lists jobs in the HighPriority job queue that are in the
46 # SUBMITTED job status.
47 my $ListJobsResponse = $batch->ListJobs(
48 'JobQueue' => 'HighPriority',
49 'JobStatus' => 'SUBMITTED'
50 );
51  
52 # Results:
53 my $jobSummaryList = $ListJobsResponse->jobSummaryList;
54  
55 # Returns a L<Paws::Batch::ListJobsResponse> object.
56  
57 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.
58 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/batch/ListJobs>
59  
60 =head1 ATTRIBUTES
61  
62  
63 =head2 ArrayJobId => Str
64  
65 The job ID for an array job. Specifying an array job ID with this
66 parameter lists all child jobs from within the specified array.
67  
68  
69  
70 =head2 JobQueue => Str
71  
72 The name or full Amazon Resource Name (ARN) of the job queue used to
73 list jobs.
74  
75  
76  
77 =head2 JobStatus => Str
78  
79 The job status used to filter jobs in the specified queue. If you don't
80 specify a status, only C<RUNNING> jobs are returned.
81  
82 Valid values are: C<"SUBMITTED">, C<"PENDING">, C<"RUNNABLE">, C<"STARTING">, C<"RUNNING">, C<"SUCCEEDED">, C<"FAILED">
83  
84 =head2 MaxResults => Int
85  
86 The maximum number of results returned by C<ListJobs> in paginated
87 output. When this parameter is used, C<ListJobs> only returns
88 C<maxResults> results in a single page and a C<nextToken> response
89 element. The remaining results of the initial request can be seen by
90 sending another C<ListJobs> request with the returned C<nextToken>
91 value. This value can be between 1 and 100. If this parameter isn't
92 used, then C<ListJobs> returns up to 100 results and a C<nextToken>
93 value if applicable.
94  
95  
96  
97 =head2 MultiNodeJobId => Str
98  
99 The job ID for a multi-node parallel job. Specifying a multi-node
100 parallel job ID with this parameter lists all nodes that are associated
101 with the specified job.
102  
103  
104  
105 =head2 NextToken => Str
106  
107 The C<nextToken> value returned from a previous paginated C<ListJobs>
108 request where C<maxResults> was used and the results exceeded the value
109 of that parameter. Pagination continues from the end of the previous
110 results that returned the C<nextToken> value. This value is C<null>
111 when there are no more results to return.
112  
113 This token should be treated as an opaque identifier that's only used
114 to retrieve the next items in a list and not for other programmatic
115 purposes.
116  
117  
118  
119  
120 =head1 SEE ALSO
121  
122 This class forms part of L<Paws>, documenting arguments for method ListJobs in L<Paws::Batch>
123  
124 =head1 BUGS and CONTRIBUTIONS
125  
126 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
127  
128 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
129  
130 =cut
131