« blib/lib/Paws/DataPipeline/PipelineObjectMap.pm
↑ Summary
blib/lib/Paws/DataPipeline/PollForTaskOutput.pm »
| 1 | |||
| 2 | package Paws::DataPipeline::PollForTask; | ||
| 3 | use Moose; | ||
| 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 | use MooseX::ClassAttribute; | ||
| 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 L<Paws::DataPipeline> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method PollForTask on the | ||
| 24 | L<AWS Data Pipeline|Paws::DataPipeline> 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 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $datapipeline = Paws->service('DataPipeline'); | ||
| 32 | my $PollForTaskOutput = $datapipeline->PollForTask( | ||
| 33 | WorkerGroup => 'Mystring', | ||
| 34 | Hostname => 'Myid', # OPTIONAL | ||
| 35 | InstanceIdentity => { | ||
| 36 | Document => 'Mystring', # max: 1024 | ||
| 37 | Signature => 'Mystring', # max: 1024 | ||
| 38 | }, # OPTIONAL | ||
| 39 | ); | ||
| 40 | |||
| 41 | # Results: | ||
| 42 | my $TaskObject = $PollForTaskOutput->TaskObject; | ||
| 43 | |||
| 44 | # Returns a L<Paws::DataPipeline::PollForTaskOutput> object. | ||
| 45 | |||
| 46 | 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. | ||
| 47 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/datapipeline/PollForTask> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 Hostname => Str | ||
| 53 | |||
| 54 | The public DNS name of the calling task runner. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 InstanceIdentity => L<Paws::DataPipeline::InstanceIdentity> | ||
| 59 | |||
| 60 | Identity information for the EC2 instance that is hosting the task | ||
| 61 | runner. You can get this value from the instance using | ||
| 62 | C<http://169.254.169.254/latest/meta-data/instance-id>. For more | ||
| 63 | information, see Instance Metadata | ||
| 64 | (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html) | ||
| 65 | in the I<Amazon Elastic Compute Cloud User Guide.> Passing in this | ||
| 66 | value proves that your task runner is running on an EC2 instance, and | ||
| 67 | ensures the proper AWS Data Pipeline service charges are applied to | ||
| 68 | your pipeline. | ||
| 69 | |||
| 70 | |||
| 71 | |||
| 72 | =head2 B<REQUIRED> WorkerGroup => Str | ||
| 73 | |||
| 74 | The type of task the task runner is configured to accept and process. | ||
| 75 | The worker group is set as a field on objects in the pipeline when they | ||
| 76 | are created. You can only specify a single value for C<workerGroup> in | ||
| 77 | the call to C<PollForTask>. There are no wildcard values permitted in | ||
| 78 | C<workerGroup>; the string must be an exact, case-sensitive, match. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | =head1 SEE ALSO | ||
| 84 | |||
| 85 | This class forms part of L<Paws>, documenting arguments for method PollForTask in L<Paws::DataPipeline> | ||
| 86 | |||
| 87 | =head1 BUGS and CONTRIBUTIONS | ||
| 88 | |||
| 89 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 90 | |||
| 91 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 92 | |||
| 93 | =cut | ||
| 94 |