Class: Azure::ServiceFabric::V6_3_0_9::Models::ComposeDeploymentUpgradeProgressInfo

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

Overview

Describes the parameters for a compose deployment upgrade.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#application_health_policy ⇒ ApplicationHealthPolicy

evaluate the health of an application or one of its children entities.

Returns:



64
65
66
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 64

def application_health_policy
  @application_health_policy
end

#application_name ⇒ String

‘fabric:’ URI scheme.

Returns:

  • (String) —

    The name of the target application, including the



20
21
22
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 20

def application_name
  @application_name
end

#application_unhealthy_evaluations ⇒ Array<HealthEvaluationWrapper>

that resulted in the current aggregated health state.

Returns:



84
85
86
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 84

def application_unhealthy_evaluations
  @application_unhealthy_evaluations
end

#application_upgrade_status_details ⇒ String

failure message.

Returns:

  • (String) —

    Additional details of application upgrade including



109
110
111
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 109

def application_upgrade_status_details
  @application_upgrade_status_details
end

#current_upgrade_domain_duration ⇒ String

Upgrade Domain. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

Returns:

  • (String) —

    The estimated amount of time spent processing current



80
81
82
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 80

def current_upgrade_domain_duration
  @current_upgrade_domain_duration
end

#current_upgrade_domain_progress ⇒ CurrentUpgradeDomainProgressInfo

current in-progress upgrade domain.

Returns:



88
89
90
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 88

def current_upgrade_domain_progress
  @current_upgrade_domain_progress
end

#deployment_name ⇒ String

Returns The name of the target deployment.

Returns:

  • (String) —

    The name of the target deployment.



16
17
18
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 16

def deployment_name
  @deployment_name
end

#failure_reason ⇒ FailureReason

in FailureAction being executed. Possible values include: ‘None’, ‘Interrupted’, ‘HealthCheck’, ‘UpgradeDomainTimeout’, ‘OverallUpgradeTimeout’

Returns:

  • (FailureReason) —

    The cause of an upgrade failure that resulted



101
102
103
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 101

def failure_reason
  @failure_reason
end

#failure_timestamp_utc ⇒ String

FailureAction was executed.

Returns:

  • (String) —

    The estimated UTC datetime when the upgrade failed and



95
96
97
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 95

def failure_timestamp_utc
  @failure_timestamp_utc
end

#force_restart ⇒ Boolean

during upgrade even when the code version has not changed (the upgrade only changes configuration or data).

Returns:

  • (Boolean) —

    If true, then processes are forcefully restarted



48
49
50
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 48

def force_restart
  @force_restart
end

#monitoring_policy ⇒ MonitoringPolicyDescription

monitoring an upgrade in Monitored mode.

Returns:



60
61
62
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 60

def monitoring_policy
  @monitoring_policy
end

#rolling_upgrade_mode ⇒ UpgradeMode

upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: ‘Invalid’, ‘UnmonitoredAuto’, ‘UnmonitoredManual’, ‘Monitored’. Default value: ‘UnmonitoredAuto’ .

Returns:

  • (UpgradeMode) —

    The mode used to monitor health during a rolling



43
44
45
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 43

def rolling_upgrade_mode
  @rolling_upgrade_mode
end

#start_timestamp_utc ⇒ String

Returns The estimated UTC datetime when the upgrade started.

Returns:

  • (String) —

    The estimated UTC datetime when the upgrade started.



91
92
93
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 91

def start_timestamp_utc
  @start_timestamp_utc
end

#target_application_type_version ⇒ String

application manifest) for the application upgrade.

