Show / Hide Table of Contents

Class WorkerOptions

An object representing the options available when starting a new worker process.

Inheritance
System.Object
WorkerOptions
Namespace: Deephaven.OpenAPI.Client
Assembly: DeephavenOpenAPI.dll
Syntax
public class WorkerOptions : object

Constructors

WorkerOptions(String, Int32)

Construct a WorkerOptions object

Declaration
public WorkerOptions(string jvmProfile, int maxHeapMb = 2000)
Parameters
Type Name Description
System.String jvmProfile

Named JVM profile to use, or the string "Default"

System.Int32 maxHeapMb

Java max heap size for the worker, in megabytes

Properties

Classpath

Declaration
public string[] Classpath { get; set; }
Property Value
Type Description
System.String[]

Debug

Declaration
public bool Debug { get; set; }
Property Value
Type Description
System.Boolean

DetailedGCLogging

Declaration
public bool DetailedGCLogging { get; set; }
Property Value
Type Description
System.Boolean

DispatcherHost

Declaration
public string DispatcherHost { get; set; }
Property Value
Type Description
System.String

DispatcherPort

Declaration
public int DispatcherPort { get; set; }
Property Value
Type Description
System.Int32

EnvVars

Declaration
public string[][] EnvVars { get; set; }
Property Value
Type Description
System.String[][]

ExtraJvmArgs

Declaration
public string[] ExtraJvmArgs { get; set; }
Property Value
Type Description
System.String[]

JvmProfile

Declaration
public string JvmProfile { get; set; }
Property Value
Type Description
System.String

MaxHeapMB

Java max heap size.

Declaration
public int MaxHeapMB { get; set; }
Property Value
Type Description
System.Int32

Java max heap size for the worker, in megabytes.

OmitDefaultGcParameters

Declaration
public bool OmitDefaultGcParameters { get; set; }
Property Value
Type Description
System.Boolean

QueryDescription

Declaration
public string QueryDescription { get; set; }
Property Value
Type Description
System.String

Methods

AddJvmArg(String)

Declaration
public void AddJvmArg(string arg)
Parameters
Type Name Description
System.String arg
Back to top Generated by DocFX