Class SessionRaw

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

A raw session object.

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

Inheritance

object ← SessionRaw

Implements

IMessage<SessionRaw>, IEquatable<SessionRaw>, IDeepCloneable<SessionRaw>, IBufferMessage, IMessage

Inherited Members

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

Constructors

SessionRaw()

public SessionRaw()

SessionRaw(SessionRaw)

public SessionRaw(SessionRaw other)

Parameters

other SessionRaw

Fields

CancelledAtFieldNumber

Field number for the “cancelled_at” field.

public const int CancelledAtFieldNumber = 6

Field Value

int

ClientSubmissionFieldNumber

Field number for the “client_submission” field.

public const int ClientSubmissionFieldNumber = 8

Field Value

int

ClosedAtFieldNumber

Field number for the “closed_at” field.

public const int ClosedAtFieldNumber = 12

Field Value

int

CreatedAtFieldNumber

Field number for the “created_at” field.

public const int CreatedAtFieldNumber = 5

Field Value

int

DeletedAtFieldNumber

Field number for the “deleted_at” field.

public const int DeletedAtFieldNumber = 11

Field Value

int

DurationFieldNumber

Field number for the “duration” field.

public const int DurationFieldNumber = 7

Field Value

int

OptionsFieldNumber

Field number for the “options” field.

public const int OptionsFieldNumber = 4

Field Value

int

PartitionIdsFieldNumber

Field number for the “partition_ids” field.

public const int PartitionIdsFieldNumber = 3

Field Value

int

PurgedAtFieldNumber

Field number for the “purged_at” field.

public const int PurgedAtFieldNumber = 10

Field Value

int

SessionIdFieldNumber

Field number for the “session_id” field.

public const int SessionIdFieldNumber = 1

Field Value

int

StatusFieldNumber

Field number for the “status” field.

public const int StatusFieldNumber = 2

Field Value

int

WorkerSubmissionFieldNumber

Field number for the “worker_submission” field.

public const int WorkerSubmissionFieldNumber = 9

Field Value

int

Properties

CancelledAt

The cancellation date. Only set when status is ‘cancelled’.

public Timestamp CancelledAt { get; set; }

Property Value

Timestamp

ClientSubmission

Whether clients can submit tasks in the session.

public bool ClientSubmission { get; set; }

Property Value

bool

ClosedAt

The closure date. Only set when status is ‘closed’.

public Timestamp ClosedAt { get; set; }

Property Value

Timestamp

CreatedAt

The creation date.

public Timestamp CreatedAt { get; set; }

Property Value

Timestamp

DeletedAt

The deletion date. Only set when status is ‘deleted’.

public Timestamp DeletedAt { get; set; }

Property Value

Timestamp

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Duration

The duration. Only set when status is ‘cancelled’ and ‘closed’.

public Duration Duration { get; set; }

Property Value

Duration

Options

The task options. In fact, these are used as default value in child tasks.

public TaskOptions Options { get; set; }

Property Value

TaskOptions

Parser

public static MessageParser<SessionRaw> Parser { get; }

Property Value

MessageParser<SessionRaw>

PartitionIds

The partition IDs.

public RepeatedField<string> PartitionIds { get; }

Property Value

RepeatedField<string>

PurgedAt

The purge date. Only set when status is ‘purged’.

public Timestamp PurgedAt { get; set; }

Property Value

Timestamp

SessionId

The session ID.

public string SessionId { get; set; }

Property Value

string

Status

The session status.

public SessionStatus Status { get; set; }

Property Value

SessionStatus

WorkerSubmission

Whether workers can submit tasks in the session.

public bool WorkerSubmission { get; set; }

Property Value

bool

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

Returns

SessionRaw

A deep clone of this object.

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

Equals(SessionRaw)

public bool Equals(SessionRaw other)

Parameters

other SessionRaw

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(SessionRaw)

Merges the given message into this one.

public void MergeFrom(SessionRaw other)

Parameters

other SessionRaw

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.