Class: Azure::MachineLearning::Mgmt::V2017_01_01::Models::WebServiceProperties

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb

Overview

The set of properties specific to the Azure ML web service resource.

Direct Known Subclasses

WebServicePropertiesForGraph

Constant Summary collapse

@@discriminatorMap = 
Hash.new

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ WebServiceProperties

Returns a new instance of WebServiceProperties.



18
19
20
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 18

def initialize
  @packageType = "WebServiceProperties"
end

Instance Attribute Details

#assets ⇒ Hash{String => AssetItem}

describing web service assets. Properties are expressed as Key/Value pairs.

Returns:

  • Contains user defined properties



106
107
108
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 106

def assets
  @assets
end

#commitment_plan ⇒ CommitmentPlan

this web service. Set at creation time. Once set, this value cannot be changed. Note: The commitment plan is not returned from calls to GET operations.

Returns:

  • Contains the commitment plan associated with



87
88
89
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 87

def commitment_plan
  @commitment_plan
end

#created_on ⇒ DateTime

was created.

Returns:

  • Read Only: The date and time when the web service



32
33
34
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 32

def created_on
  @created_on
end

#description ⇒ String

Returns The description of the web service.

Returns:

  • The description of the web service.



28
29
30
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 28

def description
  @description
end

#diagnostics ⇒ DiagnosticsConfiguration

traces collection for the web service.

Returns:

  • Settings controlling the diagnostics



69
70
71
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 69

def diagnostics
  @diagnostics
end

#example_request ⇒ ExampleRequest

the service’s inputs.

Returns:

  • Defines sample input data for one or more of



101
102
103
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 101

def example_request
  @example_request
end

#expose_sample_data ⇒ Boolean

service’s swagger definition. The default value is true.

Returns:

  • When set to true, sample data is included in the web



61
62
63
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 61

def expose_sample_data
  @expose_sample_data
end

#input ⇒ ServiceInputOutputSpecification

schema describing one or more of the web service’s inputs. For more information, see the Swagger specification.

Returns:

  • Contains the Swagger 2.0



92
93
94
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 92

def input
  @input
end

#keys ⇒ WebServiceKeys

you do not specify provisioning keys, the Azure Machine Learning system generates them for you. Note: The keys are not returned from calls to GET operations.

Returns:

  • Contains the web service provisioning keys. If



48
49
50
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 48

def keys
  @keys
end

#machine_learning_workspace ⇒ MachineLearningWorkspace

workspace containing the experiment that is source for the web service.

Returns:

  • Specifies the Machine Learning



81
82
83
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 81

def machine_learning_workspace
  @machine_learning_workspace
end

#modified_on ⇒ DateTime

was last modified.

Returns:

  • Read Only: The date and time when the web service



36
37
38
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 36

def modified_on
  @modified_on
end

#output ⇒ ServiceInputOutputSpecification

schema describing one or more of the web service’s outputs. For more information, see the Swagger specification.

Returns:

  • Contains the Swagger 2.0



97
98
99
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 97

def output
  @output
end

#packageType ⇒ Object

Returns the value of attribute packageType.



22
23
24
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 22

def packageType
  @packageType
end

#parameters ⇒ Hash{String => WebServiceParameter}

parameters values defined for the web service, given as a global parameter name to default value map. If no default value is specified, the parameter is considered to be required.

Returns:

  • The set of global



112
113
114
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 112

def parameters
  @parameters
end

#payloads_in_blob_storage ⇒ Boolean

larger than 3 MB. Otherwise false. If the payload size exceed 3 MB, the payload is stored in a blob and the PayloadsLocation parameter contains the URI of the blob. Otherwise, this will be set to false and Assets, Input, Output, Package, Parameters, ExampleRequest are inline. The Payload sizes is determined by adding the size of the Assets, Input, Output, Package, Parameters, and the ExampleRequest.

Returns:

  • When set to true, indicates that the payload size is



121
122
123
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 121

def payloads_in_blob_storage
  @payloads_in_blob_storage
end

#payloads_location ⇒ BlobLocation

contains a value only if the payloadsInBlobStorage parameter is set to true. Otherwise is set to null.

Returns:

  • The URI of the payload blob. This paramater



126
127
128
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 126

def payloads_location
  @payloads_location
end

#provisioning_state ⇒ ProvisioningState

service. Valid values are Unknown, Provisioning, Succeeded, and Failed. Possible values include: ‘Unknown’, ‘Provisioning’, ‘Succeeded’, ‘Failed’

Returns:

  • Read Only: The provision state of the web



42
43
44
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 42

def provisioning_state
  @provisioning_state
end

#read_only ⇒ Boolean

read-only and can no longer be updated or patched, only removed. Default, is false. Note: Once set to true, you cannot change its value.

Returns:

  • When set to true, indicates that the web service is



53
54
55
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 53

def read_only
  @read_only
