Package com.azure.resourcemanager.streamanalytics.models

Interface StreamingJob

  • public interface StreamingJob
    An immutable client-side representation of StreamingJob.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ClusterInfo cluster()
      Gets the cluster property: The cluster which streaming jobs will run on.
      CompatibilityLevel compatibilityLevel()
      Gets the compatibilityLevel property: Controls certain runtime behaviors of the streaming job.
      ContentStoragePolicy contentStoragePolicy()
      Gets the contentStoragePolicy property: Valid values are JobStorageAccount and SystemAccount.
      OffsetDateTime createdDate()
      Gets the createdDate property: Value is an ISO-8601 formatted UTC timestamp indicating when the streaming job was created.
      String dataLocale()
      Gets the dataLocale property: The data locale of the stream analytics job.
      String etag()
      Gets the etag property: The current entity tag for the streaming job.
      Integer eventsLateArrivalMaxDelayInSeconds()
      Gets the eventsLateArrivalMaxDelayInSeconds property: The maximum tolerable delay in seconds where events arriving late could be included.
      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.
      EventsOutOfOrderPolicy eventsOutOfOrderPolicy()
      Gets the eventsOutOfOrderPolicy property: Indicates the policy to apply to events that arrive out of order in the input event stream.
      List<Function> functions()
      Gets the functions property: A list of one or more functions for the streaming job.
      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Identity identity()
      Gets the identity property: Describes the system-assigned managed identity assigned to this job that can be used to authenticate with inputs and outputs.
      StreamingJobInner innerModel()
      Gets the inner com.azure.resourcemanager.streamanalytics.fluent.models.StreamingJobInner object.
      List<Input> inputs()
      Gets the inputs property: A list of one or more inputs to the streaming job.
      String jobId()
      Gets the jobId property: A GUID uniquely identifying the streaming job.
      String jobState()
      Gets the jobState property: Describes the state of the streaming job.
      JobStorageAccount jobStorageAccount()
      Gets the jobStorageAccount property: The properties that are associated with an Azure Storage account with MSI.
      JobType jobType()
      Gets the jobType property: Describes the type of the job.
      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.
      String location()
      Gets the location property: The geo-location where the resource lives.
      String name()
      Gets the name property: The name of the resource.
      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).
      List<Output> outputs()
      Gets the outputs property: A list of one or more outputs for the streaming job.
      OutputStartMode outputStartMode()
      Gets the outputStartMode property: This property should only be utilized when it is desired that the job be started immediately upon creation.
      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.
      String provisioningState()
      Gets the provisioningState property: Describes the provisioning status of the streaming job.
      StreamingJob refresh()
      Refreshes the resource to sync with Azure.
      StreamingJob refresh​(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      com.azure.core.management.Region region()
      Gets the region of the resource.
      String regionName()
      Gets the name of the resource region.
      void scale()
      Scales a streaming job when the job is running.
      void scale​(ScaleStreamingJobParameters scaleJobParameters)
      Scales a streaming job when the job is running.
      void scale​(ScaleStreamingJobParameters scaleJobParameters, com.azure.core.util.Context context)
      Scales a streaming job when the job is running.
      Sku sku()
      Gets the sku property: Describes the SKU of the streaming job.
      void start()
      Starts a streaming job.
      void start​(StartStreamingJobParameters startJobParameters)
      Starts a streaming job.
      void start​(StartStreamingJobParameters startJobParameters, com.azure.core.util.Context context)
      Starts a streaming job.
      void stop()
      Stops a running streaming job.
      void stop​(com.azure.core.util.Context context)
      Stops a running streaming job.
      Map<String,​String> tags()
      Gets the tags property: Resource tags.
      Transformation transformation()
      Gets the transformation property: Indicates the query and the number of streaming units to use for the streaming job.
      String type()
      Gets the type property: The type of the resource.
      StreamingJob.Update update()
      Begins update for the StreamingJob resource.

    • Method Detail

      • id

        String id()
        Gets the id property: Fully qualified resource Id for the resource.
        Returns:
        the id value.

      • name

        String name()
        Gets the name property: The name of the resource.
        Returns:
        the name value.

      • type

        String type()
        Gets the type property: The type of the resource.
        Returns:
        the type value.

      • location

        String location()
        Gets the location property: The geo-location where the resource lives.
        Returns:
        the location value.

      • tags

        Map<String,​String> tags()
        Gets the tags property: Resource tags.
        Returns:
        the tags value.

      • identity

        Identity identity()
        Gets the identity property: Describes the system-assigned managed identity assigned to this job that can be used to authenticate with inputs and outputs.
        Returns:
        the identity value.

      • sku

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

      • jobId

        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.

      • provisioningState

        String provisioningState()
        Gets the provisioningState property: Describes the provisioning status of the streaming job.
        Returns:
        the provisioningState value.

      • jobState

        String jobState()
        Gets the jobState property: Describes the state of the streaming job.
        Returns:
        the jobState value.

      • jobType

        JobType jobType()
        Gets the jobType property: Describes the type of the job. Valid modes are `Cloud` and 'Edge'.
        Returns:
        the jobType value.

      • outputStartMode

        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

        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.

      • lastOutputEventTime

        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.

      • eventsOutOfOrderPolicy

        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.

      • outputErrorPolicy

        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.

      • eventsOutOfOrderMaxDelayInSeconds

        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.

      • eventsLateArrivalMaxDelayInSeconds

        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.

      • dataLocale

        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.

      • compatibilityLevel

        CompatibilityLevel compatibilityLevel()
        Gets the compatibilityLevel property: Controls certain runtime behaviors of the streaming job.
        Returns:
        the compatibilityLevel value.

      • createdDate

        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.

      • inputs

        List<Input> 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.

      • transformation

        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.

      • outputs

        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.

      • functions

        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.

      • etag

        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.

      • jobStorageAccount

        JobStorageAccount jobStorageAccount()
        Gets the jobStorageAccount property: The properties that are associated with an Azure Storage account with MSI.
        Returns:
        the jobStorageAccount value.

      • contentStoragePolicy

        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.

      • cluster

        ClusterInfo cluster()
        Gets the cluster property: The cluster which streaming jobs will run on.
        Returns:
        the cluster value.

      • region

        com.azure.core.management.Region region()
        Gets the region of the resource.
        Returns:
        the region of the resource.

      • regionName

        String regionName()
        Gets the name of the resource region.
        Returns:
        the name of the resource region.

      • innerModel

        StreamingJobInner innerModel()
        Gets the inner com.azure.resourcemanager.streamanalytics.fluent.models.StreamingJobInner object.
        Returns:
        the inner object.

      • update

        StreamingJob.Update update()
        Begins update for the StreamingJob resource.
        Returns:
        the stage of resource update.

      • refresh

        StreamingJob refresh()
        Refreshes the resource to sync with Azure.
        Returns:
        the refreshed resource.

      • refresh

        StreamingJob refresh​(com.azure.core.util.Context context)
        Refreshes the resource to sync with Azure.
        Parameters:
        context - The context to associate with this operation.
        Returns:
        the refreshed resource.

      • start

        void start​(StartStreamingJobParameters startJobParameters)
        Starts a streaming job. Once a job is started it will start processing input events and produce output.
        Parameters:
        startJobParameters - Parameters applicable to a start streaming job operation.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • start

        void start()
        Starts a streaming job. Once a job is started it will start processing input events and produce output.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • start

        void start​(StartStreamingJobParameters startJobParameters,
           com.azure.core.util.Context context)
        Starts a streaming job. Once a job is started it will start processing input events and produce output.
        Parameters:
        startJobParameters - Parameters applicable to a start streaming job operation.
        context - The context to associate with this operation.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • stop

        void stop()
        Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • stop

        void stop​(com.azure.core.util.Context context)
        Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.
        Parameters:
        context - The context to associate with this operation.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • scale

        void scale​(ScaleStreamingJobParameters scaleJobParameters)
        Scales a streaming job when the job is running.
        Parameters:
        scaleJobParameters - Parameters applicable to a scale streaming job operation.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • scale

        void scale()
        Scales a streaming job when the job is running.
        Throws:
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

      • scale

        void scale​(ScaleStreamingJobParameters scaleJobParameters,
           com.azure.core.util.Context context)
        Scales a streaming job when the job is running.
        Parameters:
        scaleJobParameters - Parameters applicable to a scale streaming job operation.
        context - The context to associate with this operation.
        Throws:
        IllegalArgumentException - thrown if parameters fail the validation.
        com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
        RuntimeException - all other wrapped checked exceptions if the request fails to be sent.