Class: Azure::ServiceFabric::V6_2_0_9::Models::RepairTask

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb

Overview

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.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#action ⇒ String

the repair task is created, and is immutable once set.

Returns:

  • (String) —

    The requested repair action. Must be specified when



54
55
56
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 54

def action
  @action
end

#description ⇒ String

other informational details. May be set when the repair task is created, and is immutable once set.

Returns:

  • (String) —

    A description of the purpose of the repair task, or



37
38
39
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 37

def description
  @description
end

#executor ⇒ String

Claimed and later states, and is immutable once set.

Returns:

  • (String) —

    The name of the repair executor. Must be specified in



64
65
66
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 64

def executor
  @executor
end

#executor_data ⇒ String

store its internal state.

Returns:

  • (String) —

    A data string that the repair executor can use to



68
69
70
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 68

def executor_data
  @executor_data
end

#flags ⇒ Integer

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

Returns:

  • (Integer) —

    A bitwise-OR of the following values, which gives



50
51
52
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 50

def flags
  @flags
end

#history ⇒ RepairTaskHistory

repair task’s state transitions. These timestamps are updated by the system, and cannot be directly modified.

Returns:



99
100
101
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 99

def history
  @history
end

#impact ⇒ RepairImpactDescriptionBase

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.

Returns:



75
76
77
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 75

def impact
  @impact
end

#perform_preparing_health_check ⇒ Boolean

performed when the repair task enters the Preparing state.

Returns:

  • (Boolean) —

    A value to determine if health checks will be



113
114
115
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 113

def perform_preparing_health_check
  @perform_preparing_health_check
end

#perform_restoring_health_check ⇒ Boolean

performed when the repair task enters the Restoring state.

Returns:

  • (Boolean) —

    A value to determine if health checks will be



117
118
119
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 117

def perform_restoring_health_check
  @perform_restoring_health_check
end

#preparing_health_check_state ⇒ RepairTaskHealthCheckState

check when the repair task is in the Preparing state. Possible values include: ‘NotStarted’, ‘InProgress’, ‘Succeeded’, ‘Skipped’, ‘TimedOut’

Returns:



104
105
106
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 104

def preparing_health_check_state
  @preparing_health_check_state
end

#restoring_health_check_state ⇒ RepairTaskHealthCheckState

check when the repair task is in the Restoring state. Possible values include: ‘NotStarted’, ‘InProgress’, ‘Succeeded’, ‘Skipped’, ‘TimedOut’

Returns:



109
110
111
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 109

def restoring_health_check_state
  @restoring_health_check_state
end

#result_code ⇒ Integer

the result of the repair task execution. May be specified in the Restoring and later states, and is immutable once set.

Returns:

  • (Integer) —

    A numeric value providing additional details about



87
88
89
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 87

def result_code
  @result_code
end

#result_details ⇒ String

of the repair task execution. May be specified in the Restoring and later states, and is immutable once set.

Returns:

  • (String) —

    A string providing additional details about the result



93
94
95
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 93

def result_details
  @result_details
end

#result_status ⇒ ResultStatus

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’

Returns:

  • (ResultStatus) —

    A value describing the overall result of the



81
82
83
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 81

def result_status
  @result_status
end

#state ⇒ State

states are Created, Claimed, and Preparing. Possible values include: ‘Invalid’, ‘Created’, ‘Claimed’, ‘Preparing’, ‘Approved’, ‘Executing’, ‘Restoring’, ‘Completed’

Returns:

  • (State) —

    The workflow state of the repair task. Valid initial



43
44
45
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 43

def state
  @state
end

#target ⇒ RepairTargetDescriptionBase

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.

Returns:



60
61
62
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 60

def target
  @target
end

#task_id ⇒ String

Returns The ID of the repair task.

Returns:

  • (String) —

    The ID of the repair task.



21
22
23
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 21

def task_id
  @task_id
end

#version ⇒ String

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.

Returns:

  • (String) —

    The version of the repair task.



32
33
34
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 32

def version
  @version
end

Class Method Details

.mapper ⇒ Object

Mapper for RepairTask class as Ruby Hash. This will be used for serialization/deserialization.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/6.2.0.9/generated/azure_service_fabric/models/repair_task.rb', line 124

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'RepairTask',
    type: {
      name: 'Composite',
      class_name: 'RepairTask',
      model_properties: {
        task_id: {
          client_side_validation: true,
          required: true,
          serialized_name: 'TaskId',
          type: {
            name: 'String'
          }
        },
        version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'Version',
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'Description',
          type: {
            name: 'String'
          }
        },
        state: {
          client_side_validation: true,
          required: true,
          serialized_name: 'State',
          type: {
            name: 'String'
          }
        },
        flags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'Flags',
          type: {
            name: 'Number'
          }
        },
        action: {
          client_side_validation: true,
          required: true,
          serialized_name: 'Action',
          type: {
            name: 'String'
          }
        },
        target: {
          client_side_validation: true,
          required: false,
          serialized_name: 'Target',
          type: {
            name: 'Composite',
            polymorphic_discriminator: 'Kind',
            uber_parent: 'RepairTargetDescriptionBase',
            class_name: 'RepairTargetDescriptionBase'
          }
        },
        executor: {
          client_side_validation: true,
          required: false,
          serialized_name: 'Executor',
          type: {
            name: 'String'
          }
        },
        executor_data: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ExecutorData',
          type: {
            name: 'String'
          }
        },
        impact: {
          client_side_validation: true,
          required: false,
          serialized_name: 'Impact',
          type: {
            name: 'Composite',
            polymorphic_discriminator: 'Kind',
            uber_parent: 'RepairImpactDescriptionBase',
            class_name: 'RepairImpactDescriptionBase'
          }
        },
        result_status: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ResultStatus',
          type: {
            name: 'String'
          }
        },
        result_code: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ResultCode',
          type: {
            name: 'Number'
          }
        },
        result_details: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ResultDetails',
          type: {
            name: 'String'
          }
        },
        history: {
          client_side_validation: true,
          required: false,
          serialized_name: 'History',
          type: {
            name: 'Composite',
            class_name: 'RepairTaskHistory'
          }
        },
        preparing_health_check_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'PreparingHealthCheckState',
          type: {
            name: 'String'
          }
        },
        restoring_health_check_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'RestoringHealthCheckState',
          type: {
            name: 'String'
          }
        },
        perform_preparing_health_check: {
          client_side_validation: true,
          required: false,
          serialized_name: 'PerformPreparingHealthCheck',
          type: {
            name: 'Boolean'
          }
        },
        perform_restoring_health_check: {
          client_side_validation: true,
          required: false,
          serialized_name: 'PerformRestoringHealthCheck',
          type: {
            name: 'Boolean'
          }
        }
      }
    }
  }
end