Class ListTasksRequest

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

Request to list tasks.

Use pagination, filtering and sorting.

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

Inheritance

object ← ListTasksRequest

Implements

IMessage<ListTasksRequest>, IEquatable<ListTasksRequest>, IDeepCloneable<ListTasksRequest>, IBufferMessage, IMessage

Inherited Members

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

Constructors

ListTasksRequest()

public ListTasksRequest()

ListTasksRequest(ListTasksRequest)

public ListTasksRequest(ListTasksRequest other)

Parameters

other ListTasksRequest

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

WithErrorsFieldNumber

Field number for the “with_errors” field.

public const int WithErrorsFieldNumber = 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<ListTasksRequest> Parser { get; }

Property Value

MessageParser<ListTasksRequest>

Sort

The sort.

Must be set for every request.

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

Property Value

ListTasksRequest.Types.Sort

WithErrors

Request error message in case of error in task

public bool WithErrors { 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 ListTasksRequest Clone()

Returns

ListTasksRequest

A deep clone of this object.

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

Equals(ListTasksRequest)

public bool Equals(ListTasksRequest other)

Parameters

other ListTasksRequest

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(ListTasksRequest)

Merges the given message into this one.

public void MergeFrom(ListTasksRequest other)

Parameters

other ListTasksRequest

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.