Interface StreamingJobs


  • public interface StreamingJobs
    Resource collection API of StreamingJobs.
    • Method Detail

      • deleteByResourceGroup

        void deleteByResourceGroup​(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

        StreamingJob 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

        com.azure.core.http.rest.Response<StreamingJob> 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<StreamingJob> 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<StreamingJob> 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<StreamingJob> 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<StreamingJob> 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.
      • 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.
      • 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.
      • 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.
      • getById

        StreamingJob getById​(String id)
        Gets details about the specified streaming job.
        Parameters:
        id - the resource ID.
        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.
      • getByIdWithResponse

        com.azure.core.http.rest.Response<StreamingJob> getByIdWithResponse​(String id,
                                                                            String expand,
                                                                            com.azure.core.util.Context context)
        Gets details about the specified streaming job.
        Parameters:
        id - the resource ID.
        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.
      • deleteById

        void deleteById​(String id)
        Deletes a streaming job.
        Parameters:
        id - the resource ID.
        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.
      • deleteByIdWithResponse

        void deleteByIdWithResponse​(String id,
                                    com.azure.core.util.Context context)
        Deletes a streaming job.
        Parameters:
        id - the resource ID.
        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.
      • define

        StreamingJob.DefinitionStages.Blank define​(String name)
        Begins definition for a new StreamingJob resource.
        Parameters:
        name - resource name.
        Returns:
        the first stage of the new StreamingJob definition.