StreamingJob Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A streaming job object, containing all information associated with the named streaming job.
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.StreamingJobTypeConverter))]
public class StreamingJob : Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IStreamingJob, Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Runtime.IHeaderSerializable, Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.StreamingJobTypeConverter))>]
type StreamingJob = class
interface IStreamingJob
interface IJsonSerializable
interface ITrackedResource
interface IResource
interface IValidates
interface IHeaderSerializable
Public Class StreamingJob
Implements IHeaderSerializable, IStreamingJob, IValidates
- Inheritance
-
StreamingJob
- Attributes
- Implements
Constructors
StreamingJob() |
Creates an new StreamingJob 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. |
ETag | |
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. |
Id |
Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
IdentityPrincipalId | |
IdentityTenantId | |
IdentityType | |
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 |
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. |
Location |
The geo-location where the resource lives |
Name |
The name of the resource |
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. |
Tag |
Resource tags. |
TransformationETag | |
TransformationId |
Resource Id |
TransformationName |
Resource name |
TransformationType |
Resource type |
Type |
The type of the resource. Ex- Microsoft.Compute/virtualMachines or Microsoft.Storage/storageAccounts. |
Methods
DeserializeFromDictionary(IDictionary) |
Deserializes a IDictionary into an instance of StreamingJob. |
DeserializeFromPSObject(PSObject) |
Deserializes a PSObject into an instance of StreamingJob. |
FromJson(JsonNode) |
Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.StreamAnalytics.Models.Api20170401Preview.IStreamingJob. |
FromJsonString(String) |
Creates a new instance of StreamingJob, deserializing the content from a json string. |
ToJson(JsonObject, SerializationMode) |
Serializes this instance of StreamingJob into a JsonNode. |
ToJsonString() |
Serializes this instance to a json string. |
Validate(IEventListener) |
Validates that this object meets the validation criteria. |
Explicit Interface Implementations
IHeaderSerializable.ReadHeaders(HttpResponseHeaders) |