Class StopSubmissionRequest

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

Request for stopping new tasks submissions from clients or workers in the given session.

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

Inheritance

object ← StopSubmissionRequest

Implements

IMessage<StopSubmissionRequest>, IEquatable<StopSubmissionRequest>, IDeepCloneable<StopSubmissionRequest>, IBufferMessage, IMessage

Inherited Members

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

Constructors

StopSubmissionRequest()

public StopSubmissionRequest()

StopSubmissionRequest(StopSubmissionRequest)

public StopSubmissionRequest(StopSubmissionRequest other)

Parameters

other StopSubmissionRequest

Fields

ClientFieldNumber

Field number for the “client” field.

public const int ClientFieldNumber = 2

Field Value

int

SessionIdFieldNumber

Field number for the “session_id” field.

public const int SessionIdFieldNumber = 1

Field Value

int

WorkerFieldNumber

Field number for the “worker” field.

public const int WorkerFieldNumber = 3

Field Value

int

Properties

Client

Whether to stop client submission.

public bool Client { get; set; }

Property Value

bool

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser

public static MessageParser<StopSubmissionRequest> Parser { get; }

Property Value

MessageParser<StopSubmissionRequest>

SessionId

The session ID.

public string SessionId { get; set; }

Property Value

string

Worker

Whether to stop worker submission.

public bool Worker { 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 StopSubmissionRequest Clone()

Returns

StopSubmissionRequest

A deep clone of this object.

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

Equals(StopSubmissionRequest)

public bool Equals(StopSubmissionRequest other)

Parameters

other StopSubmissionRequest

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(StopSubmissionRequest)

Merges the given message into this one.

public void MergeFrom(StopSubmissionRequest other)

Parameters

other StopSubmissionRequest

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.