Class TaskRequest

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

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

Inheritance

object ← TaskRequest

Implements

IMessage<TaskRequest>, IEquatable<TaskRequest>, IDeepCloneable<TaskRequest>, IBufferMessage, IMessage

Inherited Members

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

Constructors

TaskRequest()

public TaskRequest()

TaskRequest(TaskRequest)

public TaskRequest(TaskRequest other)

Parameters

other TaskRequest

Fields

DataDependenciesFieldNumber

Field number for the “data_dependencies” field.

public const int DataDependenciesFieldNumber = 2

Field Value

int

ExpectedOutputKeysFieldNumber

Field number for the “expected_output_keys” field.

public const int ExpectedOutputKeysFieldNumber = 1

Field Value

int

PayloadFieldNumber

Field number for the “payload” field.

public const int PayloadFieldNumber = 3

Field Value

int

PayloadNameFieldNumber

Field number for the “payload_name” field.

public const int PayloadNameFieldNumber = 4

Field Value

int

Properties

DataDependencies

IDs of the results that will be used as data dependency.

public RepeatedField<string> DataDependencies { get; }

Property Value

RepeatedField<string>

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

ExpectedOutputKeys

Given names to the expected outputs that will be created implicitly. IDs are returned after task creation

public RepeatedField<string> ExpectedOutputKeys { get; }

Property Value

RepeatedField<string>

Parser

public static MessageParser<TaskRequest> Parser { get; }

Property Value

MessageParser<TaskRequest>

Payload

Content of the payload for the task.

public ByteString Payload { get; set; }

Property Value

ByteString

PayloadName

Name that will be associated to the result created for the payload. Optionnal

public string PayloadName { 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 TaskRequest Clone()

Returns

TaskRequest

A deep clone of this object.

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

Equals(TaskRequest)

public bool Equals(TaskRequest other)

Parameters

other TaskRequest

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(TaskRequest)

Merges the given message into this one.

public void MergeFrom(TaskRequest other)

Parameters

other TaskRequest

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.