You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::DataPipeline::Types::ReportTaskRunnerHeartbeatInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb

Overview

Note:

When making an API call, you may pass ReportTaskRunnerHeartbeatInput data as a hash:

{
  taskrunner_id: "id", # required
  worker_group: "string",
  hostname: "id",
}

Contains the parameters for ReportTaskRunnerHeartbeat.

Instance Attribute Summary collapse

Instance Attribute Details

#hostnameString

The public DNS name of the task runner.

Returns:

  • (String)


1186
1187
1188
1189
1190
1191
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1186

class ReportTaskRunnerHeartbeatInput < Struct.new(
  :taskrunner_id,
  :worker_group,
  :hostname)
  include Aws::Structure
end

#taskrunner_idString

The ID of the task runner. This value should be unique across your AWS account. In the case of AWS Data Pipeline Task Runner launched on a resource managed by AWS Data Pipeline, the web service provides a unique identifier when it launches the application. If you have written a custom task runner, you should assign a unique identifier for the task runner.

Returns:

  • (String)


1186
1187
1188
1189
1190
1191
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1186

class ReportTaskRunnerHeartbeatInput < Struct.new(
  :taskrunner_id,
  :worker_group,
  :hostname)
  include Aws::Structure
end

#worker_groupString

The type of task the task runner is configured to accept and process. The worker group is set as a field on objects in the pipeline when they are created. You can only specify a single value for workerGroup. There are no wildcard values permitted in workerGroup; the string must be an exact, case-sensitive, match.

Returns:

  • (String)


1186
1187
1188
1189
1190
1191
# File 'gems/aws-sdk-datapipeline/lib/aws-sdk-datapipeline/types.rb', line 1186

class ReportTaskRunnerHeartbeatInput < Struct.new(
  :taskrunner_id,
  :worker_group,
  :hostname)
  include Aws::Structure
end