Class TaskDetailed

Namespace: ArmoniK.Api.gRPC.V1.Tasks
Assembly: ArmoniK.Api.Common.dll

A raw task object.

Used when a single task is returned.

public sealed class TaskDetailed : IMessage<TaskDetailed>, IEquatable<TaskDetailed>, IDeepCloneable<TaskDetailed>, IBufferMessage, IMessage

Inheritance

object ← TaskDetailed

Implements

IMessage<TaskDetailed>, IEquatable<TaskDetailed>, IDeepCloneable<TaskDetailed>, IBufferMessage, IMessage

Inherited Members

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

Constructors

TaskDetailed()

public TaskDetailed()

TaskDetailed(TaskDetailed)

public TaskDetailed(TaskDetailed other)

Parameters

other TaskDetailed

Fields

AcquiredAtFieldNumber

Field number for the “acquired_at” field.

public const int AcquiredAtFieldNumber = 19

Field Value

int

CreatedAtFieldNumber

Field number for the “created_at” field.

public const int CreatedAtFieldNumber = 11

Field Value

int

CreatedByFieldNumber

Field number for the “created_by” field.

public const int CreatedByFieldNumber = 27

Field Value

int

CreationToEndDurationFieldNumber

Field number for the “creation_to_end_duration” field.

public const int CreationToEndDurationFieldNumber = 20

Field Value

int

DataDependenciesFieldNumber

Field number for the “data_dependencies” field.

public const int DataDependenciesFieldNumber = 5

Field Value

int

EndedAtFieldNumber

Field number for the “ended_at” field.

public const int EndedAtFieldNumber = 14

Field Value

int

ExpectedOutputIdsFieldNumber

Field number for the “expected_output_ids” field.

public const int ExpectedOutputIdsFieldNumber = 6

Field Value

int

FetchedAtFieldNumber

Field number for the “fetched_at” field.

public const int FetchedAtFieldNumber = 25

Field Value

int

IdFieldNumber

Field number for the “id” field.

public const int IdFieldNumber = 1

Field Value

int

InitialTaskIdFieldNumber

Field number for the “initial_task_id” field.

public const int InitialTaskIdFieldNumber = 22

Field Value

int

OptionsFieldNumber

Field number for the “options” field.

public const int OptionsFieldNumber = 10

Field Value

int

OutputFieldNumber

Field number for the “output” field.

public const int OutputFieldNumber = 16

Field Value

int

OwnerPodIdFieldNumber

Field number for the “owner_pod_id” field.

public const int OwnerPodIdFieldNumber = 3

Field Value

int

ParentTaskIdsFieldNumber

Field number for the “parent_task_ids” field.

public const int ParentTaskIdsFieldNumber = 4

Field Value

int

PayloadIdFieldNumber

Field number for the “payload_id” field.

public const int PayloadIdFieldNumber = 26

Field Value

int

PodHostnameFieldNumber

Field number for the “pod_hostname” field.

public const int PodHostnameFieldNumber = 17

Field Value

int

PodTtlFieldNumber

Field number for the “pod_ttl” field.

public const int PodTtlFieldNumber = 15

Field Value

int

ProcessedAtFieldNumber

Field number for the “processed_at” field.

public const int ProcessedAtFieldNumber = 24

Field Value

int

ProcessingToEndDurationFieldNumber

Field number for the “processing_to_end_duration” field.

public const int ProcessingToEndDurationFieldNumber = 21

Field Value

int

ReceivedAtFieldNumber

Field number for the “received_at” field.

public const int ReceivedAtFieldNumber = 18

Field Value

int

ReceivedToEndDurationFieldNumber

Field number for the “received_to_end_duration” field.

public const int ReceivedToEndDurationFieldNumber = 23

Field Value

int

RetryOfIdsFieldNumber

Field number for the “retry_of_ids” field.

public const int RetryOfIdsFieldNumber = 7

Field Value

int

SessionIdFieldNumber

Field number for the “session_id” field.

public const int SessionIdFieldNumber = 2

Field Value

int

StartedAtFieldNumber

Field number for the “started_at” field.

public const int StartedAtFieldNumber = 13

Field Value

int

StatusFieldNumber

Field number for the “status” field.

public const int StatusFieldNumber = 8

Field Value

int

StatusMessageFieldNumber

Field number for the “status_message” field.

public const int StatusMessageFieldNumber = 9

Field Value

int

SubmittedAtFieldNumber

Field number for the “submitted_at” field.

public const int SubmittedAtFieldNumber = 12

Field Value

int

Properties

AcquiredAt

When the task is acquired by the agent.

public Timestamp AcquiredAt { get; set; }

Property Value

Timestamp

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

string

CreationToEndDuration

The task duration. Between the creation date and the end date.

public Duration CreationToEndDuration { get; set; }

Property Value

Duration

DataDependencies

The data dependencies. A task have data dependencies.

public RepeatedField<string> DataDependencies { get; }

Property Value

RepeatedField<string>

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

ExpectedOutputIds

The expected output IDs. A task have expected output IDs.

public RepeatedField<string> ExpectedOutputIds { get; }

Property Value

RepeatedField<string>

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

string

InitialTaskId

The initial task ID. Set when a task is submitted independently of retries.

public string InitialTaskId { get; set; }

Property Value

string

Options

The task options.

public TaskOptions Options { get; set; }

Property Value

TaskOptions

Output

The task output.

public TaskDetailed.Types.Output Output { get; set; }

Property Value

TaskDetailed.Types.Output

OwnerPodId

The owner pod ID.

public string OwnerPodId { get; set; }

Property Value

string

ParentTaskIds

The parent task IDs. A tasks can be a child of another task.

public RepeatedField<string> ParentTaskIds { get; }

Property Value

RepeatedField<string>

Parser

public static MessageParser<TaskDetailed> Parser { get; }

Property Value

MessageParser<TaskDetailed>

PayloadId

The ID of the Result that is used as a payload for this task.

public string PayloadId { get; set; }

Property Value

string

PodHostname

The hostname of the container running the task.

public string PodHostname { get; set; }

Property Value

string

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

RetryOfIds

The retry of IDs. When a task fail, retry will use these set of IDs.

public RepeatedField<string> RetryOfIds { get; }

Property Value

RepeatedField<string>

SessionId

The session ID. A task have only one related session but a session have many tasks.

public string SessionId { get; set; }

Property Value

string

StartedAt

The task start date.

public Timestamp StartedAt { get; set; }

Property Value

Timestamp

Status

The task status.

public TaskStatus Status { get; set; }

Property Value

TaskStatus

StatusMessage

The status message.

public string StatusMessage { get; set; }

Property Value

string

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

int

The number of bytes required to write this message to a coded output stream.

Clone()

Creates a deep clone of this object.

public TaskDetailed Clone()

Returns

TaskDetailed

A deep clone of this object.

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

Equals(TaskDetailed)

public bool Equals(TaskDetailed other)

Parameters

other TaskDetailed

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(TaskDetailed)

Merges the given message into this one.

public void MergeFrom(TaskDetailed other)

Parameters

other TaskDetailed

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

string

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.