Share via


StreamingJobProperties Interface

public interface StreamingJobProperties

An immutable client-side representation of StreamingJobProperties.

Method Summary

Modifier and Type Method and Description
abstract ClusterInfo cluster()

Gets the cluster property: The cluster which streaming jobs will run on.

abstract CompatibilityLevel compatibilityLevel()

Gets the compatibilityLevel property: Controls certain runtime behaviors of the streaming job.

abstract ContentStoragePolicy contentStoragePolicy()

Gets the contentStoragePolicy property: Valid values are JobStorageAccount and SystemAccount.

abstract OffsetDateTime createdDate()

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

abstract String dataLocale()

Gets the dataLocale property: The data locale of the stream analytics job.

abstract String etag()

Gets the etag property: The current entity tag for the streaming job.

abstract Integer eventsLateArrivalMaxDelayInSeconds()

Gets the eventsLateArrivalMaxDelayInSeconds property: The maximum tolerable delay in seconds where events arriving late could be included.

abstract Integer eventsOutOfOrderMaxDelayInSeconds()

Gets the eventsOutOfOrderMaxDelayInSeconds property: The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order.

abstract EventsOutOfOrderPolicy eventsOutOfOrderPolicy()

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

abstract List<Function> functions()

Gets the functions property: A list of one or more functions for the streaming job.

abstract StreamingJobPropertiesInner innerModel()

Gets the inner com.azure.resourcemanager.streamanalytics.fluent.models.StreamingJobPropertiesInner object.

abstract List<Input> inputs()

Gets the inputs property: A list of one or more inputs to the streaming job.

abstract String jobId()

Gets the jobId property: A GUID uniquely identifying the streaming job.

abstract String jobState()

Gets the jobState property: Describes the state of the streaming job.

abstract JobStorageAccount jobStorageAccount()

Gets the jobStorageAccount property: The properties that are associated with an Azure Storage account with MSI.

abstract JobType jobType()

Gets the jobType property: Describes the type of the job.

abstract OffsetDateTime lastOutputEventTime()

Gets the lastOutputEventTime property: 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.

abstract OutputErrorPolicy outputErrorPolicy()

Gets the outputErrorPolicy property: 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).

abstract List<Output> outputs()

Gets the outputs property: A list of one or more outputs for the streaming job.

abstract OutputStartMode outputStartMode()

Gets the outputStartMode property: This property should only be utilized when it is desired that the job be started immediately upon creation.

abstract OffsetDateTime outputStartTime()

Gets the outputStartTime property: 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.

abstract String provisioningState()

Gets the provisioningState property: Describes the provisioning status of the streaming job.

abstract Sku sku()

Gets the sku property: Describes the SKU of the streaming job.

abstract Transformation transformation()

Gets the transformation property: Indicates the query and the number of streaming units to use for the streaming job.

Method Details

cluster

public abstract ClusterInfo cluster()

Gets the cluster property: The cluster which streaming jobs will run on.

Returns:

the cluster value.

compatibilityLevel

public abstract CompatibilityLevel compatibilityLevel()

Gets the compatibilityLevel property: Controls certain runtime behaviors of the streaming job.

Returns:

the compatibilityLevel value.

contentStoragePolicy

public abstract ContentStoragePolicy contentStoragePolicy()

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

Returns:

the contentStoragePolicy value.

createdDate

public abstract OffsetDateTime createdDate()

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

Returns:

the createdDate value.

dataLocale

public abstract String dataLocale()

Gets the dataLocale property: 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.

Returns:

the dataLocale value.

etag

public abstract String etag()

Gets the etag property: The current entity tag for the streaming job. This is 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:

the etag value.

eventsLateArrivalMaxDelayInSeconds

public abstract Integer eventsLateArrivalMaxDelayInSeconds()

Gets the eventsLateArrivalMaxDelayInSeconds property: 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.

Returns:

the eventsLateArrivalMaxDelayInSeconds value.

eventsOutOfOrderMaxDelayInSeconds

public abstract Integer eventsOutOfOrderMaxDelayInSeconds()

Gets the eventsOutOfOrderMaxDelayInSeconds property: The maximum tolerable delay in seconds where out-of-order events can be adjusted to be back in order.

Returns:

the eventsOutOfOrderMaxDelayInSeconds value.

eventsOutOfOrderPolicy

public abstract EventsOutOfOrderPolicy eventsOutOfOrderPolicy()

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

Returns:

the eventsOutOfOrderPolicy value.

functions

public abstract List<Function> functions()

Gets the functions property: 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.

Returns:

the functions value.

innerModel

public abstract StreamingJobPropertiesInner innerModel()

Gets the inner com.azure.resourcemanager.streamanalytics.fluent.models.StreamingJobPropertiesInner object.

Returns:

the inner object.

inputs

public abstract List inputs()

Gets the inputs property: 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.

Returns:

the inputs value.

jobId

public abstract String jobId()

Gets the jobId property: A GUID uniquely identifying the streaming job. This GUID is generated upon creation of the streaming job.

Returns:

the jobId value.

jobState

public abstract String jobState()

Gets the jobState property: Describes the state of the streaming job.

Returns:

the jobState value.

jobStorageAccount

public abstract JobStorageAccount jobStorageAccount()

Gets the jobStorageAccount property: The properties that are associated with an Azure Storage account with MSI.

Returns:

the jobStorageAccount value.

jobType

public abstract JobType jobType()

Gets the jobType property: Describes the type of the job. Valid modes are `Cloud` and 'Edge'.

Returns:

the jobType value.

lastOutputEventTime

public abstract OffsetDateTime lastOutputEventTime()

Gets the lastOutputEventTime property: 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.

Returns:

the lastOutputEventTime value.

outputErrorPolicy

public abstract OutputErrorPolicy outputErrorPolicy()

Gets the outputErrorPolicy property: 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).

Returns:

the outputErrorPolicy value.

outputs

public abstract List<Output> outputs()

Gets the outputs property: 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.

Returns:

the outputs value.

outputStartMode

public abstract OutputStartMode outputStartMode()

Gets the outputStartMode property: 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.

Returns:

the outputStartMode value.

outputStartTime

public abstract OffsetDateTime outputStartTime()

Gets the outputStartTime property: 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.

Returns:

the outputStartTime value.

provisioningState

public abstract String provisioningState()

Gets the provisioningState property: Describes the provisioning status of the streaming job.

Returns:

the provisioningState value.

sku

public abstract Sku sku()

Gets the sku property: Describes the SKU of the streaming job. Required on PUT (CreateOrReplace) requests.

Returns:

the sku value.

transformation

public abstract Transformation transformation()

Gets the transformation property: Indicates the query and the number of 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 transformation.

Returns:

the transformation value.

Applies to