Class TaskSummary
Namespace: ArmoniK.Api.gRPC.V1.Tasks
Assembly: ArmoniK.Api.Common.dll
A summary task object.
It contains only a subset of the fields from the underlying task object. Used when a list of tasks are returned.
public sealed class TaskSummary : IMessage<TaskSummary>, IEquatable<TaskSummary>, IDeepCloneable<TaskSummary>, IBufferMessage, IMessage
Inheritance
Implements
IMessage<TaskSummary>, IEquatable<TaskSummary>, IDeepCloneable<TaskSummary>, IBufferMessage, IMessage
Inherited Members
object.Equals(object), object.Equals(object, object), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object, object), object.ToString()
Constructors
TaskSummary()
public TaskSummary()
TaskSummary(TaskSummary)
public TaskSummary(TaskSummary other)
Parameters
other TaskSummary
Fields
AcquiredAtFieldNumber
Field number for the “acquired_at” field.
public const int AcquiredAtFieldNumber = 19
Field Value
CountDataDependenciesFieldNumber
Field number for the “count_data_dependencies” field.
public const int CountDataDependenciesFieldNumber = 11
Field Value
CountExpectedOutputIdsFieldNumber
Field number for the “count_expected_output_ids” field.
public const int CountExpectedOutputIdsFieldNumber = 13
Field Value
CountParentTaskIdsFieldNumber
Field number for the “count_parent_task_ids” field.
public const int CountParentTaskIdsFieldNumber = 21
Field Value
CountRetryOfIdsFieldNumber
Field number for the “count_retry_of_ids” field.
public const int CountRetryOfIdsFieldNumber = 14
Field Value
CreatedAtFieldNumber
Field number for the “created_at” field.
public const int CreatedAtFieldNumber = 5
Field Value
CreatedByFieldNumber
Field number for the “created_by” field.
public const int CreatedByFieldNumber = 27
Field Value
CreationToEndDurationFieldNumber
Field number for the “creation_to_end_duration” field.
public const int CreationToEndDurationFieldNumber = 15
Field Value
EndedAtFieldNumber
Field number for the “ended_at” field.
public const int EndedAtFieldNumber = 7
Field Value
ErrorFieldNumber
Field number for the “error” field.
public const int ErrorFieldNumber = 8
Field Value
FetchedAtFieldNumber
Field number for the “fetched_at” field.
public const int FetchedAtFieldNumber = 25
Field Value
IdFieldNumber
Field number for the “id” field.
public const int IdFieldNumber = 1
Field Value
InitialTaskIdFieldNumber
Field number for the “initial_task_id” field.
public const int InitialTaskIdFieldNumber = 22
Field Value
OptionsFieldNumber
Field number for the “options” field.
public const int OptionsFieldNumber = 3
Field Value
OwnerPodIdFieldNumber
Field number for the “owner_pod_id” field.
public const int OwnerPodIdFieldNumber = 10
Field Value
PayloadIdFieldNumber
Field number for the “payload_id” field.
public const int PayloadIdFieldNumber = 26
Field Value
PodHostnameFieldNumber
Field number for the “pod_hostname” field.
public const int PodHostnameFieldNumber = 17
Field Value
PodTtlFieldNumber
Field number for the “pod_ttl” field.
public const int PodTtlFieldNumber = 20
Field Value
ProcessedAtFieldNumber
Field number for the “processed_at” field.
public const int ProcessedAtFieldNumber = 23
Field Value
ProcessingToEndDurationFieldNumber
Field number for the “processing_to_end_duration” field.
public const int ProcessingToEndDurationFieldNumber = 16
Field Value
ReceivedAtFieldNumber
Field number for the “received_at” field.
public const int ReceivedAtFieldNumber = 18
Field Value
ReceivedToEndDurationFieldNumber
Field number for the “received_to_end_duration” field.
public const int ReceivedToEndDurationFieldNumber = 24
Field Value
SessionIdFieldNumber
Field number for the “session_id” field.
public const int SessionIdFieldNumber = 2
Field Value
StartedAtFieldNumber
Field number for the “started_at” field.
public const int StartedAtFieldNumber = 6
Field Value
StatusFieldNumber
Field number for the “status” field.
public const int StatusFieldNumber = 4
Field Value
StatusMessageFieldNumber
Field number for the “status_message” field.
public const int StatusMessageFieldNumber = 9
Field Value
SubmittedAtFieldNumber
Field number for the “submitted_at” field.
public const int SubmittedAtFieldNumber = 12
Field Value
Properties
AcquiredAt
When the task is acquired by the agent.
public Timestamp AcquiredAt { get; set; }
Property Value
Timestamp
CountDataDependencies
Count the data dependencies. A task have data dependencies.
public long CountDataDependencies { get; set; }
Property Value
CountExpectedOutputIds
Count the expected output IDs. A task have expected output IDs.
public long CountExpectedOutputIds { get; set; }
Property Value
CountParentTaskIds
Count the parent task IDs. A tasks can be a child of another task.
public long CountParentTaskIds { get; set; }
Property Value
CountRetryOfIds
Count the retry of IDs. When a task fail, retry will use these set of IDs.
public long CountRetryOfIds { get; set; }
Property Value
CreatedAt
The task creation date.
public Timestamp CreatedAt { get; set; }
Property Value
Timestamp
CreatedBy
The ID of the Task that as submitted this task empty if none.
public string CreatedBy { get; set; }
Property Value
CreationToEndDuration
The task duration. Between the creation date and the end date.
public Duration CreationToEndDuration { get; set; }
Property Value
Duration
Descriptor
public static MessageDescriptor Descriptor { get; }
Property Value
MessageDescriptor
EndedAt
The task end date. Also used when task failed.
public Timestamp EndedAt { get; set; }
Property Value
Timestamp
Error
The error message. Only set if task have failed.
public string Error { get; set; }
Property Value
FetchedAt
Task data retrieval end date.
public Timestamp FetchedAt { get; set; }
Property Value
Timestamp
Id
The task ID.
public string Id { get; set; }
Property Value
InitialTaskId
The initial task ID. Set when a task is submitted independently of retries.
public string InitialTaskId { get; set; }
Property Value
Options
The task options.
public TaskOptions Options { get; set; }
Property Value
OwnerPodId
The owner pod ID.
public string OwnerPodId { get; set; }
Property Value
Parser
public static MessageParser<TaskSummary> Parser { get; }
Property Value
MessageParser<TaskSummary>
PayloadId
The ID of the Result that is used as a payload for this task.
public string PayloadId { get; set; }
Property Value
PodHostname
The hostname of the container running the task.
public string PodHostname { get; set; }
Property Value
PodTtl
The pod TTL (Time To Live).
public Timestamp PodTtl { get; set; }
Property Value
Timestamp
ProcessedAt
The end of task processing date.
public Timestamp ProcessedAt { get; set; }
Property Value
Timestamp
ProcessingToEndDuration
The task calculated duration. Between the start date and the end date.
public Duration ProcessingToEndDuration { get; set; }
Property Value
Duration
ReceivedAt
When the task is received by the agent.
public Timestamp ReceivedAt { get; set; }
Property Value
Timestamp
ReceivedToEndDuration
The task calculated duration. Between the received date and the end date.
public Duration ReceivedToEndDuration { get; set; }
Property Value
Duration
SessionId
The session ID. A task have only one related session but a session have many tasks.
public string SessionId { get; set; }
Property Value
StartedAt
The task start date.
public Timestamp StartedAt { get; set; }
Property Value
Timestamp
Status
The task status.
public TaskStatus Status { get; set; }
Property Value
StatusMessage
The status message.
public string StatusMessage { get; set; }
Property Value
SubmittedAt
The task submission date.
public Timestamp SubmittedAt { get; set; }
Property Value
Timestamp
Methods
CalculateSize()
Calculates the size of this message in Protocol Buffer wire format, in bytes.
public int CalculateSize()
Returns
The number of bytes required to write this message to a coded output stream.
Clone()
Creates a deep clone of this object.
public TaskSummary Clone()
Returns
A deep clone of this object.
Equals(object)
public override bool Equals(object other)
Parameters
other object
Returns
Equals(TaskSummary)
public bool Equals(TaskSummary other)
Parameters
other TaskSummary
Returns
GetHashCode()
public override int GetHashCode()
Returns
MergeFrom(TaskSummary)
Merges the given message into this one.
public void MergeFrom(TaskSummary other)
Parameters
other TaskSummary
Remarks
See the user guide for precise merge semantics.
MergeFrom(CodedInputStream)
Merges the data from the specified coded input stream with the current message.
public void MergeFrom(CodedInputStream input)
Parameters
input CodedInputStream
Remarks
See the user guide for precise merge semantics.
ToString()
public override string ToString()
Returns
WriteTo(CodedOutputStream)
Writes the data to the given coded output stream.
public void WriteTo(CodedOutputStream output)
Parameters
output CodedOutputStream
Coded output stream to write the data to. Must not be null.