23.224. Class TaskData
Namespace: ArmoniK.Core.Common.Storage
Assembly: ArmoniK.Core.Common.dll
Task metadata stored in database
public record TaskData : IEquatable<TaskData>
23.224.1. Inheritance
23.224.2. Implements
23.224.3. Inherited Members
object.Equals(object?), object.Equals(object?, object?), object.GetHashCode(), object.GetType(), object.MemberwiseClone(), object.ReferenceEquals(object?, object?), object.ToString()
23.224.4. Constructors
23.224.4.1. TaskData(string, string, string, string, string, IList<string>, IList<string>, IDictionary<string, bool>, IList<string>, string, string, IList<string>, TaskStatus, string, TaskOptions, DateTime, DateTime?, DateTime?, DateTime?, DateTime?, DateTime?, DateTime?, DateTime?, DateTime?, TimeSpan?, TimeSpan?, TimeSpan?, Output)
Task metadata stored in database
public TaskData(string SessionId, string TaskId, string OwnerPodId, string OwnerPodName, string PayloadId, IList<string> ParentTaskIds, IList<string> DataDependencies, IDictionary<string, bool> RemainingDataDependencies, IList<string> ExpectedOutputIds, string InitialTaskId, string CreatedBy, IList<string> RetryOfIds, TaskStatus Status, string StatusMessage, TaskOptions Options, DateTime CreationDate, DateTime? SubmittedDate, DateTime? StartDate, DateTime? EndDate, DateTime? ReceptionDate, DateTime? AcquisitionDate, DateTime? ProcessedDate, DateTime? FetchedDate, DateTime? PodTtl, TimeSpan? ProcessingToEndDuration, TimeSpan? CreationToEndDuration, TimeSpan? ReceivedToEndDuration, Output Output)
23.224.4.1.1. Parameters
SessionId string
Unique identifier of the session in which the task belongs
TaskId string
Unique identifier of the task
OwnerPodId string
Identifier of the polling agent running the task
OwnerPodName string
Name of the polling agent running the task
PayloadId string
Unique identifier of the payload in input of the task
Unique identifiers of the tasks that submitted the current task up to the session id which represents a submission from the client
DataDependencies IList<string>
Unique identifiers of the results the task depends on
RemainingDataDependencies IDictionary<string, bool>
List of dependencies that are not yet satisfied
ExpectedOutputIds IList<string>
Identifiers of the outputs the task should produce or should transmit the responsibility to produce
InitialTaskId string
Task id before retry
CreatedBy string
Id of the task that created this task.
List of previous tasks ids before the current retry
Status TaskStatus
Current status of the task
StatusMessage string
Message associated to the status
Options TaskOptions
Task options
CreationDate DateTime
Date when the task is created
SubmittedDate DateTime?
Date when the task is submitted
StartDate DateTime?
Date when the task execution begins
EndDate DateTime?
Date when the task ends
ReceptionDate DateTime?
Date when the task is received by the polling agent
AcquisitionDate DateTime?
Date when the task is acquired by the pollster
ProcessedDate DateTime?
Date when the task execution ends
FetchedDate DateTime?
Date when task data are fetched
PodTtl DateTime?
Task Time To Live on the current pod
ProcessingToEndDuration TimeSpan?
Duration between the start of processing and the end of the task
CreationToEndDuration TimeSpan?
Duration between the creation and the end of the task
ReceivedToEndDuration TimeSpan?
Duration between the reception and the end of the task
Output Output
Output of the task after its successful completion
23.224.4.2. TaskData(string, string, string, string, string, string, IList<string>, IList<string>, IList<string>, IList<string>, TaskStatus, TaskOptions, Output)
Initializes task metadata with specified fields
public TaskData(string sessionId, string taskId, string ownerPodId, string ownerPodName, string payloadId, string createdBy, IList<string> parentTaskIds, IList<string> dataDependencies, IList<string> expectedOutputIds, IList<string> retryOfIds, TaskStatus status, TaskOptions options, Output output)
23.224.4.2.1. Parameters
sessionId string
Unique identifier of the session in which the task belongs
taskId string
Unique identifier of the task
ownerPodId string
Identifier of the polling agent running the task
ownerPodName string
Hostname of the polling agent running the task
payloadId string
Unique identifier of the payload in input of the task
createdBy string
Id of the task that created this task.
Unique identifiers of the tasks that submitted the current task up to the session id which represents a submission from the client
dataDependencies IList<string>
Unique identifiers of the results the task depends on
expectedOutputIds IList<string>
Identifiers of the outputs the task should produce or should transmit the responsibility to produce
List of previous tasks ids before the current retry
status TaskStatus
Current status of the task
options TaskOptions
Task options
output Output
Output of the task after its successful completion
23.224.4.3. TaskData(TaskData, UpdateDefinition<TaskData>)
Creates a copy of a
public TaskData(TaskData original, UpdateDefinition<TaskData> updates)
23.224.4.3.1. Parameters
original TaskData
The object that will be copied
updates UpdateDefinition<TaskData>
A collection of field selector and their new values
23.224.5. Properties
23.224.5.1. AcquisitionDate
Date when the task is acquired by the pollster
public DateTime? AcquisitionDate { get; init; }
23.224.5.1.1. Property Value
23.224.5.2. CreatedBy
Id of the task that created this task.
public string CreatedBy { get; init; }
23.224.5.2.1. Property Value
23.224.5.3. CreationDate
Date when the task is created
public DateTime CreationDate { get; init; }
23.224.5.3.1. Property Value
23.224.5.4. CreationToEndDuration
Duration between the creation and the end of the task
public TimeSpan? CreationToEndDuration { get; init; }
23.224.5.4.1. Property Value
23.224.5.5. DataDependencies
Unique identifiers of the results the task depends on
public IList<string> DataDependencies { get; init; }
23.224.5.5.1. Property Value
23.224.5.6. EndDate
Date when the task ends
public DateTime? EndDate { get; init; }
23.224.5.6.1. Property Value
23.224.5.7. ExpectedOutputIds
Identifiers of the outputs the task should produce or should transmit the responsibility to produce
public IList<string> ExpectedOutputIds { get; init; }
23.224.5.7.1. Property Value
23.224.5.8. FetchedDate
Date when task data are fetched
public DateTime? FetchedDate { get; init; }
23.224.5.8.1. Property Value
23.224.5.9. InitialTaskId
Task id before retry
public string InitialTaskId { get; init; }
23.224.5.9.1. Property Value
23.224.5.10. Options
Task options
public TaskOptions Options { get; init; }
23.224.5.10.1. Property Value
TaskOptions
23.224.5.11. Output
Output of the task after its successful completion
public Output Output { get; init; }
23.224.5.11.1. Property Value
23.224.5.12. OwnerPodId
Identifier of the polling agent running the task
public string OwnerPodId { get; init; }
23.224.5.12.1. Property Value
23.224.5.13. OwnerPodName
Name of the polling agent running the task
public string OwnerPodName { get; init; }
23.224.5.13.1. Property Value
23.224.5.14. ParentTaskIds
Unique identifiers of the tasks that submitted the current task up to the session id which represents a submission from the client
public IList<string> ParentTaskIds { get; init; }
23.224.5.14.1. Property Value
23.224.5.15. PayloadId
Unique identifier of the payload in input of the task
public string PayloadId { get; init; }
23.224.5.15.1. Property Value
23.224.5.16. PodTtl
Task Time To Live on the current pod
public DateTime? PodTtl { get; init; }
23.224.5.16.1. Property Value
23.224.5.17. ProcessedDate
Date when the task execution ends
public DateTime? ProcessedDate { get; init; }
23.224.5.17.1. Property Value
23.224.5.18. ProcessingToEndDuration
Duration between the start of processing and the end of the task
public TimeSpan? ProcessingToEndDuration { get; init; }
23.224.5.18.1. Property Value
23.224.5.19. ReceivedToEndDuration
Duration between the reception and the end of the task
public TimeSpan? ReceivedToEndDuration { get; init; }
23.224.5.19.1. Property Value
23.224.5.20. ReceptionDate
Date when the task is received by the polling agent
public DateTime? ReceptionDate { get; init; }
23.224.5.20.1. Property Value
23.224.5.21. RemainingDataDependencies
List of dependencies that are not yet satisfied
public IDictionary<string, bool> RemainingDataDependencies { get; init; }
23.224.5.21.1. Property Value
23.224.5.22. RetryOfIds
List of previous tasks ids before the current retry
public IList<string> RetryOfIds { get; init; }
23.224.5.22.1. Property Value
23.224.5.23. SessionId
Unique identifier of the session in which the task belongs
public string SessionId { get; init; }
23.224.5.23.1. Property Value
23.224.5.24. StartDate
Date when the task execution begins
public DateTime? StartDate { get; init; }
23.224.5.24.1. Property Value
23.224.5.25. Status
Current status of the task
public TaskStatus Status { get; init; }
23.224.5.25.1. Property Value
23.224.5.26. StatusMessage
Message associated to the status
public string StatusMessage { get; init; }
23.224.5.26.1. Property Value
23.224.5.27. SubmittedDate
Date when the task is submitted
public DateTime? SubmittedDate { get; init; }
23.224.5.27.1. Property Value
23.224.5.28. TaskId
Unique identifier of the task
public string TaskId { get; init; }
23.224.5.28.1. Property Value
23.224.6. Methods
23.224.6.1. RetryId()
Compute the Id of the new task if this task should be retried Should be deterministic as it can be called several time
public string RetryId()
23.224.6.1.1. Returns
Id of the retried task
23.224.7. Operators
23.224.7.1. implicit operator Application(TaskData)
Conversion operator from
public static implicit operator Application(TaskData taskData)
23.224.7.1.1. Parameters
taskData TaskData
The input task data
23.224.7.1.2. Returns
The converted task data