Class WatchResultRequest

Namespace: ArmoniK.Api.gRPC.V1.Submitter
Assembly: ArmoniK.Api.Common.dll

Request to watch result states It contains the list of result ids you want to watch and some options to filter out some events. Chunking is achieved by sending multiple messages with different result ids. It is the responsability of the client to chunk the messages properly and avoid messages too large.

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

Inheritance

object ← WatchResultRequest

Implements

IMessage<WatchResultRequest>, IEquatable<WatchResultRequest>, IDeepCloneable<WatchResultRequest>, IBufferMessage, IMessage

Inherited Members

object.Equals(object), object.Equals(object, object), object.GetHashCode(), object.GetType(), object.ReferenceEquals(object, object), object.ToString()

Constructors

WatchResultRequest()

public WatchResultRequest()

WatchResultRequest(WatchResultRequest)

public WatchResultRequest(WatchResultRequest other)

Parameters

other WatchResultRequest

Fields

FetchStatusesFieldNumber

Field number for the “fetch_statuses” field.

public const int FetchStatusesFieldNumber = 1

Field Value

int

ResultIdsFieldNumber

Field number for the “result_ids” field.

public const int ResultIdsFieldNumber = 3

Field Value

int

WatchStatusesFieldNumber

Field number for the “watch_statuses” field.

public const int WatchStatusesFieldNumber = 2

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

FetchStatuses

list of statuses to check results against for the initial fetch

public RepeatedField<ResultStatus> FetchStatuses { get; }

Property Value

RepeatedField<ResultStatus>

Parser

public static MessageParser<WatchResultRequest> Parser { get; }

Property Value

MessageParser<WatchResultRequest>

ResultIds

result ids to fetch/watch

public RepeatedField<string> ResultIds { get; }

Property Value

RepeatedField<string>

WatchStatuses

list of statuses to check results against for the watch

public RepeatedField<ResultStatus> WatchStatuses { get; }

Property Value

RepeatedField<ResultStatus>

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

Returns

WatchResultRequest

A deep clone of this object.

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

Equals(WatchResultRequest)

public bool Equals(WatchResultRequest other)

Parameters

other WatchResultRequest

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(WatchResultRequest)

Merges the given message into this one.

public void MergeFrom(WatchResultRequest other)

Parameters

other WatchResultRequest

Remarks

See the user guide for precise merge semantics.

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.

ToString()

public override string ToString()

Returns

string

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.