Class ShutdownWorkerRequest

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

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

Inheritance

object

ShutdownWorkerRequest

Implements

IMessage<ShutdownWorkerRequest>

IEquatable<ShutdownWorkerRequest>

IDeepCloneable<ShutdownWorkerRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ShutdownWorkerRequest()

public ShutdownWorkerRequest()

ShutdownWorkerRequest(ShutdownWorkerRequest)

public ShutdownWorkerRequest(ShutdownWorkerRequest other)

Parameters

other ShutdownWorkerRequest

Fields

IdentityFieldNumber

Field number for the "identity" field.

public const int IdentityFieldNumber = 3

Field Value

int

NamespaceFieldNumber

Field number for the "namespace" field.

public const int NamespaceFieldNumber = 1

Field Value

int

ReasonFieldNumber

Field number for the "reason" field.

public const int ReasonFieldNumber = 4

Field Value

int

StickyTaskQueueFieldNumber

Field number for the "sticky_task_queue" field.

public const int StickyTaskQueueFieldNumber = 2

Field Value

int

TaskQueueFieldNumber

Field number for the "task_queue" field.

public const int TaskQueueFieldNumber = 7

Field Value

int

TaskQueueTypesFieldNumber

Field number for the "task_queue_types" field.

public const int TaskQueueTypesFieldNumber = 8

Field Value

int

WorkerHeartbeatFieldNumber

Field number for the "worker_heartbeat" field.

public const int WorkerHeartbeatFieldNumber = 5

Field Value

int

WorkerInstanceKeyFieldNumber

Field number for the "worker_instance_key" field.

public const int WorkerInstanceKeyFieldNumber = 6

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Identity

public string Identity { get; set; }

Property Value

string

Namespace

public string Namespace { get; set; }

Property Value

string

Parser

public static MessageParser<ShutdownWorkerRequest> Parser { get; }

Property Value

MessageParser<ShutdownWorkerRequest>

Reason

public string Reason { get; set; }

Property Value

string

StickyTaskQueue

sticky_task_queue may not always be populated. We want to ensure all workers send a shutdown request to update worker state for heartbeating, as well as cancel pending poll calls early, instead of waiting for timeouts.

public string StickyTaskQueue { get; set; }

Property Value

string

TaskQueue

Task queue name the worker is polling on. This allows server to cancel all outstanding poll RPC calls from SDK. This avoids a race condition that can lead to tasks being lost.

public string TaskQueue { get; set; }

Property Value

string

TaskQueueTypes

Task queue types that help server cancel outstanding poll RPC calls from SDK. This avoids a race condition that can lead to tasks being lost.

public RepeatedField<TaskQueueType> TaskQueueTypes { get; }

Property Value

RepeatedField<TaskQueueType>

WorkerHeartbeat

public WorkerHeartbeat WorkerHeartbeat { get; set; }

Property Value

WorkerHeartbeat

WorkerInstanceKey

Technically this is also sent in the WorkerHeartbeat, but since worker heartbeating can be turned off, this needs to be a separate, top-level field.

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

Returns

ShutdownWorkerRequest

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

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

public bool Equals(ShutdownWorkerRequest other)

Parameters

other ShutdownWorkerRequest

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

Merges the given message into this one.

public void MergeFrom(ShutdownWorkerRequest other)

Parameters

other ShutdownWorkerRequest

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.