Class: Azure::ServiceFabric::V6_5_0_36::Models::ApplicationUpgradeDescription

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

Overview

Describes the parameters for an application upgrade. Note that upgrade description replaces the existing application description. This means that if the parameters are not specified, the existing parameters on the applications will be overwritten with the empty parameters list. This would result in the application using the default value of the parameters from the application manifest. If you do not want to change any existing parameter values, please get the application parameters first using the GetApplicationInfo query and then supply those values as Parameters in this ApplicationUpgradeDescription.

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:



72
73
74
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/application_upgrade_description.rb', line 72

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



58
59
60
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/application_upgrade_description.rb', line 58

def force_restart
  @force_restart
end

#monitoring_policy ⇒ MonitoringPolicyDescription

monitoring an upgrade in Monitored mode.

Returns:



68
69
70
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/application_upgrade_description.rb', line 68

def monitoring_policy
  @monitoring_policy
end

#name ⇒ String

‘fabric:’ URI scheme.

Returns:

  • (String) —

    The name of the target application, including the



25
26
27
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/application_upgrade_description.rb', line 25

def name
  @name
end

#parameters ⇒ Array<ApplicationParameter>

with overridden values from their default values specified in the application manifest.

Returns:



34
35
36
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/application_upgrade_description.rb', line 34

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



45
46
47
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/application_upgrade_description.rb', line 45

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:



64
65
66
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/application_upgrade_description.rb', line 64

def sort_order
  @sort_order
end

#target_application_type_version ⇒ String

application manifest) for the application upgrade.

Returns:

  • (String) —

    The target application type version (found in the



29
30
31
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/application_upgrade_description.rb', line 29

def target_application_type_version
  @target_application_type_version
end

#upgrade_kind ⇒ UpgradeKind

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

Returns:

  • (UpgradeKind) —

    The kind of upgrade out of the following possible



39
40
41
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/application_upgrade_description.rb', line 39

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



53
54
55
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/application_upgrade_description.rb', line 53

def upgrade_replica_set_check_timeout_in_seconds
  @upgrade_replica_set_check_timeout_in_seconds
end

Class Method Details

.mapper ⇒ Object

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



79
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
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/application_upgrade_description.rb', line 79

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ApplicationUpgradeDescription',
    type: {
      name: 'Composite',
      class_name: 'ApplicationUpgradeDescription',
      model_properties: {
        name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'Name',
          type: {
            name: 'String'
          }
        },
        target_application_type_version: {
          client_side_validation: true,
          required: true,
          serialized_name: 'TargetApplicationTypeVersion',
          type: {
            name: 'String'
          }
        },
        parameters: {
          client_side_validation: true,
          required: false,
          serialized_name: 'Parameters',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ApplicationParameterElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ApplicationParameter'
                }
            }
          }
        },
        upgrade_kind: {
          client_side_validation: true,
          required: true,
          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'
          }
        },
        application_health_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ApplicationHealthPolicy',
          type: {
            name: 'Composite',
            class_name: 'ApplicationHealthPolicy'
          }
        }
      }
    }
  }
end