Class: Azure::ServiceFabric::V6_5_0_36::Models::ComposeDeploymentUpgradeDescription

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

Overview

Describes the parameters for a compose deployment upgrade.

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:



56
57
58
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/compose_deployment_upgrade_description.rb', line 56

def application_health_policy
  @application_health_policy
end

#compose_file_content ⇒ String

deployment to create.

Returns:

  • (String) —

    The content of the compose file that describes the



20
21
22
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/compose_deployment_upgrade_description.rb', line 20

def compose_file_content
  @compose_file_content
end

#deployment_name ⇒ String

Returns The name of the deployment.

Returns:

  • (String) —

    The name of the deployment.



16
17
18
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/compose_deployment_upgrade_description.rb', line 16

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



48
49
50
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/compose_deployment_upgrade_description.rb', line 48

def force_restart
  @force_restart
end

#monitoring_policy ⇒ MonitoringPolicyDescription

monitoring an upgrade in Monitored mode.

Returns:



52
53
54
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/compose_deployment_upgrade_description.rb', line 52

def monitoring_policy
  @monitoring_policy
end

#registry_credential ⇒ RegistryCredential

container registry.

Returns:



24
25
26
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/compose_deployment_upgrade_description.rb', line 24

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



35
36
37
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/compose_deployment_upgrade_description.rb', line 35

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



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

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



43
44
45
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/compose_deployment_upgrade_description.rb', line 43

def upgrade_replica_set_check_timeout_in_seconds
  @upgrade_replica_set_check_timeout_in_seconds
end

Class Method Details

.mapper ⇒ Object

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



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
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
 
# File 'lib/6.5.0.36/generated/azure_service_fabric/models/compose_deployment_upgrade_description.rb', line 63

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ComposeDeploymentUpgradeDescription',
    type: {
      name: 'Composite',
      class_name: 'ComposeDeploymentUpgradeDescription',
      model_properties: {
        deployment_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'DeploymentName',
          type: {
            name: 'String'
          }
        },
        compose_file_content: {
          client_side_validation: true,
          required: true,
          serialized_name: 'ComposeFileContent',
          type: {
            name: 'String'
          }
        },
        registry_credential: {
          client_side_validation: true,
          required: false,
          serialized_name: 'RegistryCredential',
          type: {
            name: 'Composite',
            class_name: 'RegistryCredential'
          }
        },
        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'
          }
        },
        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