Class: Azure::ServiceFabric::V6_4_0_36::Models::ClusterUpgradeDescriptionObject

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

Overview

Represents a ServiceFabric cluster upgrade

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#application_health_policy_map ⇒ Array<ApplicationHealthPolicyMapItem>

contains specific application health policies for different applications. Each entry specifies as key the application name and as value an ApplicationHealthPolicy used to evaluate the application health. If an application is not specified in the map, the application health evaluation uses the ApplicationHealthPolicy found in its application manifest or the default application health policy (if no health policy is defined in the manifest). The map is empty by default.

Returns:



73
74
75
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/cluster_upgrade_description_object.rb', line 73

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/6.4.0.36/generated/azure_service_fabric/models/cluster_upgrade_description_object.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:



61
62
63
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/cluster_upgrade_description_object.rb', line 61

def cluster_upgrade_health_policy
  @cluster_upgrade_health_policy
end

#code_version ⇒ String

Returns The ServiceFabric code version of the cluster.

Returns:

  • (String) —

    The ServiceFabric code version of the cluster.



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

def code_version
  @code_version
end

#config_version ⇒ String

cluster manifest).

Returns:

  • (String) —

    The cluster configuration version (specified in the



17
18
19
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/cluster_upgrade_description_object.rb', line 17

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



49
50
51
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/cluster_upgrade_description_object.rb', line 49

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



44
45
46
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/cluster_upgrade_description_object.rb', line 44

def force_restart
  @force_restart
end

#monitoring_policy ⇒ MonitoringPolicyDescription

monitoring an upgrade in Monitored mode.

Returns:



53
54
55
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/cluster_upgrade_description_object.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



31
32
33
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/cluster_upgrade_description_object.rb', line 31

def rolling_upgrade_mode
  @rolling_upgrade_mode
end

#upgrade_kind ⇒ UpgradeKind

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

Returns:

  • (UpgradeKind) —

    The kind of upgrade out of the following possible



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

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



39
40
41
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/cluster_upgrade_description_object.rb', line 39

def upgrade_replica_set_check_timeout_in_seconds
  @upgrade_replica_set_check_timeout_in_seconds
end

Class Method Details

.mapper ⇒ Object

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



80
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
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
 
# File 'lib/6.4.0.36/generated/azure_service_fabric/models/cluster_upgrade_description_object.rb', line 80

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ClusterUpgradeDescriptionObject',
    type: {
      name: 'Composite',
      class_name: 'ClusterUpgradeDescriptionObject',
      model_properties: {
        config_version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ConfigVersion',
          type: {
            name: 'String'
          }
        },
        code_version: {
          client_side_validation: true,
          required: false,
          serialized_name: 'CodeVersion',
          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'
          }
        },
        enable_delta_health_evaluation: {
          client_side_validation: true,
          required: false,
          serialized_name: 'EnableDeltaHealthEvaluation',
          type: {
            name: 'Boolean'
          }
        },
        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'
          }
        },
        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: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ApplicationHealthPolicyMapItemElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ApplicationHealthPolicyMapItem'
                }
            }
          }
        }
      }
    }
  }
end