Class ListSessionsRequest

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

Request to list sessions.

Use pagination, filtering and sorting.

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

Inheritance

object ← ListSessionsRequest

Implements

IMessage<ListSessionsRequest>, IEquatable<ListSessionsRequest>, IDeepCloneable<ListSessionsRequest>, IBufferMessage, IMessage

Inherited Members

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

Constructors

ListSessionsRequest()

public ListSessionsRequest()

ListSessionsRequest(ListSessionsRequest)

public ListSessionsRequest(ListSessionsRequest other)

Parameters

other ListSessionsRequest

Fields

FiltersFieldNumber

Field number for the “filters” field.

public const int FiltersFieldNumber = 3

Field Value

int

PageFieldNumber

Field number for the “page” field.

public const int PageFieldNumber = 1

Field Value

int

PageSizeFieldNumber

Field number for the “page_size” field.

public const int PageSizeFieldNumber = 2

Field Value

int

SortFieldNumber

Field number for the “sort” field.

public const int SortFieldNumber = 4

Field Value

int

WithTaskOptionsFieldNumber

Field number for the “with_task_options” field.

public const int WithTaskOptionsFieldNumber = 5

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

Filters

The filters.

public Filters Filters { get; set; }

Property Value

Filters

Page

The page number. Start at 0.

public int Page { get; set; }

Property Value

int

PageSize

The page size.

public int PageSize { get; set; }

Property Value

int

Parser

public static MessageParser<ListSessionsRequest> Parser { get; }

Property Value

MessageParser<ListSessionsRequest>

Sort

The sort.

Must be set for every request.

public ListSessionsRequest.Types.Sort Sort { get; set; }

Property Value

ListSessionsRequest.Types.Sort

WithTaskOptions

Flag to tell if server must return task options in summary sessions

public bool WithTaskOptions { 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 ListSessionsRequest Clone()

Returns

ListSessionsRequest

A deep clone of this object.

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

Equals(ListSessionsRequest)

public bool Equals(ListSessionsRequest other)

Parameters

other ListSessionsRequest

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(ListSessionsRequest)

Merges the given message into this one.

public void MergeFrom(ListSessionsRequest other)

Parameters

other ListSessionsRequest

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.