Share via


StreamingJobProperties Class

Definition

The properties that are associated with a streaming job.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.StreamingJobPropertiesTypeConverter))]
public class StreamingJobProperties : Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IStreamingJobProperties, Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Runtime.IHeaderSerializable
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.StreamingJobPropertiesTypeConverter))>]
type StreamingJobProperties = class
    interface IStreamingJobProperties
    interface IJsonSerializable
    interface IHeaderSerializable
Public Class StreamingJobProperties
Implements IHeaderSerializable, IStreamingJobProperties
Inheritance
StreamingJobProperties
Attributes
Implements

Constructors

StreamingJobProperties()

Creates an new StreamingJobProperties instance.

Properties

ClusterId

The resource id of cluster.

CompatibilityLevel

Controls certain runtime behaviors of the streaming job.

ContentStoragePolicy

Valid values are JobStorageAccount and SystemAccount. If set to JobStorageAccount, this requires the user to also specify jobStorageAccount property. .

CreatedDate

Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created.

DataLocale

The data locale of the stream analytics job. Value should be the name of a supported .NET Culture from the set https://msdn.microsoft.com/en-us/library/system.globalization.culturetypes(v=vs.110).aspx. Defaults to 'en-US' if none specified.

EventsLateArrivalMaxDelayInSecond

The maximum tolerable delay in seconds where events 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.

EventsOutOfOrderMaxDelayInSecond

The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order.

EventsOutOfOrderPolicy

Indicates the policy to apply to events that arrive out of order in the input event stream.

ExternalContainer
ExternalPath
Function

A list of one or more functions for the 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.

Input

A list of one or more inputs to the streaming 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.

JobId

A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job.

JobState

Describes the state of the streaming job.

JobStorageAccountAuthenticationMode

Authentication Mode.

JobStorageAccountKey

The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests.

JobStorageAccountName

The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests.

JobType

Describes the type of the job. Valid modes are Cloud and 'Edge'.

LastOutputEventTime

Value is either an ISO-8601 formatted timestamp 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.

Output

A list of one or more outputs for the streaming 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.

OutputErrorPolicy

Indicates the policy to apply to events 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).

OutputStartMode

This property should only be utilized when it 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.

OutputStartTime

Value is either an ISO-8601 formatted time stamp 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.

ProvisioningState

Describes the provisioning status of the streaming job.

Query

Specifies the query that will be run in the streaming job. You can learn more about the Stream Analytics Query Language (SAQL) here: https://msdn.microsoft.com/library/azure/dn834998 . Required on PUT (CreateOrReplace) requests.

SkuName

The name of the SKU. Required on PUT (CreateOrReplace) requests.

StorageAccountKey

The account key for the Azure Storage account. Required on PUT (CreateOrReplace) requests.

StorageAccountName

The name of the Azure Storage account. Required on PUT (CreateOrReplace) requests.

StreamingUnit

Specifies the number of streaming units that the streaming job uses.

TransformationETag
TransformationId

Resource Id

TransformationName

Resource name

TransformationType

Resource type

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of StreamingJobProperties.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of StreamingJobProperties.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IStreamingJobProperties.

FromJsonString(String)

Creates a new instance of StreamingJobProperties, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of StreamingJobProperties into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

Explicit Interface Implementations

IHeaderSerializable.ReadHeaders(HttpResponseHeaders)

Applies to