Interface StreamingJobsClient


  • public interface StreamingJobsClient
    An instance of this class provides access to all the operations defined in StreamingJobsClient.
    • Method Detail

      • beginCreateOrReplace

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<StreamingJobInner>,​StreamingJobInner> beginCreateOrReplace​(String resourceGroupName,
                                                                                                                                                             String jobName,
                                                                                                                                                             StreamingJobInner streamingJob,
                                                                                                                                                             String ifMatch,
                                                                                                                                                             String ifNoneMatch)
        Creates a streaming job or replaces an already existing streaming job.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        streamingJob - The definition of the streaming job that will be used to create a new streaming job or replace the existing one.
        ifMatch - The ETag of the streaming job. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
        ifNoneMatch - Set to '*' to allow a new streaming job to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.
        Returns:
        a streaming job object, containing all information associated with the named streaming job.
        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.
      • beginCreateOrReplace

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<StreamingJobInner>,​StreamingJobInner> beginCreateOrReplace​(String resourceGroupName,
                                                                                                                                                             String jobName,
                                                                                                                                                             StreamingJobInner streamingJob,
                                                                                                                                                             String ifMatch,
                                                                                                                                                             String ifNoneMatch,
                                                                                                                                                             com.azure.core.util.Context context)
        Creates a streaming job or replaces an already existing streaming job.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        streamingJob - The definition of the streaming job that will be used to create a new streaming job or replace the existing one.
        ifMatch - The ETag of the streaming job. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
        ifNoneMatch - Set to '*' to allow a new streaming job to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.
        context - The context to associate with this operation.
        Returns:
        a streaming job object, containing all information associated with the named streaming job.
        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.
      • createOrReplace

        StreamingJobInner createOrReplace​(String resourceGroupName,
                                          String jobName,
                                          StreamingJobInner streamingJob,
                                          String ifMatch,
                                          String ifNoneMatch)
        Creates a streaming job or replaces an already existing streaming job.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        streamingJob - The definition of the streaming job that will be used to create a new streaming job or replace the existing one.
        ifMatch - The ETag of the streaming job. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
        ifNoneMatch - Set to '*' to allow a new streaming job to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.
        Returns:
        a streaming job object, containing all information associated with the named streaming job.
        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.
      • createOrReplace

        StreamingJobInner createOrReplace​(String resourceGroupName,
                                          String jobName,
                                          StreamingJobInner streamingJob)
        Creates a streaming job or replaces an already existing streaming job.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        streamingJob - The definition of the streaming job that will be used to create a new streaming job or replace the existing one.
        Returns:
        a streaming job object, containing all information associated with the named streaming job.
        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.
      • createOrReplace

        StreamingJobInner createOrReplace​(String resourceGroupName,
                                          String jobName,
                                          StreamingJobInner streamingJob,
                                          String ifMatch,
                                          String ifNoneMatch,
                                          com.azure.core.util.Context context)
        Creates a streaming job or replaces an already existing streaming job.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        streamingJob - The definition of the streaming job that will be used to create a new streaming job or replace the existing one.
        ifMatch - The ETag of the streaming job. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
        ifNoneMatch - Set to '*' to allow a new streaming job to be created, but to prevent updating an existing record set. Other values will result in a 412 Pre-condition Failed response.
        context - The context to associate with this operation.
        Returns:
        a streaming job object, containing all information associated with the named streaming job.
        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.
      • update

        StreamingJobInner update​(String resourceGroupName,
                                 String jobName,
                                 StreamingJobInner streamingJob)
        Updates an existing streaming job. This can be used to partially update (ie. update one or two properties) a streaming job without affecting the rest the job definition.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        streamingJob - A streaming job object. The properties specified here will overwrite the corresponding properties in the existing streaming job (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing input will remain the same and not change as a result of this PATCH operation.
        Returns:
        a streaming job object, containing all information associated with the named streaming job.
        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.
      • updateWithResponse

        StreamingJobsUpdateResponse updateWithResponse​(String resourceGroupName,
                                                       String jobName,
                                                       StreamingJobInner streamingJob,
                                                       String ifMatch,
                                                       com.azure.core.util.Context context)
        Updates an existing streaming job. This can be used to partially update (ie. update one or two properties) a streaming job without affecting the rest the job definition.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        streamingJob - A streaming job object. The properties specified here will overwrite the corresponding properties in the existing streaming job (ie. Those properties will be updated). Any properties that are set to null here will mean that the corresponding property in the existing input will remain the same and not change as a result of this PATCH operation.
        ifMatch - The ETag of the streaming job. Omit this value to always overwrite the current record set. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.
        context - The context to associate with this operation.
        Returns:
        a streaming job object, containing all information associated with the named streaming job.
        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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                          String jobName)
        Deletes a streaming job.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        Returns:
        the completion.
        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.
      • beginDelete

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginDelete​(String resourceGroupName,
                                                                                                                          String jobName,
                                                                                                                          com.azure.core.util.Context context)
        Deletes a streaming job.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        context - The context to associate with this operation.
        Returns:
        the completion.
        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.
      • delete

        void delete​(String resourceGroupName,
                    String jobName)
        Deletes a streaming job.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        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.
      • delete

        void delete​(String resourceGroupName,
                    String jobName,
                    com.azure.core.util.Context context)
        Deletes a streaming job.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        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.
      • getByResourceGroup

        StreamingJobInner getByResourceGroup​(String resourceGroupName,
                                             String jobName)
        Gets details about the specified streaming job.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        Returns:
        details about the specified streaming job.
        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.
      • getByResourceGroupWithResponse

        StreamingJobsGetByResourceGroupResponse getByResourceGroupWithResponse​(String resourceGroupName,
                                                                               String jobName,
                                                                               String expand,
                                                                               com.azure.core.util.Context context)
        Gets details about the specified streaming job.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        expand - The $expand OData query parameter. This is a comma-separated list of additional streaming job properties to include in the response, beyond the default set returned when this parameter is absent. The default set is all streaming job properties other than 'inputs', 'transformation', 'outputs', and 'functions'.
        context - The context to associate with this operation.
        Returns:
        details about the specified streaming job.
        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.
      • listByResourceGroup

        com.azure.core.http.rest.PagedIterable<StreamingJobInner> listByResourceGroup​(String resourceGroupName)
        Lists all of the streaming jobs in the specified resource group.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        Returns:
        object containing a list of streaming jobs.
        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.
      • listByResourceGroup

        com.azure.core.http.rest.PagedIterable<StreamingJobInner> listByResourceGroup​(String resourceGroupName,
                                                                                      String expand,
                                                                                      com.azure.core.util.Context context)
        Lists all of the streaming jobs in the specified resource group.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        expand - The $expand OData query parameter. This is a comma-separated list of additional streaming job properties to include in the response, beyond the default set returned when this parameter is absent. The default set is all streaming job properties other than 'inputs', 'transformation', 'outputs', and 'functions'.
        context - The context to associate with this operation.
        Returns:
        object containing a list of streaming jobs.
        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.
      • list

        com.azure.core.http.rest.PagedIterable<StreamingJobInner> list()
        Lists all of the streaming jobs in the given subscription.
        Returns:
        object containing a list of streaming jobs.
        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.
      • list

        com.azure.core.http.rest.PagedIterable<StreamingJobInner> list​(String expand,
                                                                       com.azure.core.util.Context context)
        Lists all of the streaming jobs in the given subscription.
        Parameters:
        expand - The $expand OData query parameter. This is a comma-separated list of additional streaming job properties to include in the response, beyond the default set returned when this parameter is absent. The default set is all streaming job properties other than 'inputs', 'transformation', 'outputs', and 'functions'.
        context - The context to associate with this operation.
        Returns:
        object containing a list of streaming jobs.
        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.
      • beginStart

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginStart​(String resourceGroupName,
                                                                                                                         String jobName,
                                                                                                                         StartStreamingJobParameters startJobParameters)
        Starts a streaming job. Once a job is started it will start processing input events and produce output.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        startJobParameters - Parameters applicable to a start streaming job operation.
        Returns:
        the completion.
        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.
      • beginStart

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginStart​(String resourceGroupName,
                                                                                                                         String jobName,
                                                                                                                         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:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        startJobParameters - Parameters applicable to a start streaming job operation.
        context - The context to associate with this operation.
        Returns:
        the completion.
        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​(String resourceGroupName,
                   String jobName,
                   StartStreamingJobParameters startJobParameters)
        Starts a streaming job. Once a job is started it will start processing input events and produce output.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        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​(String resourceGroupName,
                   String jobName)
        Starts a streaming job. Once a job is started it will start processing input events and produce output.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        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​(String resourceGroupName,
                   String jobName,
                   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:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        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.
      • beginStop

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginStop​(String resourceGroupName,
                                                                                                                        String jobName)
        Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        Returns:
        the completion.
        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.
      • beginStop

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginStop​(String resourceGroupName,
                                                                                                                        String jobName,
                                                                                                                        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:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        context - The context to associate with this operation.
        Returns:
        the completion.
        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​(String resourceGroupName,
                  String jobName)
        Stops a running streaming job. This will cause a running streaming job to stop processing input events and producing output.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        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​(String resourceGroupName,
                  String jobName,
                  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:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        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.
      • beginScale

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginScale​(String resourceGroupName,
                                                                                                                         String jobName,
                                                                                                                         ScaleStreamingJobParameters scaleJobParameters)
        Scales a streaming job when the job is running.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        scaleJobParameters - Parameters applicable to a scale streaming job operation.
        Returns:
        the completion.
        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.
      • beginScale

        com.azure.core.util.polling.SyncPoller<com.azure.core.management.polling.PollResult<Void>,​Void> beginScale​(String resourceGroupName,
                                                                                                                         String jobName,
                                                                                                                         ScaleStreamingJobParameters scaleJobParameters,
                                                                                                                         com.azure.core.util.Context context)
        Scales a streaming job when the job is running.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        scaleJobParameters - Parameters applicable to a scale streaming job operation.
        context - The context to associate with this operation.
        Returns:
        the completion.
        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​(String resourceGroupName,
                   String jobName,
                   ScaleStreamingJobParameters scaleJobParameters)
        Scales a streaming job when the job is running.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        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​(String resourceGroupName,
                   String jobName)
        Scales a streaming job when the job is running.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        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​(String resourceGroupName,
                   String jobName,
                   ScaleStreamingJobParameters scaleJobParameters,
                   com.azure.core.util.Context context)
        Scales a streaming job when the job is running.
        Parameters:
        resourceGroupName - The name of the resource group. The name is case insensitive.
        jobName - The name of the streaming job.
        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.