Struct aws_sdk_datapipeline::client::fluent_builders::ReportTaskRunnerHeartbeat

pub struct ReportTaskRunnerHeartbeat { /* private fields */ }

Fluent builder constructing a request to ReportTaskRunnerHeartbeat.

Task runners call ReportTaskRunnerHeartbeat every 15 minutes to indicate that they are operational. If the AWS Data Pipeline Task Runner is launched on a resource managed by AWS Data Pipeline, the web service can use this call to detect when the task runner application has failed and restart a new instance.

POST / HTTP/1.1 Content-Type: application/x-amz-json-1.1 X-Amz-Target: DataPipeline.ReportTaskRunnerHeartbeat Content-Length: 84 Host: datapipeline.us-east-1.amazonaws.com X-Amz-Date: Mon, 12 Nov 2012 17:49:52 GMT Authorization: AuthParams {"taskrunnerId": "1234567890", "workerGroup": "wg-12345", "hostname": "example.com"} Status: x-amzn-RequestId: b3104dc5-0734-11e2-af6f-6bc7a6be60d9 Content-Type: application/x-amz-json-1.1 Content-Length: 20 Date: Mon, 12 Nov 2012 17:50:53 GMT {"terminate": false}

Implementations

impl ReportTaskRunnerHeartbeat

pub async fn customize(
    self
) -> Result<CustomizableOperation<ReportTaskRunnerHeartbeat, AwsResponseRetryClassifier>, SdkError<ReportTaskRunnerHeartbeatError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<ReportTaskRunnerHeartbeatOutput, SdkError<ReportTaskRunnerHeartbeatError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn taskrunner_id(self, input: impl Into<String>) -> Self

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.

pub fn set_taskrunner_id(self, input: Option<String>) -> Self

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.

pub fn worker_group(self, input: impl Into<String>) -> Self

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.

pub fn set_worker_group(self, input: Option<String>) -> Self

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.

pub fn hostname(self, input: impl Into<String>) -> Self

The public DNS name of the task runner.

pub fn set_hostname(self, input: Option<String>) -> Self

The public DNS name of the task runner.

Trait Implementations

impl Clone for ReportTaskRunnerHeartbeat

fn clone(&self) -> ReportTaskRunnerHeartbeat

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ReportTaskRunnerHeartbeat

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.