ClientBase Class

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.

Represents the base class of client objects.

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

Inheritance Hierarchy

System.Object
Microsoft.WindowsAzure.Management.HDInsight.Framework.Core.DisposableObject
Microsoft.Hadoop.Client.ClientBase
Microsoft.WindowsAzure.Management.HDInsight.HDInsightClient

Syntax

[SuppressMessageAttribute("Microsoft.Design", "CA1063:ImplementIDisposableCorrectly", 
    Justification = "DisposableObject implements IDisposable correctly, the implementation of IDisposable in the interfaces is necessary for the design.")]
public abstract class ClientBase : DisposableObject, IJobSubmissionClientBase, 
    IHadoopClientBase, IDisposable, ILogProvider

[SuppressMessageAttribute("Microsoft.Design", "CA1063:ImplementIDisposableCorrectly", 
    Justification = "DisposableObject implements IDisposable correctly, the implementation of IDisposable in the interfaces is necessary for the design.")]
public ref class ClientBase abstract : DisposableObject, IJobSubmissionClientBase, 
    IHadoopClientBase, IDisposable, ILogProvider

[<AbstractClass>]
[<SuppressMessageAttribute("Microsoft.Design", "CA1063:ImplementIDisposableCorrectly",
    Justification = "DisposableObject implements IDisposable correctly, the implementation of IDisposable in the interfaces is necessary for the design.")>]
type ClientBase = 
    class
        inherit DisposableObject
        interface IJobSubmissionClientBase
        interface IHadoopClientBase
        interface IDisposable
        interface ILogProvider
    end

<SuppressMessageAttribute("Microsoft.Design", "CA1063:ImplementIDisposableCorrectly",
    Justification := "DisposableObject implements IDisposable correctly, the implementation of IDisposable in the interfaces is necessary for the design.")>
Public MustInherit Class ClientBase
    Inherits DisposableObject
    Implements IJobSubmissionClientBase, IHadoopClientBase, IDisposable,
    ILogProvider

Constructors

	Name	Description
	ClientBase()	Initializes a new instance of the ClientBase class.
	ClientBase(Nullable<TimeSpan>, IRetryPolicy)	Initializes a new instance of the ClientBase class.

Properties

	Name	Description
	CancellationSource	Gets or sets the cancellation token source that is used to signal to a cancellation token that it should be canceled.
	CancellationToken	Gets the cancellation token that propagates notification that operations should be canceled.
	Context	Gets the abstraction context to be used to control cancellation and log writing.
	HttpOperationTimeout	Gets or sets the HTTP operation timeout.
	IgnoreSslErrors
	Logger	Gets the logger used to log messages.
	RetryPolicy	Gets or sets the retry policy.

Methods

	Name	Description
	AddLogWriter(ILogWriter)	Adds a log writer to the client.
	Cancel()	Cancels a pending operation.
	CheckDisposed()	(Inherited from DisposableObject.)
	Dispose()	(Inherited from DisposableObject.)
	Dispose(Boolean)	(Inherited from DisposableObject.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from DisposableObject.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	IsDisposed()	(Inherited from DisposableObject.)
	MemberwiseClone()	(Inherited from Object.)
	PrepareQueryJob<TJobType>(TJobType)	Prepares a query job for execution.
	ReleaseManagedResources()	(Inherited from DisposableObject.)
	ReleaseUnmanagedResources()	(Inherited from DisposableObject.)
	RemoveLogWriter(ILogWriter)
	SetCancellationSource(CancellationTokenSource)	Allows a user to set a custom cancellation source.
	ToString()	(Inherited from Object.)

Remarks

Provides client cancellation and logging functionality.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via