Class DescribeTaskQueueResponse

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

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

Inheritance

object

DescribeTaskQueueResponse

Implements

IMessage<DescribeTaskQueueResponse>

IEquatable<DescribeTaskQueueResponse>

IDeepCloneable<DescribeTaskQueueResponse>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

DescribeTaskQueueResponse()

public DescribeTaskQueueResponse()

DescribeTaskQueueResponse(DescribeTaskQueueResponse)

public DescribeTaskQueueResponse(DescribeTaskQueueResponse other)

Parameters

other DescribeTaskQueueResponse

Fields

PollersFieldNumber

Field number for the "pollers" field.

public const int PollersFieldNumber = 1

Field Value

int

StatsFieldNumber

Field number for the "stats" field.

public const int StatsFieldNumber = 5

Field Value

int

TaskQueueStatusFieldNumber

Field number for the "task_queue_status" field.

public const int TaskQueueStatusFieldNumber = 2

Field Value

int

VersioningInfoFieldNumber

Field number for the "versioning_info" field.

public const int VersioningInfoFieldNumber = 4

Field Value

int

VersionsInfoFieldNumber

Field number for the "versions_info" field.

public const int VersionsInfoFieldNumber = 3

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser

public static MessageParser<DescribeTaskQueueResponse> Parser { get; }

Property Value

MessageParser<DescribeTaskQueueResponse>

Pollers

public RepeatedField<PollerInfo> Pollers { get; }

Property Value

RepeatedField<PollerInfo>

Stats

Statistics for the task queue. Only populated when report_stats is set to true in the request.

public TaskQueueStats Stats { get; set; }

Property Value

TaskQueueStats

TaskQueueStatus

Deprecated. Status of the task queue. Only populated when include_task_queue_status is set to true in the request.

[Obsolete]
public TaskQueueStatus TaskQueueStatus { get; set; }

Property Value

TaskQueueStatus

VersioningInfo

Specifies which Worker Deployment Version(s) Server routes this Task Queue's tasks to. When not present, it means the tasks are routed to Unversioned workers (workers with UNVERSIONED or unspecified WorkerVersioningMode.) Task Queue Versioning info is updated indirectly by calling SetWorkerDeploymentCurrentVersion and SetWorkerDeploymentRampingVersion on Worker Deployments. Note: This information is not relevant to Pinned workflow executions and their activities as they are always routed to their Pinned Deployment Version. However, new workflow executions are typically not Pinned until they complete their first task (unless they are started with a Pinned VersioningOverride or are Child Workflows of a Pinned parent).

public TaskQueueVersioningInfo VersioningInfo { get; set; }

Property Value

TaskQueueVersioningInfo

VersionsInfo

Deprecated. Only returned in ENHANCED mode. This map contains Task Queue information for each Build ID. Empty string as key value means unversioned.

[Obsolete]
public MapField<string, TaskQueueVersionInfo> VersionsInfo { get; }

Property Value

MapField<string, TaskQueueVersionInfo>

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

Returns

DescribeTaskQueueResponse

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(DescribeTaskQueueResponse)

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

public bool Equals(DescribeTaskQueueResponse other)

Parameters

other DescribeTaskQueueResponse

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(DescribeTaskQueueResponse)

Merges the given message into this one.

public void MergeFrom(DescribeTaskQueueResponse other)

Parameters

other DescribeTaskQueueResponse

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.