Class ListRequest

ListRequest is the Query/List request type.

Generated

from message cosmos.orm.query.v1alpha1.ListRequest

Hierarchy

Constructors

constructor

Properties

index messageName pagination? query fields runtime typeName

Methods

equals fromBinary fromJson fromJsonString

Constructors

constructor

Properties

index

index: string = ""

index is the index fields expression used in orm definitions. If it is empty, the table's primary key is assumed.

Generated

from field: string index = 2;

messageName

messageName: string = ""

message_name is the fully-qualified message name of the ORM table being queried.

Generated

from field: string message_name = 1;

Optionalpagination

pagination?: PageRequest

pagination is the pagination request.

Generated

from field: cosmos.base.query.v1beta1.PageRequest pagination = 5;

query

query: {
    case: "prefix";
    value: ListRequest_Prefix;
} | {
    case: "range";
    value: ListRequest_Range;
} | {
    case: undefined;
    value?: undefined;
} = ...

query is the query expression corresponding to the provided index. If neither prefix nor range is specified, the query will list all the fields in the index.

Type declaration

  • case: "prefix"
  • value: ListRequest_Prefix

    prefix defines a prefix query.

    Generated

    from field: cosmos.orm.query.v1alpha1.ListRequest.Prefix prefix = 3;

Type declaration

  • case: "range"
  • value: ListRequest_Range

    range defines a range query.

    Generated

    from field: cosmos.orm.query.v1alpha1.ListRequest.Range range = 4;

Generated

from oneof cosmos.orm.query.v1alpha1.ListRequest.query

Static Readonlyfields

fields: FieldList = ...

Static Readonlyruntime

runtime: ProtoRuntime = proto3

Static ReadonlytypeName

typeName: "cosmos.orm.query.v1alpha1.ListRequest" = "cosmos.orm.query.v1alpha1.ListRequest"

Methods

Staticequals

StaticfromBinary

StaticfromJson

StaticfromJsonString

Settings

Member Visibility

On This Page

Constructors
Properties
Methods