Class WorkerListInfo

Namespace

Temporalio.Api.Worker.V1

Assembly

Temporalio.dll

Limited worker information returned in the list response. When adding fields here, ensure that it is also added to WorkerInfo (as it carries the full worker information).

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

Inheritance

object

WorkerListInfo

Implements

IMessage<WorkerListInfo>

IEquatable<WorkerListInfo>

IDeepCloneable<WorkerListInfo>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

WorkerListInfo()

public WorkerListInfo()

WorkerListInfo(WorkerListInfo)

public WorkerListInfo(WorkerListInfo other)

Parameters

other WorkerListInfo

Fields

DeploymentVersionFieldNumber

Field number for the "deployment_version" field.

public const int DeploymentVersionFieldNumber = 4

Field Value

int

DriversFieldNumber

Field number for the "drivers" field.

public const int DriversFieldNumber = 13

Field Value

int

HostNameFieldNumber

Field number for the "host_name" field.

public const int HostNameFieldNumber = 9

Field Value

int

PluginsFieldNumber

Field number for the "plugins" field.

public const int PluginsFieldNumber = 12

Field Value

int

ProcessIdFieldNumber

Field number for the "process_id" field.

public const int ProcessIdFieldNumber = 11

Field Value

int

SdkNameFieldNumber

Field number for the "sdk_name" field.

public const int SdkNameFieldNumber = 5

Field Value

int

SdkVersionFieldNumber

Field number for the "sdk_version" field.

public const int SdkVersionFieldNumber = 6

Field Value

int

StartTimeFieldNumber

Field number for the "start_time" field.

public const int StartTimeFieldNumber = 8

Field Value

int

StatusFieldNumber

Field number for the "status" field.

public const int StatusFieldNumber = 7

Field Value

int

TaskQueueFieldNumber

Field number for the "task_queue" field.

public const int TaskQueueFieldNumber = 3

Field Value

int

WorkerGroupingKeyFieldNumber

Field number for the "worker_grouping_key" field.

public const int WorkerGroupingKeyFieldNumber = 10

Field Value

int

WorkerIdentityFieldNumber

Field number for the "worker_identity" field.

public const int WorkerIdentityFieldNumber = 2

Field Value

int

WorkerInstanceKeyFieldNumber

Field number for the "worker_instance_key" field.

public const int WorkerInstanceKeyFieldNumber = 1

Field Value

int

Properties

DeploymentVersion

public WorkerDeploymentVersion DeploymentVersion { get; set; }

Property Value

WorkerDeploymentVersion

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Drivers

Storage drivers in use by this SDK.

public RepeatedField<StorageDriverInfo> Drivers { get; }

Property Value

RepeatedField<StorageDriverInfo>

HostName

Worker host identifier.

public string HostName { get; set; }

Property Value

string

Parser

public static MessageParser<WorkerListInfo> Parser { get; }

Property Value

MessageParser<WorkerListInfo>

Plugins

Plugins currently in use by this SDK.

public RepeatedField<PluginInfo> Plugins { get; }

Property Value

RepeatedField<PluginInfo>

ProcessId

Worker process identifier. This id only needs to be unique within one host (so using e.g. a unix pid would be appropriate).

public string ProcessId { get; set; }

Property Value

string

SdkName

public string SdkName { get; set; }

Property Value

string

SdkVersion

public string SdkVersion { get; set; }

Property Value

string

StartTime

Worker start time. It can be used to determine worker uptime. (current time - start time)

public Timestamp StartTime { get; set; }

Property Value

Timestamp

Status

Worker status. Defined by SDK.

public WorkerStatus Status { get; set; }

Property Value

WorkerStatus

TaskQueue

Task queue this worker is polling for tasks.

public string TaskQueue { get; set; }

Property Value

string

WorkerGroupingKey

Worker grouping identifier. A key to group workers that share the same client+namespace+process. This will be used to build the worker command nexus task queue name: "temporal-sys/worker-commands/{worker_grouping_key}"

public string WorkerGroupingKey { get; set; }

Property Value

string

WorkerIdentity

Worker identity, set by the client, may not be unique. Usually host_name+(user group name)+process_id, but can be overwritten by the user.

public string WorkerIdentity { get; set; }

Property Value

string

WorkerInstanceKey

Worker identifier, should be unique for the namespace. It is distinct from worker identity, which is not necessarily namespace-unique.

public string WorkerInstanceKey { get; set; }

Property Value

string

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

Returns

WorkerListInfo

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

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

public bool Equals(WorkerListInfo other)

Parameters

other WorkerListInfo

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

Merges the given message into this one.

public void MergeFrom(WorkerListInfo other)

Parameters

other WorkerListInfo

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.