Class: Azure::ServiceFabric::V6_4_0_36::Models::RollingUpgradeUpdateDescription

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

Overview

Describes the parameters for updating a rolling upgrade of application or cluster.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#failure_action ⇒ FailureAction

Monitored upgrade encounters monitoring policy or health policy violations. Invalid indicates the failure action is invalid. Rollback specifies that the upgrade will start rolling back automatically. Manual indicates that the upgrade will switch to UnmonitoredManual upgrade mode. Possible values include: ‘Invalid’, ‘Rollback’, ‘Manual’

Returns:



42
43
44
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/rolling_upgrade_update_description.rb', line 42

def failure_action
  @failure_action
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



25
26
27
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/rolling_upgrade_update_description.rb', line 25

def force_restart
  @force_restart
end

#health_check_retry_timeout_in_milliseconds ⇒ String

application or cluster is unhealthy before FailureAction is executed. 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 amount of time to retry health evaluation when the



62
63
64
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/rolling_upgrade_update_description.rb', line 62

def health_check_retry_timeout_in_milliseconds
  @health_check_retry_timeout_in_milliseconds
end

#health_check_stable_duration_in_milliseconds ⇒ String

must remain healthy before the upgrade proceeds to the next 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 amount of time that the application or cluster



55
56
57
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/rolling_upgrade_update_description.rb', line 55

def health_check_stable_duration_in_milliseconds
  @health_check_stable_duration_in_milliseconds
end

#health_check_wait_duration_in_milliseconds ⇒ String

domain before applying health policies. 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 amount of time to wait after completing an upgrade



48
49
50
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/rolling_upgrade_update_description.rb', line 48

def health_check_wait_duration_in_milliseconds
  @health_check_wait_duration_in_milliseconds
end

#replica_set_check_timeout_in_milliseconds ⇒ 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



33
34
35
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/rolling_upgrade_update_description.rb', line 33

def replica_set_check_timeout_in_milliseconds
  @replica_set_check_timeout_in_milliseconds
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



20
21
22
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/rolling_upgrade_update_description.rb', line 20

def rolling_upgrade_mode
  @rolling_upgrade_mode
end

#upgrade_domain_timeout_in_milliseconds ⇒ String

before FailureAction is executed. 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 amount of time each upgrade domain has to complete



74
75
76
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/rolling_upgrade_update_description.rb', line 74

def upgrade_domain_timeout_in_milliseconds
  @upgrade_domain_timeout_in_milliseconds
end

#upgrade_timeout_in_milliseconds ⇒ String

before FailureAction is executed. 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 amount of time the overall upgrade has to complete



68
69
70
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/rolling_upgrade_update_description.rb', line 68

def upgrade_timeout_in_milliseconds
  @upgrade_timeout_in_milliseconds
end

Class Method Details

.mapper ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
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
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/rolling_upgrade_update_description.rb', line 81

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'RollingUpgradeUpdateDescription',
    type: {
      name: 'Composite',
      class_name: 'RollingUpgradeUpdateDescription',
      model_properties: {
        rolling_upgrade_mode: {
          client_side_validation: true,
          required: true,
          serialized_name: 'RollingUpgradeMode',
          default_value: 'UnmonitoredAuto',
          type: {
            name: 'String'
          }
        },
        force_restart: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ForceRestart',
          type: {
            name: 'Boolean'
          }
        },
        replica_set_check_timeout_in_milliseconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ReplicaSetCheckTimeoutInMilliseconds',
          type: {
            name: 'Number'
          }
        },
        failure_action: {
          client_side_validation: true,
          required: false,
          serialized_name: 'FailureAction',
          type: {
            name: 'String'
          }
        },
        health_check_wait_duration_in_milliseconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'HealthCheckWaitDurationInMilliseconds',
          type: {
            name: 'String'
          }
        },
        health_check_stable_duration_in_milliseconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'HealthCheckStableDurationInMilliseconds',
          type: {
            name: 'String'
          }
        },
        health_check_retry_timeout_in_milliseconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'HealthCheckRetryTimeoutInMilliseconds',
          type: {
            name: 'String'
          }
        },
        upgrade_timeout_in_milliseconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'UpgradeTimeoutInMilliseconds',
          type: {
            name: 'String'
          }
        },
        upgrade_domain_timeout_in_milliseconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'UpgradeDomainTimeoutInMilliseconds',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end