File Coverage

blib/lib/Paws/DataPipeline/PollForTask.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::DataPipeline::PollForTask;
3 1     1   636 use Moose;
  1         4  
  1         9  
4             has Hostname => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'hostname' );
5             has InstanceIdentity => (is => 'ro', isa => 'Paws::DataPipeline::InstanceIdentity', traits => ['NameInRequest'], request_name => 'instanceIdentity' );
6             has WorkerGroup => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'workerGroup' , required => 1);
7              
8 1     1   7496 use MooseX::ClassAttribute;
  1         3  
  1         8  
9              
10             class_has _api_call => (isa => 'Str', is => 'ro', default => 'PollForTask');
11             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DataPipeline::PollForTaskOutput');
12             class_has _result_key => (isa => 'Str', is => 'ro');
13             1;
14              
15             ### main pod documentation begin ###
16              
17             =head1 NAME
18              
19             Paws::DataPipeline::PollForTask - Arguments for method PollForTask on Paws::DataPipeline
20              
21             =head1 DESCRIPTION
22              
23             This class represents the parameters used for calling the method PollForTask on the
24             AWS Data Pipeline service. Use the attributes of this class
25             as arguments to method PollForTask.
26              
27             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to PollForTask.
28              
29             As an example:
30              
31             $service_obj->PollForTask(Att1 => $value1, Att2 => $value2, ...);
32              
33             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.
34              
35             =head1 ATTRIBUTES
36              
37              
38             =head2 Hostname => Str
39              
40             The public DNS name of the calling task runner.
41              
42              
43              
44             =head2 InstanceIdentity => L<Paws::DataPipeline::InstanceIdentity>
45              
46             Identity information for the EC2 instance that is hosting the task
47             runner. You can get this value from the instance using
48             C<http://169.254.169.254/latest/meta-data/instance-id>. For more
49             information, see Instance Metadata in the I<Amazon Elastic Compute
50             Cloud User Guide.> Passing in this value proves that your task runner
51             is running on an EC2 instance, and ensures the proper AWS Data Pipeline
52             service charges are applied to your pipeline.
53              
54              
55              
56             =head2 B<REQUIRED> WorkerGroup => Str
57              
58             The type of task the task runner is configured to accept and process.
59             The worker group is set as a field on objects in the pipeline when they
60             are created. You can only specify a single value for C<workerGroup> in
61             the call to C<PollForTask>. There are no wildcard values permitted in
62             C<workerGroup>; the string must be an exact, case-sensitive, match.
63              
64              
65              
66              
67             =head1 SEE ALSO
68              
69             This class forms part of L<Paws>, documenting arguments for method PollForTask in L<Paws::DataPipeline>
70              
71             =head1 BUGS and CONTRIBUTIONS
72              
73             The source code is located here: https://github.com/pplu/aws-sdk-perl
74              
75             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
76              
77             =cut
78