Class TaskQueueStats

Namespace

Temporalio.Api.TaskQueue.V1

Assembly

Temporalio.dll

For workflow task queues, we only report the normal queue stats, not sticky queues. This means the stats reported here do not count all workflow tasks. However, because the tasks queued in sticky queues only remain valid for a few seconds, the inaccuracy becomes less significant as the backlog age grows.

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

Inheritance

object

TaskQueueStats

Implements

IMessage<TaskQueueStats>

IEquatable<TaskQueueStats>

IDeepCloneable<TaskQueueStats>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

TaskQueueStats()

public TaskQueueStats()

TaskQueueStats(TaskQueueStats)

public TaskQueueStats(TaskQueueStats other)

Parameters

other TaskQueueStats

Fields

ApproximateBacklogAgeFieldNumber

Field number for the "approximate_backlog_age" field.

public const int ApproximateBacklogAgeFieldNumber = 2

Field Value

int

ApproximateBacklogCountFieldNumber

Field number for the "approximate_backlog_count" field.

public const int ApproximateBacklogCountFieldNumber = 1

Field Value

int

TasksAddRateFieldNumber

Field number for the "tasks_add_rate" field.

public const int TasksAddRateFieldNumber = 3

Field Value

int

TasksDispatchRateFieldNumber

Field number for the "tasks_dispatch_rate" field.

public const int TasksDispatchRateFieldNumber = 4

Field Value

int

Properties

ApproximateBacklogAge

Approximate age of the oldest task in the backlog based on the create timestamp of the task at the head of the queue.

public Duration ApproximateBacklogAge { get; set; }

Property Value

Duration

ApproximateBacklogCount

The approximate number of tasks backlogged in this task queue. May count expired tasks but eventually converges to the right value.

public long ApproximateBacklogCount { get; set; }

Property Value

long

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser

public static MessageParser<TaskQueueStats> Parser { get; }

Property Value

MessageParser<TaskQueueStats>

TasksAddRate

Approximate tasks per second added to the task queue based on activity within a fixed window. This includes both backlogged and sync-matched tasks.

public float TasksAddRate { get; set; }

Property Value

float

TasksDispatchRate

Approximate tasks per second dispatched to workers based on activity within a fixed window. This includes both backlogged and sync-matched tasks.

public float TasksDispatchRate { get; set; }

Property Value

float

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 TaskQueueStats Clone()

Returns

TaskQueueStats

A deep clone of this object.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object other)

Parameters

other object

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

Equals(TaskQueueStats)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(TaskQueueStats other)

Parameters

other TaskQueueStats

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

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.

MergeFrom(TaskQueueStats)

Merges the given message into this one.

public void MergeFrom(TaskQueueStats other)

Parameters

other TaskQueueStats

Remarks

See the user guide for precise merge semantics.

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

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.