class Azure::ServiceFabric::V7_0_0_42::Models::StartClusterUpgradeDescription

Describes the parameters for starting a cluster upgrade.

Attributes

application_health_policy_map[RW]

@return [ApplicationHealthPolicies] Defines the application health policy map used to evaluate the health of an application or one of its children entities.

cluster_health_policy[RW]

@return [ClusterHealthPolicy] Defines a health policy used to evaluate the health of the cluster or of a cluster node.

cluster_upgrade_health_policy[RW]

@return [ClusterUpgradeHealthPolicyObject] Defines a health policy used to evaluate the health of the cluster during a cluster upgrade.

code_version[RW]

@return [String] The cluster code version.

config_version[RW]

@return [String] The cluster configuration version.

enable_delta_health_evaluation[RW]

@return [Boolean] When true, enables delta health evaluation rather than absolute health evaluation after completion of each upgrade domain.

force_restart[RW]

@return [Boolean] If true, then processes are forcefully restarted during upgrade even when the code version has not changed (the upgrade only changes configuration or data).

instance_close_delay_duration_in_seconds[RW]

@return [Integer] Duration in seconds, to wait before a stateless 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.

monitoring_policy[RW]

@return [MonitoringPolicyDescription] Describes the parameters for monitoring an upgrade in Monitored mode.

rolling_upgrade_mode[RW]

@return [UpgradeMode] The mode used to monitor health during a rolling upgrade. The values are UnmonitoredAuto, UnmonitoredManual, and Monitored. Possible values include: 'Invalid', 'UnmonitoredAuto', 'UnmonitoredManual', 'Monitored'. Default value: 'UnmonitoredAuto' .

sort_order[RW]

@return [UpgradeSortOrder] Defines the order in which an upgrade proceeds through the cluster. Possible values include: 'Invalid', 'Default', 'Numeric', 'Lexicographical', 'ReverseNumeric', 'ReverseLexicographical'. Default value: 'Default' .

upgrade_kind[RW]

@return [UpgradeKind] The kind of upgrade out of the following possible values. Possible values include: 'Invalid', 'Rolling'. Default value: 'Rolling' .

upgrade_replica_set_check_timeout_in_seconds[RW]

@return [Integer] The maximum amount of time to block processing of an 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).

Private Class Methods

mapper() click to toggle source

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

# 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