Class OpenApiClient_Extensions

Inheritance

System.Object

OpenApiClient_Extensions

Namespace: Deephaven.OpenAPI.Client

Assembly: DeephavenOpenAPI.dll

Syntax

public static class OpenApiClient_Extensions : object

Methods

AttachWorkerByName(IOpenApiClient, String, IWorkerListener)

Declaration

public static IWorkerSession AttachWorkerByName(this IOpenApiClient self, string name, IWorkerListener workerListener = null)

Parameters

Type	Name	Description
IOpenApiClient	self
System.String	name
IWorkerListener	workerListener

Returns

Type	Description
IWorkerSession

AttachWorkerBySerial(IOpenApiClient, Int64, IWorkerListener)

Declaration

public static IWorkerSession AttachWorkerBySerial(this IOpenApiClient self, long serial, IWorkerListener workerListener = null)

Parameters

Type	Name	Description
IOpenApiClient	self
System.Int64	serial
IWorkerListener	workerListener

Returns

Type	Description
IWorkerSession

GetWorkerProfiles(IOpenApiClient)

Declaration

public static string[] GetWorkerProfiles(this IOpenApiClient self)

Parameters

Type	Name	Description
IOpenApiClient	self

Returns

Type	Description
System.String[]

Login(IOpenApiClient, String)

Login with key-based credentials.

Declaration

public static void Login(this IOpenApiClient self, string privKeyFilename)

Parameters

Type	Name	Description
IOpenApiClient	self	This object (needed because this method is a C# extension method)
System.String	privKeyFilename	The filename of the Deephaven key-based credential file, e.g. a file like "priv-myuser-iris.base64.txt"

Login(IOpenApiClient, String, String, String)

Declaration

public static void Login(this IOpenApiClient self, string username, string password, string operateAs = null)

Parameters

Type	Name	Description
IOpenApiClient	self
System.String	username
System.String	password
System.String	operateAs

Login(IOpenApiClient, TextReader)

Login with key-based credentials.

Declaration

public static void Login(this IOpenApiClient self, TextReader privKeyReader)

Parameters

Type	Name	Description
IOpenApiClient	self	This object (needed because this method is a C# extension method)
TextReader	privKeyReader	A TextReader providing the contents of the Deephaven private key file, e.g. a file like "priv-myuser-iris.base64.txt"

LoginTask(IOpenApiClient, String)

Login with key-based credentials. The

Declaration

public static Task LoginTask(this IOpenApiClient self, string privKeyFilename)

Parameters

Type	Name	Description
IOpenApiClient	self	This object (needed because this method is a C# extension method)
System.String	privKeyFilename	The filename of the Deephaven key-based credential file, e.g. a file like "priv-myuser-iris.base64.txt"

Returns

Type	Description
Task

StartWorker(IOpenApiClient, WorkerOptions, IWorkerListener)

Declaration

public static IWorkerSession StartWorker(this IOpenApiClient self, WorkerOptions options, IWorkerListener workerListener = null)

Parameters

Type	Name	Description
IOpenApiClient	self
WorkerOptions	options
IWorkerListener	workerListener

Returns

Type	Description
IWorkerSession