Table of Contents

Class ListWorkersRequest

Namespace
Temporalio.Api.WorkflowService.V1
Assembly
Temporalio.dll
public sealed class ListWorkersRequest : IMessage<ListWorkersRequest>, IEquatable<ListWorkersRequest>, IDeepCloneable<ListWorkersRequest>, IBufferMessage, IMessage
Inheritance
ListWorkersRequest
Implements
IDeepCloneable<ListWorkersRequest>
IBufferMessage
IMessage
Inherited Members

Constructors

ListWorkersRequest() 

public ListWorkersRequest()

ListWorkersRequest(ListWorkersRequest) 

public ListWorkersRequest(ListWorkersRequest other)

Parameters

other ListWorkersRequest

Fields

NamespaceFieldNumber

Field number for the "namespace" field.

public const int NamespaceFieldNumber = 1

Field Value

int

NextPageTokenFieldNumber

Field number for the "next_page_token" field.

public const int NextPageTokenFieldNumber = 3

Field Value

int

PageSizeFieldNumber

Field number for the "page_size" field.

public const int PageSizeFieldNumber = 2

Field Value

int

QueryFieldNumber

Field number for the "query" field.

public const int QueryFieldNumber = 4

Field Value

int

Properties

Descriptor 

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Namespace 

public string Namespace { get; set; }

Property Value

string

NextPageToken 

public ByteString NextPageToken { get; set; }

Property Value

ByteString

PageSize 

public int PageSize { get; set; }

Property Value

int

Parser 

public static MessageParser<ListWorkersRequest> Parser { get; }

Property Value

MessageParser<ListWorkersRequest>

Query

query in ListWorkers is used to filter workers based on worker status info. The following worker status attributes are expected are supported as part of the query:

  • WorkerInstanceKey
  • WorkerIdentity
  • HostName
  • TaskQueue
  • DeploymentName
  • BuildId
  • SdkName
  • SdkVersion
  • StartTime
  • LastHeartbeatTime
  • Status Currently metrics are not supported as a part of ListWorkers query.
public string Query { 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 ListWorkersRequest Clone()

Returns

ListWorkersRequest

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

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

public bool Equals(ListWorkersRequest other)

Parameters

other ListWorkersRequest

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

Merges the given message into this one.

public void MergeFrom(ListWorkersRequest other)

Parameters

other ListWorkersRequest

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.