Class ResultRaw

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

A raw result object.

Used when a list or a single result is returned.

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

Inheritance

object ← ResultRaw

Implements

IMessage<ResultRaw>, IEquatable<ResultRaw>, IDeepCloneable<ResultRaw>, IBufferMessage, IMessage

Inherited Members

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

Constructors

ResultRaw()

public ResultRaw()

ResultRaw(ResultRaw)

public ResultRaw(ResultRaw other)

Parameters

other ResultRaw

Fields

CompletedAtFieldNumber

Field number for the “completed_at” field.

public const int CompletedAtFieldNumber = 6

Field Value

int

CreatedAtFieldNumber

Field number for the “created_at” field.

public const int CreatedAtFieldNumber = 5

Field Value

int

CreatedByFieldNumber

Field number for the “created_by” field.

public const int CreatedByFieldNumber = 10

Field Value

int

ManualDeletionFieldNumber

Field number for the “manual_deletion” field.

public const int ManualDeletionFieldNumber = 12

Field Value

int

NameFieldNumber

Field number for the “name” field.

public const int NameFieldNumber = 2

Field Value

int

OpaqueIdFieldNumber

Field number for the “opaque_id” field.

public const int OpaqueIdFieldNumber = 11

Field Value

int

OwnerTaskIdFieldNumber

Field number for the “owner_task_id” field.

public const int OwnerTaskIdFieldNumber = 3

Field Value

int

ResultIdFieldNumber

Field number for the “result_id” field.

public const int ResultIdFieldNumber = 8

Field Value

int

SessionIdFieldNumber

Field number for the “session_id” field.

public const int SessionIdFieldNumber = 1

Field Value

int

SizeFieldNumber

Field number for the “size” field.

public const int SizeFieldNumber = 9

Field Value

int

StatusFieldNumber

Field number for the “status” field.

public const int StatusFieldNumber = 4

Field Value

int

Properties

CompletedAt

The result completion date.

public Timestamp CompletedAt { get; set; }

Property Value

Timestamp

CreatedAt

The result creation date.

public Timestamp CreatedAt { get; set; }

Property Value

Timestamp

CreatedBy

The ID of the Task that as submitted this result.

public string CreatedBy { get; set; }

Property Value

string

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

ManualDeletion

If the user is responsible for the deletion of the data in the underlying object storage.

public bool ManualDeletion { get; set; }

Property Value

bool

Name

The result name. Given by the client.

public string Name { get; set; }

Property Value

string

OpaqueId

ID of the data in the underlying object storage.

public ByteString OpaqueId { get; set; }

Property Value

ByteString

OwnerTaskId

The owner task ID.

public string OwnerTaskId { get; set; }

Property Value

string

Parser

public static MessageParser<ResultRaw> Parser { get; }

Property Value

MessageParser<ResultRaw>

ResultId

The result ID. Uniquely generated by the server.

public string ResultId { get; set; }

Property Value

string

SessionId

The session ID.

public string SessionId { get; set; }

Property Value

string

Size

The size of the Result Data.

public long Size { get; set; }

Property Value

long

Status

The result status.

public ResultStatus Status { get; set; }

Property Value

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

Returns

ResultRaw

A deep clone of this object.

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

Equals(ResultRaw)

public bool Equals(ResultRaw other)

Parameters

other ResultRaw

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(ResultRaw)

Merges the given message into this one.

public void MergeFrom(ResultRaw other)

Parameters

other ResultRaw

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.