Interface IOpenApiClient

An interface representing an Open API session, from which you can login, access workers and persistent queries.

Namespace: Deephaven.OpenAPI.Client
Assembly: DeephavenOpenAPI.dll
Syntax
public interface IOpenApiClient : IDisposable

Methods

AttachWorkerByNameTask(String, IWorkerListener)

Attach a new worker session to the given Persistent Query by name.

Declaration
Task<IWorkerSession> AttachWorkerByNameTask(string name, IWorkerListener workerListener = null)
Parameters
Type Name Description
System.String name
IWorkerListener workerListener
Returns
Type Description
Task<IWorkerSession>

AttachWorkerBySerialTask(Int64, IWorkerListener)

Attach a new worker session to the given Persistent Query by serial number.

Declaration
Task<IWorkerSession> AttachWorkerBySerialTask(long serial, IWorkerListener workerListener = null)
Parameters
Type Name Description
System.Int64 serial
IWorkerListener workerListener
Returns
Type Description
Task<IWorkerSession>

GetPersistentQueryConfig(Int64)

Declaration
IPersistentQueryConfig GetPersistentQueryConfig(long name)
Parameters
Type Name Description
System.Int64 name
Returns
Type Description
IPersistentQueryConfig

GetPersistentQueryConfigs()

Declaration
Dictionary<long, IPersistentQueryConfig> GetPersistentQueryConfigs()
Returns
Type Description
Dictionary<System.Int64, IPersistentQueryConfig>

GetWorkerProfilesTask()

Provides a list of Worker JVM profiles, that can be used in the JvmProfile argument when starting a new worker.

Declaration
Task<string[]> GetWorkerProfilesTask()
Returns
Type Description
Task<System.String[]>

LoginTask(String, String, String)

Declaration
Task LoginTask(string username, string password, string operateAs = null)
Parameters
Type Name Description
System.String username
System.String password
System.String operateAs
Returns
Type Description
Task

LoginTask(TextReader)

Declaration
Task LoginTask(TextReader privKeyReader)
Parameters
Type Name Description
TextReader privKeyReader
Returns
Type Description
Task

StartWorkerTask(WorkerOptions, IWorkerListener)

Start a new worker session.

Declaration
Task<IWorkerSession> StartWorkerTask(WorkerOptions options, IWorkerListener workerListener = null)
Parameters
Type Name Description
WorkerOptions options
IWorkerListener workerListener
Returns
Type Description
Task<IWorkerSession>

Extension Methods