queryv1beta1

Documentation

Overview

Code generated by protoc-gen-go-pulsar. DO NOT EDIT.

Index

• Variables
• type PageRequest
  • func (*PageRequest) Descriptor() ([]byte, []int)
  • func (x *PageRequest) GetCountTotal() bool
  • func (x *PageRequest) GetKey() []byte
  • func (x *PageRequest) GetLimit() uint64
  • func (x *PageRequest) GetOffset() uint64
  • func (x *PageRequest) GetReverse() bool
  • func (*PageRequest) ProtoMessage()
  • func (x *PageRequest) ProtoReflect() protoreflect.Message
  • func (x *PageRequest) Reset()
  • func (x *PageRequest) String() string
• type PageResponse
  • func (*PageResponse) Descriptor() ([]byte, []int)
  • func (x *PageResponse) GetNextKey() []byte
  • func (x *PageResponse) GetTotal() uint64
  • func (*PageResponse) ProtoMessage()
  • func (x *PageResponse) ProtoReflect() protoreflect.Message
  • func (x *PageResponse) Reset()
  • func (x *PageResponse) String() string

Variables

var File_cosmos_base_query_v1beta1_pagination_proto protoreflect.FileDescriptor

Types

type PageRequest

type PageRequest struct {

	// key is a value returned in PageResponse.next_key to begin
	// querying the next page most efficiently. Only one of offset or key
	// should be set.
	Key []byte `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// offset is a numeric offset that can be used when key is unavailable.
	// It is less efficient than using key. Only one of offset or key should
	// be set.
	Offset uint64 `protobuf:"varint,2,opt,name=offset,proto3" json:"offset,omitempty"`
	// limit is the total number of results to be returned in the result page.
	// If left empty it will default to a value to be set by each app.
	Limit uint64 `protobuf:"varint,3,opt,name=limit,proto3" json:"limit,omitempty"`
	// count_total is set to true  to indicate that the result set should include
	// a count of the total number of items available for pagination in UIs.
	// count_total is only respected when offset is used. It is ignored when key
	// is set.
	CountTotal bool `protobuf:"varint,4,opt,name=count_total,json=countTotal,proto3" json:"count_total,omitempty"`
	// reverse is set to true if results are to be returned in the descending order.
	Reverse bool `protobuf:"varint,5,opt,name=reverse,proto3" json:"reverse,omitempty"`
	// contains filtered or unexported fields
}

PageRequest is to be embedded in gRPC request messages for efficient pagination. Ex:

message SomeRequest {
        Foo some_parameter = 1;
        PageRequest pagination = 2;
}

func (*PageRequest) Descriptor

func (*PageRequest) Descriptor() ([]byte, []int)

Deprecated: Use PageRequest.ProtoReflect.Descriptor instead.

func (*PageRequest) GetCountTotal

func (x *PageRequest) GetCountTotal() bool

func (*PageRequest) GetKey

func (x *PageRequest) GetKey() []byte

func (*PageRequest) GetLimit

func (x *PageRequest) GetLimit() uint64

func (*PageRequest) GetOffset

func (x *PageRequest) GetOffset() uint64

func (*PageRequest) GetReverse

func (x *PageRequest) GetReverse() bool

func (*PageRequest) ProtoMessage

func (*PageRequest) ProtoMessage()

func (*PageRequest) ProtoReflect

func (x *PageRequest) ProtoReflect() protoreflect.Message

func (*PageRequest) Reset

func (x *PageRequest) Reset()

func (*PageRequest) String

func (x *PageRequest) String() string

type PageResponse

type PageResponse struct {

	// next_key is the key to be passed to PageRequest.key to
	// query the next page most efficiently. It will be empty if
	// there are no more results.
	NextKey []byte `protobuf:"bytes,1,opt,name=next_key,json=nextKey,proto3" json:"next_key,omitempty"`
	// total is total number of results available if PageRequest.count_total
	// was set, its value is undefined otherwise
	Total uint64 `protobuf:"varint,2,opt,name=total,proto3" json:"total,omitempty"`
	// contains filtered or unexported fields
}

PageResponse is to be embedded in gRPC response messages where the corresponding request message has used PageRequest.

message SomeResponse {
        repeated Bar results = 1;
        PageResponse page = 2;
}

func (*PageResponse) Descriptor

func (*PageResponse) Descriptor() ([]byte, []int)

Deprecated: Use PageResponse.ProtoReflect.Descriptor instead.

func (*PageResponse) GetNextKey

func (x *PageResponse) GetNextKey() []byte

func (*PageResponse) GetTotal

func (x *PageResponse) GetTotal() uint64

func (*PageResponse) ProtoMessage

func (*PageResponse) ProtoMessage()

func (*PageResponse) ProtoReflect

func (x *PageResponse) ProtoReflect() protoreflect.Message

func (*PageResponse) Reset

func (x *PageResponse) Reset()

func (*PageResponse) String

func (x *PageResponse) String() string