21.358. Class BenchOptions

Namespace: ArmoniK.Samples.Bench.Client.Options
Assembly: ArmoniK.Samples.Bench.Client.dll

Class containing options for BenchOptions

[PublicAPI]
public class BenchOptions

21.358.1. Inheritance

objectBenchOptions

21.358.2. Inherited Members

object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()

21.358.3. Fields

21.358.3.1. SettingSection

Name of the section in dotnet options

public const string SettingSection = "BenchOptions"

21.358.3.1.1. Field Value

string

21.358.4. Properties

21.358.4.1. BatchSize

Number of tasks per batch

public int BatchSize { get; set; }

21.358.4.1.1. Property Value

int

21.358.4.2. DegreeOfParallelism

Number of tasks to be used in parallel execution

public int DegreeOfParallelism { get; set; }

21.358.4.2.1. Property Value

int

21.358.4.3. DownloadResults

Download results and check all results are properly retrieved

public bool DownloadResults { get; set; }

21.358.4.3.1. Property Value

bool

21.358.4.4. ExitAfterSubmission

Exit program after tasks are submitted default : false

public bool ExitAfterSubmission { get; set; }

21.358.4.4.1. Property Value

bool

21.358.4.5. MaxDuration

Task Max Duration given to Task Options

public TimeSpan MaxDuration { get; set; }

21.358.4.5.1. Property Value

TimeSpan

21.358.4.6. MaxRetries

Maximum number of retries for failures

public int MaxRetries { get; set; }

21.358.4.6.1. Property Value

int

21.358.4.7. NTasks

Number of computing tasks (there are some supplementary aggregation tasks)

public int NTasks { get; set; }

21.358.4.7.1. Property Value

int

21.358.4.8. Options

Dictionary to put into task options

public Dictionary<string, string> Options { get; set; }

21.358.4.8.1. Property Value

Dictionary<string, string>

21.358.4.9. Partition

Partition in which to submit the tasks

public string Partition { get; set; }

21.358.4.9.1. Property Value

string

21.358.4.10. PauseSessionDuringSubmission

Pause session during task submission and resume it when all tasks are submitted default : false

public bool PauseSessionDuringSubmission { get; set; }

21.358.4.10.1. Property Value

bool

21.358.4.11. PayloadSize

Size of the payloads in kilobytes

public int PayloadSize { get; set; }

21.358.4.11.1. Property Value

int

21.358.4.12. PurgeData

Purge data from the created session

public bool PurgeData { get; set; }

21.358.4.12.1. Property Value

bool

21.358.4.13. ResultSize

Size of the results in kilobytes

public int ResultSize { get; set; }

21.358.4.13.1. Property Value

int

21.358.4.14. ShowEvents

Print the event updates default : false

public bool ShowEvents { get; set; }

21.358.4.14.1. Property Value

bool

21.358.4.15. SwitchToStreamSize

Size of the payload from which streams are used to send payloads in kilobytes

public int SwitchToStreamSize { get; set; }

21.358.4.15.1. Property Value

int

21.358.4.16. TaskDurationMs

Duration of the task in milliseconds

public int TaskDurationMs { get; set; }

21.358.4.16.1. Property Value

int

21.358.4.17. TaskError

Finish task with Output of type when task id ends by this string, ignored if empty string

public string TaskError { get; set; }

21.358.4.17.1. Property Value

string

21.358.4.18. TaskPriority

Priority to use to send all the tasks

public int TaskPriority { get; set; }

21.358.4.18.1. Property Value

int

21.358.4.19. TaskRpcException

Raise RpcException when task id ends by this string, ignored if empty string

public string TaskRpcException { get; set; }

21.358.4.19.1. Property Value

string