17.100. Class TaskOptions
Namespace: ArmoniK.Core.Base.DataStructures
Assembly: ArmoniK.Core.Base.dll
Options to set up task execution
public record TaskOptions : IEquatable<TaskOptions>
17.100.1. Inheritance
17.100.2. Implements
17.100.3. Inherited Members
object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
17.100.4. Constructors
17.100.4.1. TaskOptions(IDictionary<string, string>, TimeSpan, int, int, string, string, string, string, string, string)
Options to set up task execution
public TaskOptions(IDictionary<string, string> Options, TimeSpan MaxDuration, int MaxRetries, int Priority, string PartitionId, string ApplicationName, string ApplicationVersion, string ApplicationNamespace, string ApplicationService, string EngineType)
17.100.4.1.1. Parameters
Options IDictionary<string, string>
Custom defined options transmitted to the task from the client
MaxDuration TimeSpan
Max duration of the task
MaxRetries int
Number of retries allowed to the task
Priority int
Priority of the task
PartitionId string
Partition in which the task is executed
ApplicationName string
Application Name field transmitted to the task from the client
ApplicationVersion string
Application Version field transmitted to the task from the client
ApplicationNamespace string
Application Namespace field transmitted to the task from the client
ApplicationService string
Application Service field transmitted to the task from the client
EngineType string
Engine Type field transmitted to the task from the client
17.100.4.2. TaskOptions()
Creates a default
public TaskOptions()
17.100.5. Properties
17.100.5.1. ApplicationName
Application Name field transmitted to the task from the client
public string ApplicationName { get; init; }
17.100.5.1.1. Property Value
17.100.5.2. ApplicationNamespace
Application Namespace field transmitted to the task from the client
public string ApplicationNamespace { get; init; }
17.100.5.2.1. Property Value
17.100.5.3. ApplicationService
Application Service field transmitted to the task from the client
public string ApplicationService { get; init; }
17.100.5.3.1. Property Value
17.100.5.4. ApplicationVersion
Application Version field transmitted to the task from the client
public string ApplicationVersion { get; init; }
17.100.5.4.1. Property Value
17.100.5.5. EngineType
Engine Type field transmitted to the task from the client
public string EngineType { get; init; }
17.100.5.5.1. Property Value
17.100.5.6. MaxDuration
Max duration of the task
public TimeSpan MaxDuration { get; init; }
17.100.5.6.1. Property Value
17.100.5.7. MaxRetries
Number of retries allowed to the task
public int MaxRetries { get; init; }
17.100.5.7.1. Property Value
17.100.5.8. Options
Custom defined options transmitted to the task from the client
public IDictionary<string, string> Options { get; init; }
17.100.5.8.1. Property Value
17.100.5.9. PartitionId
Partition in which the task is executed
public string PartitionId { get; init; }
17.100.5.9.1. Property Value
17.100.5.10. Priority
Priority of the task
public int Priority { get; init; }
17.100.5.10.1. Property Value
17.100.6. Methods
17.100.6.1. Equals(TaskOptions?)
Indicates whether the current object is equal to another object of the same type.
public virtual bool Equals(TaskOptions? other)
17.100.6.1.1. Parameters
other TaskOptions?
An object to compare with this object.
17.100.6.1.2. Returns
true if the current object is equal to the other parameter; otherwise, false.
17.100.6.2. GetHashCode()
Serves as the default hash function.
public override int GetHashCode()
17.100.6.2.1. Returns
A hash code for the current object.
17.100.6.3. Merge(TaskOptions?, TaskOptions)
Creates new
public static TaskOptions Merge(TaskOptions? taskOption, TaskOptions defaultOption)
17.100.6.3.1. Parameters
taskOption TaskOptions?
Base options
defaultOption TaskOptions
Default values
17.100.6.3.2. Returns
The merged options