Class: Azure::StreamAnalytics::Mgmt::V2016_03_01::Models::StreamingJob

Inherits:
Resource
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb

Overview

A streamng job object, containing all information associated with the named streaming job.

Instance Attribute Summary collapse

Attributes inherited from Resource

#id, #location, #name, #tags, #type

Class Method Summary collapse

Methods inherited from Resource

#resource_group

Instance Attribute Details

#compatibility_level ⇒ CompatibilityLevel

streaming job. Possible values include: ‘1.0’

Returns:



83
84
85
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 83

def compatibility_level
  @compatibility_level
end

#created_date ⇒ DateTime

indicating when the streaming job was created.

Returns:

  • (DateTime) —

    Value is an ISO-8601 formatted UTC timestamp



87
88
89
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 87

def created_date
  @created_date
end

#data_locale ⇒ String

should be the name of a supported .NET Culture from the set msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx. Defaults to ‘en-US’ if none specified.

Returns:

  • (String) —

    The data locale of the stream analytics job. Value



79
80
81
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 79

def data_locale
  @data_locale
end

#etag ⇒ String

an opaque string. You can use it to detect whether the resource has changed between requests. You can also use it in the If-Match or If-None-Match headers for write operations for optimistic concurrency.

Returns:

  • (String) —

    The current entity tag for the streaming job. This is



121
122
123
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 121

def etag
  @etag
end

#events_late_arrival_max_delay_in_seconds ⇒ Integer

arriving late could be included. Supported range is -1 to 1814399 (20.23:59:59 days) and -1 is used to specify wait indefinitely. If the property is absent, it is interpreted to have a value of -1.

Returns:

  • (Integer) —

    The maximum tolerable delay in seconds where events



73
74
75
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 73

def events_late_arrival_max_delay_in_seconds
  @events_late_arrival_max_delay_in_seconds
end

#events_out_of_order_max_delay_in_seconds ⇒ Integer

out-of-order events can be adjusted to be back in order.

Returns:

  • (Integer) —

    The maximum tolerable delay in seconds where



67
68
69
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 67

def events_out_of_order_max_delay_in_seconds
  @events_out_of_order_max_delay_in_seconds
end

#events_out_of_order_policy ⇒ EventsOutOfOrderPolicy

events that arrive out of order in the input event stream. Possible values include: ‘Adjust’, ‘Drop’

Returns:



57
58
59
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 57

def events_out_of_order_policy
  @events_out_of_order_policy
end

#functions ⇒ Array<Function>

streaming job. The name property for each function is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual transformation.

Returns:

  • (Array<Function>) —

    A list of one or more functions for the



115
116
117
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 115

def functions
  @functions
end

#inputs ⇒ Array<Input>

job. The name property for each input is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual input.

Returns:

  • (Array<Input>) —

    A list of one or more inputs to the streaming



94
95
96
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 94

def inputs
  @inputs
end

#job_id ⇒ String

GUID is generated upon creation of the streaming job.

Returns:

  • (String) —

    A GUID uniquely identifying the streaming job. This



22
23
24
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 22

def job_id
  @job_id
end

#job_state ⇒ String

Returns Describes the state of the streaming job.

Returns:

  • (String) —

    Describes the state of the streaming job.



29
30
31
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 29

def job_state
  @job_state
end

#last_output_event_time ⇒ DateTime

indicating the last output event time of the streaming job or null indicating that output has not yet been produced. In case of multiple outputs or multiple streams, this shows the latest value in that set.

Returns:

  • (DateTime) —

    Value is either an ISO-8601 formatted timestamp



52
53
54
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 52

def last_output_event_time
  @last_output_event_time
end

#output_error_policy ⇒ OutputErrorPolicy

that arrive at the output and cannot be written to the external storage due to being malformed (missing column values, column values of wrong type or size). Possible values include: ‘Stop’, ‘Drop’

Returns:



63
64
65
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 63

def output_error_policy
  @output_error_policy
end

#output_start_mode ⇒ OutputStartMode

is desired that the job be started immediately upon creation. Value may be JobStartTime, CustomTime, or LastOutputEventTime to indicate whether the starting point of the output event stream should start whenever the job is started, start at a custom user time stamp specified via the outputStartTime property, or start from the last event output time. Possible values include: ‘JobStartTime’, ‘CustomTime’, ‘LastOutputEventTime’

Returns:



39
40
41
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 39

def output_start_mode
  @output_start_mode
end