end

#realtime_configuration ⇒ RealtimeConfiguration

the web service endpoint.

Returns:

  • Contains the configuration settings for



65
66
67
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 65

def realtime_configuration
  @realtime_configuration
end

#storage_account ⇒ StorageAccount

Machine Learning uses to store information about the web service. Only the name of the storage account is returned from calls to GET operations. When updating the storage account information, you must ensure that all necessary assets are available in the new storage account or calls to your web service will fail.

Returns:

  • Specifies the storage account that Azure



77
78
79
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 77

def 
  @storage_account
end

#swagger_location ⇒ String

associated with this web service.

Returns:

  • Read Only: Contains the URI of the swagger spec



57
58
59
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 57

def swagger_location
  @swagger_location
end

#title ⇒ String

Returns The title of the web service.

Returns:

  • The title of the web service.



25
26
27
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 25

def title
  @title
end

Class Method Details

.mapper ⇒ Object

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



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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/2017-01-01/generated/azure_mgmt_machine_learning/models/web_service_properties.rb', line 133

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'WebServiceProperties',
    type: {
      name: 'Composite',
      polymorphic_discriminator: 'packageType',
      uber_parent: 'WebServiceProperties',
      class_name: 'WebServiceProperties',
      model_properties: {
        title: {
          client_side_validation: true,
          required: false,
          serialized_name: 'title',
          type: {
            name: 'String'
          }
        },
        description: {
          client_side_validation: true,
          required: false,
          serialized_name: 'description',
          type: {
            name: 'String'
          }
        },
        created_on: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'createdOn',
          type: {
            name: 'DateTime'
          }
        },
        modified_on: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'modifiedOn',
          type: {
            name: 'DateTime'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'provisioningState',
          type: {
            name: 'String'
          }
        },
        keys: {
          client_side_validation: true,
          required: false,
          serialized_name: 'keys',
          type: {
            name: 'Composite',
            class_name: 'WebServiceKeys'
          }
        },
        read_only: {
          client_side_validation: true,
          required: false,
          serialized_name: 'readOnly',
          type: {
            name: 'Boolean'
          }
        },
        swagger_location: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'swaggerLocation',
          type: {
            name: 'String'
          }
        },
        expose_sample_data: {
          client_side_validation: true,
          required: false,
          serialized_name: 'exposeSampleData',
          type: {
            name: 'Boolean'
          }
        },
        realtime_configuration: {
          client_side_validation: true,
          required: false,
          serialized_name: 'realtimeConfiguration',
          type: {
            name: 'Composite',
            class_name: 'RealtimeConfiguration'
          }
        },
        diagnostics: {
          client_side_validation: true,
          required: false,
          serialized_name: 'diagnostics',
          type: {
            name: 'Composite',
            class_name: 'DiagnosticsConfiguration'
          }
        },
        storage_account: {
          client_side_validation: true,
          required: false,
          serialized_name: 'storageAccount',
          type: {
            name: 'Composite',
            class_name: 'StorageAccount'
          }
        },
        machine_learning_workspace: {
          client_side_validation: true,
          required: false,
          serialized_name: 'machineLearningWorkspace',
          type: {
            name: 'Composite',
            class_name: 'MachineLearningWorkspace'
          }
        },
        commitment_plan: {
          client_side_validation: true,
          required: false,
          serialized_name: 'commitmentPlan',
          type: {
            name: 'Composite',
            class_name: 'CommitmentPlan'
          }
        },
        input: {
          client_side_validation: true,
          required: false,
          serialized_name: 'input',
          type: {
            name: 'Composite',
            class_name: 'ServiceInputOutputSpecification'
          }
        },
        output: {
          client_side_validation: true,
          required: false,
          serialized_name: 'output',
          type: {
            name: 'Composite',
            class_name: 'ServiceInputOutputSpecification'
          }
        },
        example_request: {
          client_side_validation: true,
          required: false,
          serialized_name: 'exampleRequest',
          type: {
            name: 'Composite',
            class_name: 'ExampleRequest'
          }
        },
        assets: {
          client_side_validation: true,
          required: false,
          serialized_name: 'assets',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'AssetItemElementType',
                type: {
                  name: 'Composite',
                  class_name: 'AssetItem'
                }
            }
          }
        },
        parameters: {
          client_side_validation: true,
          required: false,
          serialized_name: 'parameters',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'WebServiceParameterElementType',
                type: {
                  name: 'Composite',
                  class_name: 'WebServiceParameter'
                }
            }
          }
        },
        payloads_in_blob_storage: {
          client_side_validation: true,
          required: false,
          serialized_name: 'payloadsInBlobStorage',
          type: {
            name: 'Boolean'
          }
        },
        payloads_location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'payloadsLocation',
          type: {
            name: 'Composite',
            class_name: 'BlobLocation'
          }
        }
      }
    }
  }
end