Class: Azure::ServiceFabric::V7_0_0_42::Models::StartClusterUpgradeDescription

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

Overview

Describes the parameters for starting a cluster upgrade.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#application_health_policy_map ⇒ ApplicationHealthPolicies

policy map used to evaluate the health of an application or one of its children entities.

Returns:



71
72
73
 
# File 'lib/7.0.0.42/generated/azure_service_fabric/models/start_cluster_upgrade_description.rb', line 71

def application_health_policy_map
  @application_health_policy_map
end

#cluster_health_policy ⇒ ClusterHealthPolicy

the health of the cluster or of a cluster node.

Returns:



57
58
59
 
# File 'lib/7.0.0.42/generated/azure_service_fabric/models/start_cluster_upgrade_description.rb', line 57

def cluster_health_policy
  @cluster_health_policy
end

#cluster_upgrade_health_policy ⇒ ClusterUpgradeHealthPolicyObject

to evaluate the health of the cluster during a cluster upgrade.

Returns:



66
67
68
 
# File 'lib/7.0.0.42/generated/azure_service_fabric/models/start_cluster_upgrade_description.rb', line 66

def cluster_upgrade_health_policy
  @cluster_upgrade_health_policy
end

#code_version ⇒ String

Returns The cluster code version.

Returns:

  • (String) —

    The cluster code version.



16
17
18
 
# File 'lib/7.0.0.42/generated/azure_service_fabric/models/start_cluster_upgrade_description.rb', line 16

def code_version
  @code_version
end

#config_version ⇒ String

Returns The cluster configuration version.

Returns:

  • (String) —

    The cluster configuration version.



19
20
21
 
# File 'lib/7.0.0.42/generated/azure_service_fabric/models/start_cluster_upgrade_description.rb', line 19

def config_version
  @config_version
end

#enable_delta_health_evaluation ⇒ Boolean

than absolute health evaluation after completion of each upgrade domain.

Returns:

  • (Boolean) —

    When true, enables delta health evaluation rather



62
63
64
 
# File 'lib/7.0.0.42/generated/azure_service_fabric/models/start_cluster_upgrade_description.rb', line 62

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



43
44
45
 
# File 'lib/7.0.0.42/generated/azure_service_fabric/models/start_cluster_upgrade_description.rb', line 43

def force_restart
  @force_restart
end

#instance_close_delay_duration_in_seconds ⇒ Integer

instance is closed, to allow the active requests to drain gracefully. This would be effective when the instance is closing during the application/cluster upgrade, only for those instances which have a non-zero delay duration configured in the service description. See InstanceCloseDelayDurationSeconds property in $ref: “#/definitions/StatelessServiceDescription.yaml” for details. Note, the default value of InstanceCloseDelayDurationInSeconds is 4294967295, which indicates that the behavior will entirely depend on the delay configured in the stateless service description.

Returns:

  • (Integer) —

    Duration in seconds, to wait before a stateless



84
85
86
 
# File 'lib/7.0.0.42/generated/azure_service_fabric/models/start_cluster_upgrade_description.rb', line 84

def instance_close_delay_duration_in_seconds
  @instance_close_delay_duration_in_seconds
end

#monitoring_policy ⇒ MonitoringPolicyDescription

monitoring an upgrade in Monitored mode.

Returns:



53
54
55
 
# File 'lib/7.0.0.42/generated/azure_service_fabric/models/start_cluster_upgrade_description.rb', line 53

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



30
31
32
 
# File 'lib/7.0.0.42/generated/azure_service_fabric/models/start_cluster_upgrade_description.rb', line 30

def rolling_upgrade_mode
  @rolling_upgrade_mode
end

#sort_order ⇒ UpgradeSortOrder

proceeds through the cluster. Possible values include: ‘Invalid’, ‘Default’, ‘Numeric’, ‘Lexicographical’, ‘ReverseNumeric’, ‘ReverseLexicographical’. Default value: ‘Default’ .

Returns:



49
50
51
 
# File 'lib/7.0.0.42/generated/azure_service_fabric/models/start_cluster_upgrade_description.rb', line 49

def sort_order
  @sort_order
end

#upgrade_kind ⇒ UpgradeKind

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

Returns:

  • (UpgradeKind) —

    The kind of upgrade out of the following possible



24
25
26
 
# File 'lib/7.0.0.42/generated/azure_service_fabric/models/start_cluster_upgrade_description.rb', line 24

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



38
39
40
 
# File 'lib/7.0.0.42/generated/azure_service_fabric/models/start_cluster_upgrade_description.rb', line 38

def upgrade_replica_set_check_timeout_in_seconds
  @upgrade_replica_set_check_timeout_in_seconds
end

Class Method Details

.mapper ⇒ Object

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



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
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
 
# File 'lib/7.0.0.42/generated/azure_service_fabric/models/start_cluster_upgrade_description.rb', line 91

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'StartClusterUpgradeDescription',
    type: {
      name: 'Composite',
      class_name: 'StartClusterUpgradeDescription',
      model_properties: {
        code_version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'CodeVersion',
          type: {
            name: 'String'
          }
        },
        config_version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ConfigVersion',
          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'
          }
        },
        upgrade_replica_set_check_timeout_in_seconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'UpgradeReplicaSetCheckTimeoutInSeconds',
          type: {
            name: 'Number'
          }
        },
        force_restart: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ForceRestart',
          type: {
            name: 'Boolean'
          }
        },
        sort_order: {
          client_side_validation: true,
          required: false,
          serialized_name: 'SortOrder',
          default_value: 'Default',
          type: {
            name: 'String'
          }
        },
        monitoring_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'MonitoringPolicy',
          type: {
            name: 'Composite',
            class_name: 'MonitoringPolicyDescription'
          }
        },
        cluster_health_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ClusterHealthPolicy',
          type: {
            name: 'Composite',
            class_name: 'ClusterHealthPolicy'
          }
        },
        enable_delta_health_evaluation: {
          client_side_validation: true,
          required: false,
          serialized_name: 'EnableDeltaHealthEvaluation',
          type: {
            name: 'Boolean'
          }
        },
        cluster_upgrade_health_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ClusterUpgradeHealthPolicy',
          type: {
            name: 'Composite',
            class_name: 'ClusterUpgradeHealthPolicyObject'
          }
        },
        application_health_policy_map: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ApplicationHealthPolicyMap',
          type: {
            name: 'Composite',
            class_name: 'ApplicationHealthPolicies'
          }
        },
        instance_close_delay_duration_in_seconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'InstanceCloseDelayDurationInSeconds',
          type: {
            name: 'Number'
          }
        }
      }
    }
  }
end