« blib/lib/Paws/DataPipeline/ReportTaskProgressOutput.pm
↑ Summary
blib/lib/Paws/DataPipeline/ReportTaskRunnerHeartbeatOutput.pm »
| 1 | |||
| 2 | package Paws::DataPipeline::ReportTaskRunnerHeartbeat; | ||
| 3 | use Moose; | ||
| 4 | has Hostname => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'hostname' ); | ||
| 5 | has TaskrunnerId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'taskrunnerId' , required => 1); | ||
| 6 | has WorkerGroup => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'workerGroup' ); | ||
| 7 | |||
| 8 | use MooseX::ClassAttribute; | ||
| 9 | |||
| 10 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ReportTaskRunnerHeartbeat'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::DataPipeline::ReportTaskRunnerHeartbeatOutput'); | ||
| 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::ReportTaskRunnerHeartbeat - Arguments for method ReportTaskRunnerHeartbeat on L<Paws::DataPipeline> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method ReportTaskRunnerHeartbeat on the | ||
| 24 | L<AWS Data Pipeline|Paws::DataPipeline> service. Use the attributes of this class | ||
| 25 | as arguments to method ReportTaskRunnerHeartbeat. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ReportTaskRunnerHeartbeat. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $datapipeline = Paws->service('DataPipeline'); | ||
| 32 | my $ReportTaskRunnerHeartbeatOutput = | ||
| 33 | $datapipeline->ReportTaskRunnerHeartbeat( | ||
| 34 | TaskrunnerId => 'Myid', | ||
| 35 | Hostname => 'Myid', # OPTIONAL | ||
| 36 | WorkerGroup => 'Mystring', # OPTIONAL | ||
| 37 | ); | ||
| 38 | |||
| 39 | # Results: | ||
| 40 | my $Terminate = $ReportTaskRunnerHeartbeatOutput->Terminate; | ||
| 41 | |||
| 42 | # Returns a L<Paws::DataPipeline::ReportTaskRunnerHeartbeatOutput> object. | ||
| 43 | |||
| 44 | 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. | ||
| 45 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/datapipeline/ReportTaskRunnerHeartbeat> | ||
| 46 | |||
| 47 | =head1 ATTRIBUTES | ||
| 48 | |||
| 49 | |||
| 50 | =head2 Hostname => Str | ||
| 51 | |||
| 52 | The public DNS name of the task runner. | ||
| 53 | |||
| 54 | |||
| 55 | |||
| 56 | =head2 B<REQUIRED> TaskrunnerId => Str | ||
| 57 | |||
| 58 | The ID of the task runner. This value should be unique across your AWS | ||
| 59 | account. In the case of AWS Data Pipeline Task Runner launched on a | ||
| 60 | resource managed by AWS Data Pipeline, the web service provides a | ||
| 61 | unique identifier when it launches the application. If you have written | ||
| 62 | a custom task runner, you should assign a unique identifier for the | ||
| 63 | task runner. | ||
| 64 | |||
| 65 | |||
| 66 | |||
| 67 | =head2 WorkerGroup => Str | ||
| 68 | |||
| 69 | The type of task the task runner is configured to accept and process. | ||
| 70 | The worker group is set as a field on objects in the pipeline when they | ||
| 71 | are created. You can only specify a single value for C<workerGroup>. | ||
| 72 | There are no wildcard values permitted in C<workerGroup>; the string | ||
| 73 | must be an exact, case-sensitive, match. | ||
| 74 | |||
| 75 | |||
| 76 | |||
| 77 | |||
| 78 | =head1 SEE ALSO | ||
| 79 | |||
| 80 | This class forms part of L<Paws>, documenting arguments for method ReportTaskRunnerHeartbeat in L<Paws::DataPipeline> | ||
| 81 | |||
| 82 | =head1 BUGS and CONTRIBUTIONS | ||
| 83 | |||
| 84 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 85 | |||
| 86 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 87 | |||
| 88 | =cut | ||
| 89 |