Class DataRequest

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

Request to retrieve data

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

Inheritance

object ← DataRequest

Implements

IMessage<DataRequest>, IEquatable<DataRequest>, IDeepCloneable<DataRequest>, IBufferMessage, IMessage

Inherited Members

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

Constructors

DataRequest()

public DataRequest()

DataRequest(DataRequest)

public DataRequest(DataRequest other)

Parameters

other DataRequest

Fields

CommunicationTokenFieldNumber

Field number for the “communication_token” field.

public const int CommunicationTokenFieldNumber = 1

Field Value

int

ResultIdFieldNumber

Field number for the “result_id” field.

public const int ResultIdFieldNumber = 2

Field Value

int

Properties

CommunicationToken

Communication token received by the worker during task processing

public string CommunicationToken { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser

public static MessageParser<DataRequest> Parser { get; }

Property Value

MessageParser<DataRequest>

ResultId

Id of the result that will be retrieved

public string ResultId { 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 DataRequest Clone()

Returns

DataRequest

A deep clone of this object.

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

Equals(DataRequest)

public bool Equals(DataRequest other)

Parameters

other DataRequest

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(DataRequest)

Merges the given message into this one.

public void MergeFrom(DataRequest other)

Parameters

other DataRequest

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.