Class GetWorkerTaskReachabilityRequest

Namespace

Temporalio.Api.WorkflowService.V1

Assembly

Temporalio.dll

Deprecated. Use DescribeTaskQueue.

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

Inheritance

object

GetWorkerTaskReachabilityRequest

Implements

IMessage<GetWorkerTaskReachabilityRequest>

IEquatable<GetWorkerTaskReachabilityRequest>

IDeepCloneable<GetWorkerTaskReachabilityRequest>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

GetWorkerTaskReachabilityRequest()

public GetWorkerTaskReachabilityRequest()

GetWorkerTaskReachabilityRequest(GetWorkerTaskReachabilityRequest)

public GetWorkerTaskReachabilityRequest(GetWorkerTaskReachabilityRequest other)

Parameters

other GetWorkerTaskReachabilityRequest

Fields

BuildIdsFieldNumber

Field number for the "build_ids" field.

public const int BuildIdsFieldNumber = 2

Field Value

int

NamespaceFieldNumber

Field number for the "namespace" field.

public const int NamespaceFieldNumber = 1

Field Value

int

ReachabilityFieldNumber

Field number for the "reachability" field.

public const int ReachabilityFieldNumber = 4

Field Value

int

TaskQueuesFieldNumber

Field number for the "task_queues" field.

public const int TaskQueuesFieldNumber = 3

Field Value

int

Properties

BuildIds

Build ids to retrieve reachability for. An empty string will be interpreted as an unversioned worker. The number of build ids that can be queried in a single API call is limited. Open source users can adjust this limit by setting the server's dynamic config value for limit.reachabilityQueryBuildIds with the caveat that this call can strain the visibility store.

public RepeatedField<string> BuildIds { get; }

Property Value

RepeatedField<string>

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Namespace

public string Namespace { get; set; }

Property Value

string

Parser

public static MessageParser<GetWorkerTaskReachabilityRequest> Parser { get; }

Property Value

MessageParser<GetWorkerTaskReachabilityRequest>

Reachability

Type of reachability to query for. TASK_REACHABILITY_NEW_WORKFLOWS is always returned in the response. Use TASK_REACHABILITY_EXISTING_WORKFLOWS if your application needs to respond to queries on closed workflows. Otherwise, use TASK_REACHABILITY_OPEN_WORKFLOWS. Default is TASK_REACHABILITY_EXISTING_WORKFLOWS if left unspecified. See the TaskReachability docstring for information about each enum variant.

public TaskReachability Reachability { get; set; }

Property Value

TaskReachability

TaskQueues

Task queues to retrieve reachability for. Leave this empty to query for all task queues associated with given build ids in the namespace. Must specify at least one task queue if querying for an unversioned worker. The number of task queues that the server will fetch reachability information for is limited. See the GetWorkerTaskReachabilityResponse documentation for more information.

public RepeatedField<string> TaskQueues { get; }

Property Value

RepeatedField<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 GetWorkerTaskReachabilityRequest Clone()

Returns

GetWorkerTaskReachabilityRequest

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

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

public bool Equals(GetWorkerTaskReachabilityRequest other)

Parameters

other GetWorkerTaskReachabilityRequest

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

Merges the given message into this one.

public void MergeFrom(GetWorkerTaskReachabilityRequest other)

Parameters

other GetWorkerTaskReachabilityRequest

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.