Share via

RepairTask

  • Article

Represents a repair task, which includes information about what kind of repair was requested, what its progress is, and what its final result was.

This type supports the Service Fabric platform; it is not meant to be used directly from your code.

Properties

Name Type Required
TaskId string Yes
Version string No
Description string No
State string (enum) Yes
Flags integer No
Action string Yes
Target RepairTargetDescriptionBase No
Executor string No
ExecutorData string No
Impact RepairImpactDescriptionBase No
ResultStatus string (enum) No
ResultCode integer No
ResultDetails string No
History RepairTaskHistory No
PreparingHealthCheckState string (enum) No
RestoringHealthCheckState string (enum) No
PerformPreparingHealthCheck boolean No
PerformRestoringHealthCheck boolean No

TaskId

Type: string
Required: Yes

The ID of the repair task.

Version

Type: string
Required: No

The version of the repair task. When creating a new repair task, the version must be set to zero. When updating a repair task, the version is used for optimistic concurrency checks. If the version is set to zero, the update will not check for write conflicts. If the version is set to a non-zero value, then the update will only succeed if the actual current version of the repair task matches this value.

Description

Type: string
Required: No

A description of the purpose of the repair task, or other informational details. May be set when the repair task is created, and is immutable once set.

State

Type: string (enum)
Required: Yes

The workflow state of the repair task. Valid initial states are Created, Claimed, and Preparing.

Possible values are:

  • Invalid - Indicates that the repair task state is invalid. All Service Fabric enumerations have the invalid value.
  • Created - Indicates that the repair task has been created.
  • Claimed - Indicates that the repair task has been claimed by a repair executor.
  • Preparing - Indicates that the Repair Manager is preparing the system to handle the impact of the repair task, usually by taking resources offline gracefully.
  • Approved - Indicates that the repair task has been approved by the Repair Manager and is safe to execute.
  • Executing - Indicates that execution of the repair task is in progress.
  • Restoring - Indicates that the Repair Manager is restoring the system to its pre-repair state, usually by bringing resources back online.
  • Completed - Indicates that the repair task has completed, and no further state changes will occur.

Flags

Type: integer
Required: No

A bitwise-OR of the following values, which gives additional details about the status of the repair task.

  • 1 - Cancellation of the repair has been requested
  • 2 - Abort of the repair has been requested
  • 4 - Approval of the repair was forced via client request

Action

Type: string
Required: Yes

The requested repair action. Must be specified when the repair task is created, and is immutable once set.

Target

Type: RepairTargetDescriptionBase
Required: No

The target object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair. May be set when the repair task is created, and is immutable once set.

Executor

Type: string
Required: No

The name of the repair executor. Must be specified in Claimed and later states, and is immutable once set.

ExecutorData

Type: string
Required: No

A data string that the repair executor can use to store its internal state.

Impact

Type: RepairImpactDescriptionBase
Required: No

The impact object determines what actions the system will take to prepare for the impact of the repair, prior to approving execution of the repair. Impact must be specified by the repair executor when transitioning to the Preparing state, and is immutable once set.

ResultStatus

Type: string (enum)
Required: No

A value describing the overall result of the repair task execution. Must be specified in the Restoring and later states, and is immutable once set.

Possible values are:

  • Invalid - Indicates that the repair task result is invalid. All Service Fabric enumerations have the invalid value.
  • Succeeded - Indicates that the repair task completed execution successfully.
  • Cancelled - Indicates that the repair task was cancelled prior to execution.
  • Interrupted - Indicates that execution of the repair task was interrupted by a cancellation request after some work had already been performed.
  • Failed - Indicates that there was a failure during execution of the repair task. Some work may have been performed.
  • Pending - Indicates that the repair task result is not yet available, because the repair task has not finished executing.

ResultCode

Type: integer
Required: No

A numeric value providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set.

ResultDetails

Type: string
Required: No

A string providing additional details about the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set.

History

Type: RepairTaskHistory
Required: No

An object that contains timestamps of the repair task's state transitions. These timestamps are updated by the system, and cannot be directly modified.

PreparingHealthCheckState

Type: string (enum)
Required: No

The workflow state of the health check when the repair task is in the Preparing state.

Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code.

Possible values are:

  • NotStarted - Indicates that the health check has not started.
  • InProgress - Indicates that the health check is in progress.
  • Succeeded - Indicates that the health check succeeded.
  • Skipped - Indicates that the health check was skipped.
  • TimedOut - Indicates that the health check timed out.

RestoringHealthCheckState

Type: string (enum)
Required: No

The workflow state of the health check when the repair task is in the Restoring state.

Specifies the workflow state of a repair task's health check. This type supports the Service Fabric platform; it is not meant to be used directly from your code.

Possible values are:

  • NotStarted - Indicates that the health check has not started.
  • InProgress - Indicates that the health check is in progress.
  • Succeeded - Indicates that the health check succeeded.
  • Skipped - Indicates that the health check was skipped.
  • TimedOut - Indicates that the health check timed out.

PerformPreparingHealthCheck

Type: boolean
Required: No

A value to determine if health checks will be performed when the repair task enters the Preparing state.

PerformRestoringHealthCheck

Type: boolean
Required: No

A value to determine if health checks will be performed when the repair task enters the Restoring state.