26.163. Class Pollster

Namespace: ArmoniK.Core.Common.Injection.Options
Assembly: ArmoniK.Core.Common.dll

Configuration for

[ExtractDocumentation("Options for Pollster")]
public class Pollster

26.163.1. Inheritance

objectPollster

26.163.2. Inherited Members

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

26.163.3. Fields

26.163.3.1. SettingSection

Path to the section containing the values in the configuration object

public const string SettingSection = "Pollster"

26.163.3.1.1. Field Value

string

26.163.4. Properties

26.163.4.1. CacheEvictionThreshold

Fraction of disk space used (0–1) above which LRU eviction is triggered. Set to 0 to disable caching entirely.

public double CacheEvictionThreshold { get; set; }

26.163.4.1.1. Property Value

double

26.163.4.1.2. Remarks

When the cache usage reaches or exceeds this threshold, eviction policies may be applied to remove items and free up space. Adjust this value to control how aggressively the cache manages its capacity.

26.163.4.2. FailReadinessIfNoTasks

Indicates that readiness health check fails when no tasks are available for this pollster.

public bool FailReadinessIfNoTasks { get; set; }

26.163.4.2.1. Property Value

bool

26.163.4.3. GraceDelay

Grace delay before the pollster cancels the task and put the message back into the queue

public TimeSpan GraceDelay { get; set; }

26.163.4.3.1. Property Value

TimeSpan

26.163.4.4. InternalCacheFolder

Persistent cache directory. Files are keyed by ResultId. Can be shared across multiple agent processes on the same node.

public string InternalCacheFolder { get; set; }

26.163.4.4.1. Property Value

string

26.163.4.5. MaxErrorAllowed

Maximum number of consecutive errors allowed in the pollster before it crashes Negative values disable the check

public int MaxErrorAllowed { get; set; }

26.163.4.5.1. Property Value

int

26.163.4.6. MessageDuplicationDelay

When a message is detected to be duplicated during the acquisition, delays the message release to the queue.

public TimeSpan MessageDuplicationDelay { get; set; }

26.163.4.6.1. Property Value

TimeSpan

26.163.4.7. NbAcquisitionRetry

Number of acquisitions to try during the processing of a previous task. If the processing task is still running after that many acquisitions, the Agent will stop acquiring tasks until the processing task has finished.

public int NbAcquisitionRetry { get; set; }

26.163.4.7.1. Property Value

int

26.163.4.8. NbPendingRetry

Number of times to re-read a Pending task before postponing the message. Covers the window between the queue push and the status update to Submitted that occurs during task submission.

public int NbPendingRetry { get; set; }

26.163.4.8.1. Property Value

int

26.163.4.9. PartitionId

Identifier of the queue partition

public string PartitionId { get; set; }

26.163.4.9.1. Property Value

string

26.163.4.10. PendingRetryDelay

Delay between consecutive re-reads of a task that is still in Pending status during acquisition, to allow the submitter time to complete the transition to Submitted.

public TimeSpan PendingRetryDelay { get; set; }

26.163.4.10.1. Property Value

TimeSpan

26.163.4.11. ProcessingCrashedDelay

The delay after the agent has verified the other agent crashed before retrying the task.

public TimeSpan ProcessingCrashedDelay { get; set; }

26.163.4.11.1. Property Value

TimeSpan

26.163.4.12. SharedCacheFolder

Root directory for per-task staging folders. Sub-directories are created here for each task and deleted after it completes

public string SharedCacheFolder { get; set; }

26.163.4.12.1. Property Value

string

26.163.4.13. ShutdownTimeout

Timeout passed to IHost.StopAsync that will shutdown the application

public TimeSpan ShutdownTimeout { get; set; }

26.163.4.13.1. Property Value

TimeSpan

26.163.4.14. TimeoutBeforeNextAcquisition

Timeout before releasing the current acquired task and acquiring a new one This happens in parallel of the execution of another task

public TimeSpan TimeoutBeforeNextAcquisition { get; set; }

26.163.4.14.1. Property Value

TimeSpan