Class PollWorkflowTaskQueueRequest

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

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

Inheritance

object

PollWorkflowTaskQueueRequest

Implements

IMessage<PollWorkflowTaskQueueRequest>

IEquatable<PollWorkflowTaskQueueRequest>

IDeepCloneable<PollWorkflowTaskQueueRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

PollWorkflowTaskQueueRequest()

public PollWorkflowTaskQueueRequest()

PollWorkflowTaskQueueRequest(PollWorkflowTaskQueueRequest)

public PollWorkflowTaskQueueRequest(PollWorkflowTaskQueueRequest other)

Parameters

other PollWorkflowTaskQueueRequest

Fields

BinaryChecksumFieldNumber

Field number for the "binary_checksum" field.

public const int BinaryChecksumFieldNumber = 4

Field Value

int

DeploymentOptionsFieldNumber

Field number for the "deployment_options" field.

public const int DeploymentOptionsFieldNumber = 6

Field Value

int

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

TaskQueueFieldNumber

Field number for the "task_queue" field.

public const int TaskQueueFieldNumber = 2

Field Value

int

WorkerHeartbeatFieldNumber

Field number for the "worker_heartbeat" field.

public const int WorkerHeartbeatFieldNumber = 7

Field Value

int

WorkerVersionCapabilitiesFieldNumber

Field number for the "worker_version_capabilities" field.

public const int WorkerVersionCapabilitiesFieldNumber = 5

Field Value

int

Properties

BinaryChecksum

Deprecated. Use deployment_options instead. Each worker process should provide an ID unique to the specific set of code it is running "checksum" in this field name isn't very accurate, it should be though of as an id.

[Obsolete]
public string BinaryChecksum { get; set; }

Property Value

string

DeploymentOptions

Worker deployment options that user has set in the worker. Experimental. Worker Deployments are experimental and might significantly change in the future.

public WorkerDeploymentOptions DeploymentOptions { get; set; }

Property Value

WorkerDeploymentOptions

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Identity

The identity of the worker/client who is polling this task queue

public string Identity { get; set; }

Property Value

string

Namespace

public string Namespace { get; set; }

Property Value

string

Parser

public static MessageParser<PollWorkflowTaskQueueRequest> Parser { get; }

Property Value

MessageParser<PollWorkflowTaskQueueRequest>

TaskQueue

public TaskQueue TaskQueue { get; set; }

Property Value

TaskQueue

WorkerHeartbeat

Worker info to be sent to the server.

public WorkerHeartbeat WorkerHeartbeat { get; set; }

Property Value

WorkerHeartbeat

WorkerVersionCapabilities

Deprecated. Use deployment_options instead. Information about this worker's build identifier and if it is choosing to use the versioning feature. See the WorkerVersionCapabilities docstring for more.

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

Property Value

WorkerVersionCapabilities

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

Returns

PollWorkflowTaskQueueRequest

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

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

public bool Equals(PollWorkflowTaskQueueRequest other)

Parameters

other PollWorkflowTaskQueueRequest

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

Merges the given message into this one.

public void MergeFrom(PollWorkflowTaskQueueRequest other)

Parameters

other PollWorkflowTaskQueueRequest

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.