RepairTask Class

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.

All required parameters must be populated in order to send to Azure.

Inheritance

Model

RepairTask

Constructor

RepairTask(*, task_id: str, state, action: str, version: Optional[str] = None, description: Optional[str] = None, flags: Optional[int] = None, target=None, executor: Optional[str] = None, executor_data: Optional[str] = None, impact=None, result_status=None, result_code: Optional[int] = None, result_details: Optional[str] = None, history=None, preparing_health_check_state=None, restoring_health_check_state=None, perform_preparing_health_check: Optional[bool] = None, perform_restoring_health_check: Optional[bool] = None, **kwargs)

Parameters

task_id

str

Required

Required. The ID of the repair task.

version

str

Required

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

str

Required

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

str or State

Required

Required. The workflow state of the repair task. Valid initial states are Created, Claimed, and Preparing. Possible values include: 'Invalid', 'Created', 'Claimed', 'Preparing', 'Approved', 'Executing', 'Restoring', 'Completed'

flags

int

Required

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

str

Required

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

target

RepairTargetDescriptionBase

Required

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

str

Required

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

executor_data

str

Required

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

impact

RepairImpactDescriptionBase

Required

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.

result_status

str or ResultStatus

Required

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 include: 'Invalid', 'Succeeded', 'Cancelled', 'Interrupted', 'Failed', 'Pending'

result_code

int

Required

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.

result_details

str

Required

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

RepairTaskHistory

Required

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

preparing_health_check_state

str or RepairTaskHealthCheckState

Required

The workflow state of the health check when the repair task is in the Preparing state. Possible values include: 'NotStarted', 'InProgress', 'Succeeded', 'Skipped', 'TimedOut'

restoring_health_check_state

str or RepairTaskHealthCheckState

Required

The workflow state of the health check when the repair task is in the Restoring state. Possible values include: 'NotStarted', 'InProgress', 'Succeeded', 'Skipped', 'TimedOut'

perform_preparing_health_check

bool

Required

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

perform_restoring_health_check

bool

Required

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