#output_start_time ⇒ DateTime

that indicates the starting point of the output event stream, or null to indicate that the output event stream will start whenever the streaming job is started. This property must have a value if outputStartMode is set to CustomTime.

Returns:

  • (DateTime) —

    Value is either an ISO-8601 formatted time stamp



46
47
48
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 46

def output_start_time
  @output_start_time
end

#outputs ⇒ Array<Output>

job. The name property for each output is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual output.

Returns:

  • (Array<Output>) —

    A list of one or more outputs for the streaming



108
109
110
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 108

def outputs
  @outputs
end

#provisioning_state ⇒ String

job.

Returns:

  • (String) —

    Describes the provisioning status of the streaming



26
27
28
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 26

def provisioning_state
  @provisioning_state
end

#sku ⇒ Sku

(CreateOrReplace) requests.

Returns:

  • (Sku) —

    Describes the SKU of the streaming job. Required on PUT



18
19
20
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 18

def sku
  @sku
end

#transformation ⇒ Transformation

streaming units to use for the streaming job. The name property of the transformation is required when specifying this property in a PUT request. This property cannot be modify via a PATCH operation. You must use the PATCH API available for the individual tranformation.

Returns:



101
102
103
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 101

def transformation
  @transformation
end

Class Method Details

.mapper ⇒ Object

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



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
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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/2016-03-01/generated/azure_mgmt_stream_analytics/models/streaming_job.rb', line 128

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'StreamingJob',
    type: {
      name: 'Composite',
      class_name: 'StreamingJob',
      model_properties: {
        id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'id',
          type: {
            name: 'String'
          }
        },
        name: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'name',
          type: {
            name: 'String'
          }
        },
        type: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'type',
          type: {
            name: 'String'
          }
        },
        location: {
          client_side_validation: true,
          required: false,
          serialized_name: 'location',
          type: {
            name: 'String'
          }
        },
        tags: {
          client_side_validation: true,
          required: false,
          serialized_name: 'tags',
          type: {
            name: 'Dictionary',
            value: {
                client_side_validation: true,
                required: false,
                serialized_name: 'StringElementType',
                type: {
                  name: 'String'
                }
            }
          }
        },
        sku: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.sku',
          type: {
            name: 'Composite',
            class_name: 'Sku'
          }
        },
        job_id: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.jobId',
          type: {
            name: 'String'
          }
        },
        provisioning_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.provisioningState',
          type: {
            name: 'String'
          }
        },
        job_state: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.jobState',
          type: {
            name: 'String'
          }
        },
        output_start_mode: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.outputStartMode',
          type: {
            name: 'String'
          }
        },
        output_start_time: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.outputStartTime',
          type: {
            name: 'DateTime'
          }
        },
        last_output_event_time: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.lastOutputEventTime',
          type: {
            name: 'DateTime'
          }
        },
        events_out_of_order_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.eventsOutOfOrderPolicy',
          type: {
            name: 'String'
          }
        },
        output_error_policy: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.outputErrorPolicy',
          type: {
            name: 'String'
          }
        },
        events_out_of_order_max_delay_in_seconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.eventsOutOfOrderMaxDelayInSeconds',
          type: {
            name: 'Number'
          }
        },
        events_late_arrival_max_delay_in_seconds: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.eventsLateArrivalMaxDelayInSeconds',
          type: {
            name: 'Number'
          }
        },
        data_locale: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.dataLocale',
          type: {
            name: 'String'
          }
        },
        compatibility_level: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.compatibilityLevel',
          type: {
            name: 'String'
          }
        },
        created_date: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.createdDate',
          type: {
            name: 'DateTime'
          }
        },
        inputs: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.inputs',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'InputElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Input'
                }
            }
          }
        },
        transformation: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.transformation',
          type: {
            name: 'Composite',
            class_name: 'Transformation'
          }
        },
        outputs: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.outputs',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'OutputElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Output'
                }
            }
          }
        },
        functions: {
          client_side_validation: true,
          required: false,
          serialized_name: 'properties.functions',
          type: {
            name: 'Sequence',
            element: {
                client_side_validation: true,
                required: false,
                serialized_name: 'FunctionElementType',
                type: {
                  name: 'Composite',
                  class_name: 'Function'
                }
            }
          }
        },
        etag: {
          client_side_validation: true,
          required: false,
          read_only: true,
          serialized_name: 'properties.etag',
          type: {
            name: 'String'
          }
        }
      }
    }
  }
end