StreamingJob Interface
public interface StreamingJob
An immutable client-side representation of StreamingJob.
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
abstract
Cluster |
cluster()
Gets the cluster property: The cluster which streaming jobs will run on. |
|
abstract
Compatibility |
compatibilityLevel()
Gets the compatibility |
|
abstract
Content |
contentStoragePolicy()
Gets the content |
|
abstract
Offset |
createdDate()
Gets the created |
| abstract String |
dataLocale()
Gets the data |
| abstract String |
etag()
Gets the etag property: The current entity tag for the streaming job. |
| abstract Integer |
eventsLateArrivalMaxDelayInSeconds()
Gets the events |
| abstract Integer |
eventsOutOfOrderMaxDelayInSeconds()
Gets the events |
|
abstract
Events |
eventsOutOfOrderPolicy()
Gets the events |
| abstract External |
externals()
Gets the externals property: The storage account where the custom code artifacts are located. |
| abstract List<Function> |
functions()
Gets the functions property: A list of one or more functions for the streaming job. |
| abstract String |
id()
Gets the id property: Fully qualified resource Id for the resource. |
| abstract Identity |
identity()
Gets the identity property: Describes the managed identity assigned to this job that can be used to authenticate with inputs and outputs. |
|
abstract
Streaming |
innerModel()
Gets the inner com. |
| abstract List<Input> |
inputs()
Gets the inputs property: A list of one or more inputs to the streaming job. |
| abstract String |
jobId()
Gets the job |
| abstract String |
jobState()
Gets the job |
|
abstract
Job |
jobStorageAccount()
Gets the job |
|
abstract
Job |
jobType()
Gets the job |
|
abstract
Offset |
lastOutputEventTime()
Gets the last |
| abstract String |
location()
Gets the location property: The geo-location where the resource lives. |
| abstract String |
name()
Gets the name property: The name of the resource. |
|
abstract
Output |
outputErrorPolicy()
Gets the output |
|
abstract
Output |
outputStartMode()
Gets the output |
|
abstract
Offset |
outputStartTime()
Gets the output |
| abstract List<Output> |
outputs()
Gets the outputs property: A list of one or more outputs for the streaming job. |
| abstract String |
provisioningState()
Gets the provisioning |
|
abstract
Streaming |
refresh()
Refreshes the resource to sync with Azure. |
|
abstract
Streaming |
refresh(Context context)
Refreshes the resource to sync with Azure. |
| abstract Region |
region()
Gets the region of the resource. |
| abstract String |
regionName()
Gets the name of the resource region. |
| abstract String |
resourceGroupName()
Gets the name of the resource group. |
| abstract void |
scale()
Scales a streaming job when the job is running. |
| abstract void |
scale(ScaleStreamingJobParameters scaleJobParameters, Context context)
Scales a streaming job when the job is running. |
| abstract Sku |
sku()
Gets the sku property: Describes the SKU of the streaming job. |
| abstract Sku |
skuPropertiesSku()
Gets the sku |
| abstract void |
start()
Starts a streaming job. |
| abstract void |
start(StartStreamingJobParameters startJobParameters, Context context)
Starts a streaming job. |
| abstract void |
stop()
Stops a running streaming job. |
| abstract void |
stop(Context context)
Stops a running streaming job. |
| abstract Map<String,String> |
tags()
Gets the tags property: Resource tags. |
| abstract Transformation |
transformation()
Gets the transformation property: Indicates the query and the number of streaming units to use for the streaming job. |
| abstract String |
type()
Gets the type property: The type of the resource. |
| abstract Update |
update()
Begins update for the Streaming |
Method Details
cluster
public abstract ClusterInfo cluster()
Gets the cluster property: The cluster which streaming jobs will run on.
Returns:
compatibilityLevel
public abstract CompatibilityLevel compatibilityLevel()
Gets the compatibilityLevel property: Controls certain runtime behaviors of the streaming job.
Returns:
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:
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:
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:
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:
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:
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:
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:
externals
public abstract External externals()
Gets the externals property: The storage account where the custom code artifacts are located.
Returns:
functions
public abstract List
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:
id
public abstract String id()
Gets the id property: Fully qualified resource Id for the resource.
Returns:
identity
public abstract Identity identity()
Gets the identity property: Describes the managed identity assigned to this job that can be used to authenticate with inputs and outputs.
Returns:
innerModel
public abstract StreamingJobInner innerModel()
Gets the inner com.azure.resourcemanager.streamanalytics.fluent.models.StreamingJobInner object.
Returns:
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:
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:
jobState
public abstract String jobState()
Gets the jobState property: Describes the state of the streaming job.
Returns:
jobStorageAccount
public abstract JobStorageAccount jobStorageAccount()
Gets the jobStorageAccount property: The properties that are associated with an Azure Storage account with MSI.
Returns:
jobType
public abstract JobType jobType()
Gets the jobType property: Describes the type of the job. Valid modes are `Cloud` and 'Edge'.
Returns:
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:
location
public abstract String location()
Gets the location property: The geo-location where the resource lives.
Returns:
name
public abstract String name()
Gets the name property: The name of the resource.
Returns:
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:
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:
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:
outputs
public abstract List
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:
provisioningState
public abstract String provisioningState()
Gets the provisioningState property: Describes the provisioning status of the streaming job.
Returns:
refresh
public abstract StreamingJob refresh()
Refreshes the resource to sync with Azure.
Returns:
refresh
public abstract StreamingJob refresh(Context context)
Refreshes the resource to sync with Azure.
Parameters:
Returns:
region
public abstract Region region()
Gets the region of the resource.
Returns:
regionName
public abstract String regionName()
Gets the name of the resource region.
Returns:
resourceGroupName
public abstract String resourceGroupName()
Gets the name of the resource group.
Returns:
scale
public abstract void scale()
Scales a streaming job when the job is running.
scale
public abstract void scale(ScaleStreamingJobParameters scaleJobParameters, Context context)
Scales a streaming job when the job is running.
Parameters:
sku
public abstract Sku sku()
Gets the sku property: Describes the SKU of the streaming job. Required on PUT (CreateOrReplace) requests.
Returns:
skuPropertiesSku
public abstract Sku skuPropertiesSku()
Gets the skuPropertiesSku property: Describes the SKU of the streaming job. Required on PUT (CreateOrReplace) requests.
Returns:
start
public abstract void start()
Starts a streaming job. Once a job is started it will start processing input events and produce output.
start
public abstract void start(StartStreamingJobParameters startJobParameters, Context context)
Starts a streaming job. Once a job is started it will start processing input events and produce output.
Parameters:
stop
public abstract void stop()
Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.
stop
public abstract void stop(Context context)
Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.
Parameters:
tags
public abstract Map
Gets the tags property: Resource tags.
Returns:
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:
type
public abstract String type()
Gets the type property: The type of the resource.
Returns:
update
public abstract StreamingJob.Update update()
Begins update for the StreamingJob resource.
Returns:
Applies to
Azure SDK for Java
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for