Returns:

  • (String) —

    The target application type version (found in the



68
69
70
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 68

def target_application_type_version
  @target_application_type_version
end

#upgrade_domain_progress_at_failure ⇒ FailureUpgradeDomainProgressInfo

upgrade domain progress at the time of upgrade failure.

Returns:



105
106
107
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 105

def upgrade_domain_progress_at_failure
  @upgrade_domain_progress_at_failure
end

#upgrade_duration ⇒ String

elapsed. It is first interpreted as a string representing an ISO 8601 duration. If that fails, then it is interpreted as a number representing the total number of milliseconds.

Returns:

  • (String) —

    The estimated amount of time that the overall upgrade



74
75
76
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 74

def upgrade_duration
  @upgrade_duration
end

#upgrade_kind ⇒ UpgradeKind

values. Possible values include: ‘Invalid’, ‘Rolling’. Default value: ‘Rolling’ .

Returns:

  • (UpgradeKind) —

    The kind of upgrade out of the following possible



37
38
39
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 37

def upgrade_kind
  @upgrade_kind
end

#upgrade_replica_set_check_timeout_in_seconds ⇒ Integer

upgrade domain and prevent loss of availability when there are unexpected issues. When this timeout expires, processing of the upgrade domain will proceed regardless of availability loss issues. The timeout is reset at the start of each upgrade domain. Valid values are between 0 and 42949672925 inclusive. (unsigned 32-bit integer).

Returns:

  • (Integer) —

    The maximum amount of time to block processing of an



56
57
58
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 56

def upgrade_replica_set_check_timeout_in_seconds
  @upgrade_replica_set_check_timeout_in_seconds
end

#upgrade_state ⇒ ComposeDeploymentUpgradeState

deployment upgrade. Possible values include: ‘Invalid’, ‘ProvisioningTarget’, ‘RollingForwardInProgress’, ‘RollingForwardPending’, ‘UnprovisioningCurrent’, ‘RollingForwardCompleted’, ‘RollingBackInProgress’, ‘UnprovisioningTarget’, ‘RollingBackCompleted’, ‘Failed’

Returns:



28
29
30
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 28

def upgrade_state
  @upgrade_state
end

#upgrade_status_details ⇒ String

the pending upgrade.

Returns:

  • (String) —

    Additional detailed information about the status of



32
33
34
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 32

def upgrade_status_details
  @upgrade_status_details
end

Class Method Details

.mapper ⇒ Object

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



116
117
118
119
120
121
122
123
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
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/compose_deployment_upgrade_progress_info.rb', line 116

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ComposeDeploymentUpgradeProgressInfo',
    type: {
      name: 'Composite',
      class_name: 'ComposeDeploymentUpgradeProgressInfo',
      model_properties: {
        deployment_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'DeploymentName',
          type: {
            name: 'String'
          }
        },
        application_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ApplicationName',
          type: {
            name: 'String'
          }
        },
        upgrade_state: {
          client_side_validation: true,
          required: false,
          serialized_name: 'UpgradeState',
          type: {
            name: 'String'
          }
        },
        upgrade_status_details: {
          client_side_validation: true,
          required: false,
          serialized_name: 'UpgradeStatusDetails',
          type: {
            name: 'String'
          }
        },
        upgrade_kind: {
          client_side_validation: true,
          required: false,
          serialized_name: 'UpgradeKind',
          default_value: 'Rolling',
          type: {
            name: 'String'
          }
        },
        rolling_upgrade_mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'RollingUpgradeMode',
          default_value: 'UnmonitoredAuto',
          type: {
            name: 'String'
          }
        },
        force_restart: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ForceRestart',
          type: {
            name: 'Boolean'
          }
        },
        upgrade_replica_set_check_timeout_in_seconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'UpgradeReplicaSetCheckTimeoutInSeconds',
          type: {
            name: 'Number'
          }
        },
        monitoring_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'MonitoringPolicy',
          type: {
            name: 'Composite',
            class_name: 'MonitoringPolicyDescription'
          }
        },
        application_health_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ApplicationHealthPolicy',
          type: {
            name: 'Composite',
            class_name: 'ApplicationHealthPolicy'
          }
        },
        target_application_type_version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'TargetApplicationTypeVersion',
          type: {
            name: 'String'
          }
        },
        upgrade_duration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'UpgradeDuration',
          type: {
            name: 'String'
          }
        },
        current_upgrade_domain_duration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'CurrentUpgradeDomainDuration',
          type: {
            name: 'String'
          }
        },
        application_unhealthy_evaluations: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ApplicationUnhealthyEvaluations',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'HealthEvaluationWrapperElementType',
                type: {
                  name: 'Composite',
                  class_name: 'HealthEvaluationWrapper'
                }
            }
          }
        },
        current_upgrade_domain_progress: {
          client_side_validation: true,
          required: false,
          serialized_name: 'CurrentUpgradeDomainProgress',
          type: {
            name: 'Composite',
            class_name: 'CurrentUpgradeDomainProgressInfo'
          }
        },
        start_timestamp_utc: {
          client_side_validation: true,
          required: false,
          serialized_name: 'StartTimestampUtc',
          type: {
            name: 'String'
          }
        },
        failure_timestamp_utc: {
          client_side_validation: true,
          required: false,
          serialized_name: 'FailureTimestampUtc',
          type: {
            name: 'String'
          }
        },
        failure_reason: {
          client_side_validation: true,
          required: false,
          serialized_name: 'FailureReason',
          type: {
            name: 'String'
          }
        },
        upgrade_domain_progress_at_failure: {
          client_side_validation: true,
          required: false,
          serialized_name: 'UpgradeDomainProgressAtFailure',
          type: {
            name: 'Composite',
            class_name: 'FailureUpgradeDomainProgressInfo'
          }
        },
        application_upgrade_status_details: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ApplicationUpgradeStatusDetails',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end