Class EventSubscriptionRequest

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

Request to subscribe to the event stream.

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

Inheritance

object ← EventSubscriptionRequest

Implements

IMessage<EventSubscriptionRequest>, IEquatable<EventSubscriptionRequest>, IDeepCloneable<EventSubscriptionRequest>, IBufferMessage, IMessage

Inherited Members

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

Constructors

EventSubscriptionRequest()

public EventSubscriptionRequest()

EventSubscriptionRequest(EventSubscriptionRequest)

public EventSubscriptionRequest(EventSubscriptionRequest other)

Parameters

other EventSubscriptionRequest

Fields

ResultsFiltersFieldNumber

Field number for the “results_filters” field.

public const int ResultsFiltersFieldNumber = 3

Field Value

int

ReturnedEventsFieldNumber

Field number for the “returned_events” field.

public const int ReturnedEventsFieldNumber = 4

Field Value

int

SessionIdFieldNumber

Field number for the “session_id” field.

public const int SessionIdFieldNumber = 1

Field Value

int

TasksFiltersFieldNumber

Field number for the “tasks_filters” field.

public const int TasksFiltersFieldNumber = 2

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Parser

public static MessageParser<EventSubscriptionRequest> Parser { get; }

Property Value

MessageParser<EventSubscriptionRequest>

ResultsFilters

Filter for result related events.

public Filters ResultsFilters { get; set; }

Property Value

Filters

ReturnedEvents

Filter the type of events to return. Empty means all.

public RepeatedField<EventsEnum> ReturnedEvents { get; }

Property Value

RepeatedField<EventsEnum>

SessionId

Id of the session that will be used to subscribe events for. *

public string SessionId { get; set; }

Property Value

string

TasksFilters

Filter for task related events.

public Filters TasksFilters { get; set; }

Property Value

Filters

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

Returns

EventSubscriptionRequest

A deep clone of this object.

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

Equals(EventSubscriptionRequest)

public bool Equals(EventSubscriptionRequest other)

Parameters

other EventSubscriptionRequest

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(EventSubscriptionRequest)

Merges the given message into this one.

public void MergeFrom(EventSubscriptionRequest other)

Parameters

other EventSubscriptionRequest

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.