SparkBatchClient.GetSparkBatchJobsAsync(Nullable<Int32>, Nullable<Int32>, Nullable<Boolean>, CancellationToken) Method

Definition

List all spark batch jobs which are running under a particular spark pool.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Synapse.Spark.Models.SparkBatchJobCollection>> GetSparkBatchJobsAsync (int? from = default, int? size = default, bool? detailed = default, System.Threading.CancellationToken cancellationToken = default);
abstract member GetSparkBatchJobsAsync : Nullable<int> * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Synapse.Spark.Models.SparkBatchJobCollection>>
override this.GetSparkBatchJobsAsync : Nullable<int> * Nullable<int> * Nullable<bool> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Analytics.Synapse.Spark.Models.SparkBatchJobCollection>>
Public Overridable Function GetSparkBatchJobsAsync (Optional from As Nullable(Of Integer) = Nothing, Optional size As Nullable(Of Integer) = Nothing, Optional detailed As Nullable(Of Boolean) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of SparkBatchJobCollection))

Parameters

from
System.Nullable<System.Int32>

Optional param specifying which index the list should begin from.

size
System.Nullable<System.Int32>

Optional param specifying the size of the returned list.

        By default it is 20 and that is the maximum.
detailed
System.Nullable<System.Boolean>

Optional query param specifying whether detailed response is returned beyond plain livy.

cancellationToken
System.Threading.CancellationToken

The cancellation token to use.

Returns

System.Threading.Tasks.Task<Response<SparkBatchJobCollection>>

Applies to