Class ListResultsResponse

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

Response to list results.

Use pagination, filtering and sorting from the request. Retunr a list of raw results.

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

Inheritance

object ← ListResultsResponse

Implements

IMessage<ListResultsResponse>, IEquatable<ListResultsResponse>, IDeepCloneable<ListResultsResponse>, IBufferMessage, IMessage

Inherited Members

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

Constructors

ListResultsResponse()

public ListResultsResponse()

ListResultsResponse(ListResultsResponse)

public ListResultsResponse(ListResultsResponse other)

Parameters

other ListResultsResponse

Fields

PageFieldNumber

Field number for the “page” field.

public const int PageFieldNumber = 2

Field Value

int

PageSizeFieldNumber

Field number for the “page_size” field.

public const int PageSizeFieldNumber = 3

Field Value

int

ResultsFieldNumber

Field number for the “results” field.

public const int ResultsFieldNumber = 1

Field Value

int

TotalFieldNumber

Field number for the “total” field.

public const int TotalFieldNumber = 4

Field Value

int

Properties

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

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<ListResultsResponse> Parser { get; }

Property Value

MessageParser<ListResultsResponse>

Results

The list of raw results.

public RepeatedField<ResultRaw> Results { get; }

Property Value

RepeatedField<ResultRaw>

Total

The total number of results.

public int Total { get; set; }

Property Value

int

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

Returns

ListResultsResponse

A deep clone of this object.

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

Equals(ListResultsResponse)

public bool Equals(ListResultsResponse other)

Parameters

other ListResultsResponse

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(ListResultsResponse)

Merges the given message into this one.

public void MergeFrom(ListResultsResponse other)

Parameters

other ListResultsResponse

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.