Class: Azure::ServiceFabric::V6_3_0_9::Models::ServiceDescription

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

Overview

A ServiceDescription contains all of the information necessary to create a service.

Constant Summary collapse

@@discriminatorMap = 
Hash.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ServiceDescription

Returns a new instance of ServiceDescription.



20
21
22
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/service_description.rb', line 20

def initialize
  @ServiceKind = "ServiceDescription"
end

Instance Attribute Details

#application_name ⇒ String

URI scheme.

Returns:

  • (String) —

    The name of the application, including the ‘fabric:’



28
29
30
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/service_description.rb', line 28

def application_name
  @application_name
end

#correlation_scheme ⇒ Array<ServiceCorrelationDescription>

Returns The correlation scheme.

Returns:



55
56
57
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/service_description.rb', line 55

def correlation_scheme
  @correlation_scheme
end

#default_move_cost ⇒ MoveCost

include: ‘Zero’, ‘Low’, ‘Medium’, ‘High’

Returns:

  • (MoveCost) —

    The move cost for the service. Possible values



66
67
68
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/service_description.rb', line 66

def default_move_cost
  @default_move_cost
end

#initialization_data ⇒ Array<Integer>

Initialization data is passed to service instances or replicas when they are created.

Returns:

  • (Array<Integer>) —

    The initialization data as an array of bytes.



41
42
43
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/service_description.rb', line 41

def initialization_data
  @initialization_data
end

#is_default_move_cost_specified ⇒ Boolean

specified.

Returns:

  • (Boolean) —

    Indicates if the DefaultMoveCost property is



70
71
72
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/service_description.rb', line 70

def is_default_move_cost_specified
  @is_default_move_cost_specified
end

#partition_description ⇒ PartitionSchemeDescription

object.

Returns:



45
46
47
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/service_description.rb', line 45

def partition_description
  @partition_description
end

#placement_constraints ⇒ String

constraints are boolean expressions on node properties and allow for restricting a service to particular nodes based on the service requirements. For example, to place a service on nodes where NodeType is blue specify the following: “NodeColor == blue)”.

Returns:

  • (String) —

    The placement constraints as a string. Placement



52
53
54
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/service_description.rb', line 52

def placement_constraints
  @placement_constraints
end

#scaling_policies ⇒ Array<ScalingPolicyDescription>

service.

Returns:



83
84
85
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/service_description.rb', line 83

def scaling_policies
  @scaling_policies
end

#service_dns_name ⇒ String

system service to be enabled in Service Fabric cluster.

Returns:

  • (String) —

    The DNS name of the service. It requires the DNS



79
80
81
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/service_description.rb', line 79

def service_dns_name
  @service_dns_name
end

#service_load_metrics ⇒ Array<ServiceLoadMetricDescription>

Returns The service load metrics.

Returns:



58
59
60
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/service_description.rb', line 58

def service_load_metrics
  @service_load_metrics
end

#service_name ⇒ String

scheme.

Returns:

  • (String) —

    The full name of the service with ‘fabric:’ URI



32
33
34
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/service_description.rb', line 32

def service_name
  @service_name
end

#service_package_activation_mode ⇒ ServicePackageActivationMode

package to be used for a service. Possible values include: ‘SharedProcess’, ‘ExclusiveProcess’

Returns:



75
76
77
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/service_description.rb', line 75

def service_package_activation_mode
  @service_package_activation_mode
end

#service_placement_policies ⇒ Array<ServicePlacementPolicyDescription>

placement policies.

Returns:



62
63
64
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/service_description.rb', line 62

def service_placement_policies
  @service_placement_policies
end

#service_type_name ⇒ String

manifest.

Returns:

  • (String) —

    Name of the service type as specified in the service



36
37
38
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/service_description.rb', line 36

def service_type_name
  @service_type_name
end

#ServiceKind ⇒ Object

Returns the value of attribute ServiceKind.



24
25
26
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/service_description.rb', line 24

def ServiceKind
  @ServiceKind
end

Class Method Details

.mapper ⇒ Object

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



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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
 
# File 'lib/6.3.0.9/generated/azure_service_fabric/models/service_description.rb', line 90

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'ServiceDescription',
    type: {
      name: 'Composite',
      polymorphic_discriminator: 'ServiceKind',
      uber_parent: 'ServiceDescription',
      class_name: 'ServiceDescription',
      model_properties: {
        application_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ApplicationName',
          type: {
            name: 'String'
          }
        },
        service_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'ServiceName',
          type: {
            name: 'String'
          }
        },
        service_type_name: {
          client_side_validation: true,
          required: true,
          serialized_name: 'ServiceTypeName',
          type: {
            name: 'String'
          }
        },
        initialization_data: {
          client_side_validation: true,
          required: false,
          serialized_name: 'InitializationData',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'NumberElementType',
                type: {
                  name: 'Number'
                }
            }
          }
        },
        partition_description: {
          client_side_validation: true,
          required: true,
          serialized_name: 'PartitionDescription',
          type: {
            name: 'Composite',
            polymorphic_discriminator: 'PartitionScheme',
            uber_parent: 'PartitionSchemeDescription',
            class_name: 'PartitionSchemeDescription'
          }
        },
        placement_constraints: {
          client_side_validation: true,
          required: false,
          serialized_name: 'PlacementConstraints',
          type: {
            name: 'String'
          }
        },
        correlation_scheme: {
          client_side_validation: true,
          required: false,
          serialized_name: 'CorrelationScheme',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ServiceCorrelationDescriptionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ServiceCorrelationDescription'
                }
            }
          }
        },
        service_load_metrics: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ServiceLoadMetrics',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ServiceLoadMetricDescriptionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ServiceLoadMetricDescription'
                }
            }
          }
        },
        service_placement_policies: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ServicePlacementPolicies',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ServicePlacementPolicyDescriptionElementType',
                type: {
                  name: 'Composite',
                  polymorphic_discriminator: 'Type',
                  uber_parent: 'ServicePlacementPolicyDescription',
                  class_name: 'ServicePlacementPolicyDescription'
                }
            }
          }
        },
        default_move_cost: {
          client_side_validation: true,
          required: false,
          serialized_name: 'DefaultMoveCost',
          type: {
            name: 'String'
          }
        },
        is_default_move_cost_specified: {
          client_side_validation: true,
          required: false,
          serialized_name: 'IsDefaultMoveCostSpecified',
          type: {
            name: 'Boolean'
          }
        },
        service_package_activation_mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ServicePackageActivationMode',
          type: {
            name: 'String'
          }
        },
        service_dns_name: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ServiceDnsName',
          type: {
            name: 'String'
          }
        },
        scaling_policies: {
          client_side_validation: true,
          required: false,
          serialized_name: 'ScalingPolicies',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'ScalingPolicyDescriptionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'ScalingPolicyDescription'
                }
            }
          }
        }
      }
    }
  }
end