IJobSubmissionClient Interface

Article
05/03/2016

Note

This version of the HDInsight .NET SDK is deprecated and will be removed by January 1, 2017. You are encouraged to use the newer ARM-based version of HDInsight .NET SDK going forward. For instructions on how to use the new HDInsight .NET SDK to create a cluster, see Create HDInsight Linux clusters using .NET SDK. For instructions on how to submit jobs using the new .NET SDK and other approaches, see Submit jobs to an HDInsight cluster. The HDInsight SDK reference for the newer version is available at HDInsight .NET SDK Reference.

Defines the interface for a client used to submit jobs to a Hadoop cluster.

Namespace: Microsoft.Hadoop.Client
Assembly: Microsoft.Hadoop.Client (in Microsoft.Hadoop.Client.dll)

Syntax

public interface IJobSubmissionClient : IJobSubmissionSyncClient, 
    IJobSubmissionAsyncClient, IJobSubmissionClientBase, IHadoopClientBase, 
    IDisposable, ILogProvider

public interface class IJobSubmissionClient : IJobSubmissionSyncClient, 
    IJobSubmissionAsyncClient, IJobSubmissionClientBase, IHadoopClientBase, 
    IDisposable, ILogProvider

type IJobSubmissionClient = 
    interface
        interface IJobSubmissionSyncClient
        interface IJobSubmissionAsyncClient
        interface IJobSubmissionClientBase
        interface IHadoopClientBase
        interface IDisposable
        interface ILogProvider
    end

Public Interface IJobSubmissionClient
    Inherits IJobSubmissionSyncClient, IJobSubmissionAsyncClient,
    IJobSubmissionClientBase, IHadoopClientBase, IDisposable, ILogProvider

Properties

	Name	Description
	IgnoreSslErrors	Gets or sets a value indicating whether or not servicer side SSL errors should be ignored.(Inherited from IHadoopClientBase.)
	Logger	(Inherited from ILogProvider.)

Methods

	Name	Description
	AddLogWriter(ILogWriter)	Adds a log writer to the client.(Inherited from IHadoopClientBase.)
	Cancel()	Cancel's a pending operation.(Inherited from IHadoopClientBase.)
	CreateHiveJob(HiveJobCreateParameters)	Submits a Hive job to Hadoop cluster.(Inherited from IJobSubmissionSyncClient.)
	CreateHiveJobAsync(HiveJobCreateParameters)	Submits a Hive job to Hadoop cluster.(Inherited from IJobSubmissionAsyncClient.)
	CreateMapReduceJob(MapReduceJobCreateParameters)	Submits a Map Reduce job to Hadoop cluster.(Inherited from IJobSubmissionSyncClient.)
	CreateMapReduceJobAsync(MapReduceJobCreateParameters)	Submits a Map Reduce job to Hadoop cluster.(Inherited from IJobSubmissionAsyncClient.)
	CreatePigJob(PigJobCreateParameters)	Submits a Pig job to Hadoop cluster.(Inherited from IJobSubmissionSyncClient.)
	CreatePigJobAsync(PigJobCreateParameters)	Submits a Pig job to Hadoop cluster.(Inherited from IJobSubmissionAsyncClient.)
	CreateSqoopJob(SqoopJobCreateParameters)	Submits a Sqoop job to Hadoop cluster.(Inherited from IJobSubmissionSyncClient.)
	CreateSqoopJobAsync(SqoopJobCreateParameters)	Submits a Sqoop job to Hadoop cluster.(Inherited from IJobSubmissionAsyncClient.)
	CreateStreamingJob(StreamingMapReduceJobCreateParameters)	Submits a streaming job to Hadoop cluster.(Inherited from IJobSubmissionSyncClient.)
	CreateStreamingJobAsync(StreamingMapReduceJobCreateParameters)	Submits a streaming job to Hadoop cluster.(Inherited from IJobSubmissionAsyncClient.)
	Dispose()	(Inherited from IDisposable.)
	DownloadJobTaskLogs(String, String)	Downloads task logs of the job.(Inherited from IJobSubmissionSyncClient.)
	DownloadJobTaskLogsAsync(String, String)	Downloads task logs of the job.(Inherited from IJobSubmissionAsyncClient.)
	GetCustomUserAgent()	Returns custom user agent to pass along with all job submissions.
	GetJob(String)	Gets the job details synchronously using the job ID.(Inherited from IJobSubmissionSyncClient.)
	GetJobAsync(String)	Gets the job details asynchronously using the job ID.(Inherited from IJobSubmissionAsyncClient.)
	GetJobErrorLogs(String)	Gets the error logs for a specified job.(Inherited from IJobSubmissionSyncClient.)
	GetJobErrorLogsAsync(String)	Gets the error log of the job asynchronously.(Inherited from IJobSubmissionAsyncClient.)
	GetJobOutput(String)	Gets the output of a specified job.(Inherited from IJobSubmissionSyncClient.)
	GetJobOutputAsync(String)	Gets the output of the job asynchronously.(Inherited from IJobSubmissionAsyncClient.)
	GetJobTaskLogSummary(String)	Gets the task log summary for a specified job.(Inherited from IJobSubmissionSyncClient.)
	GetJobTaskLogSummaryAsync(String)	Gets the task log summary of the job asynchronously.(Inherited from IJobSubmissionAsyncClient.)
	HandleClusterWaitNotifyEvent(JobDetails)	Used to handle the notification events during waiting.(Inherited from IJobSubmissionAsyncClient.)
	ListJobs()	Lists the jobs currently on the Hadoop cluster.(Inherited from IJobSubmissionSyncClient.)
	ListJobsAsync()	Lists the jobs currently on the Hadoop cluster.(Inherited from IJobSubmissionAsyncClient.)
	RemoveLogWriter(ILogWriter)	Removes a log writer.(Inherited from IHadoopClientBase.)
	SetCancellationSource(CancellationTokenSource)	Allows a user to set a custom cancellation source.(Inherited from IHadoopClientBase.)
	StopJob(String)	Stops the execution of a job that is running currently.(Inherited from IJobSubmissionSyncClient.)
	StopJobAsync(String)	Stops the execution of a running job.(Inherited from IJobSubmissionAsyncClient.)

Events

	Name	Description
	JobStatusEvent	Event that is fired when job status changes.(Inherited from IJobSubmissionAsyncClient.)

Extension Methods

	Name	Description
	WaitForJobCompletion(JobCreationResults, TimeSpan, CancellationToken)	Waits a specified duration synchronously for a job from a specified client to complete.(Defined by IHadoopClientExtensions.)
	WaitForJobCompletionAsync(JobCreationResults, TimeSpan, CancellationToken)	Overloaded. Waits a specified duration asynchronously for a job from a specified client to complete.(Defined by IHadoopClientExtensions.)
	WaitForJobCompletionAsync(String, TimeSpan, CancellationToken)	Overloaded. Waits a specified duration asynchronously for a job from a specified client to complete.(Defined by IHadoopClientExtensions.)

Remarks

IJobSubmissionClient objects are created by the JobSubmissionClientFactory.

Share via