pagination

package
v0.0.47 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 10, 2024 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	SortOrder_name = map[int32]string{
		0: "UNSORTED",
		1: "ASCENDING",
		2: "DESCENDING",
	}
	SortOrder_value = map[string]int32{
		"UNSORTED":   0,
		"ASCENDING":  1,
		"DESCENDING": 2,
	}
)

Enum value maps for SortOrder.

View Source
var File_pagination_pagination_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type PagingRequest

type PagingRequest struct {

	// Current page
	Current *int32 `protobuf:"varint,1,opt,name=current,proto3,oneof" json:"current,omitempty"`
	// The number of lines per page
	PageSize *int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3,oneof" json:"page_size,omitempty"`
	// Query parameter
	Query map[string]*structpb.ListValue `` /* 151-byte string literal not displayed */
	// Sort
	OrderBy map[string]SortOrder `` /* 197-byte string literal not displayed */
	// Whether not paging
	NoPaging *bool `protobuf:"varint,5,opt,name=no_paging,json=noPaging,proto3,oneof" json:"no_paging,omitempty"`
	// contains filtered or unexported fields
}

Paging general request

func (*PagingRequest) Descriptor deprecated

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

Deprecated: Use PagingRequest.ProtoReflect.Descriptor instead.

func (*PagingRequest) GetCurrent

func (x *PagingRequest) GetCurrent() int32

func (*PagingRequest) GetNoPaging

func (x *PagingRequest) GetNoPaging() bool

func (*PagingRequest) GetOrderBy

func (x *PagingRequest) GetOrderBy() map[string]SortOrder

func (*PagingRequest) GetPageSize

func (x *PagingRequest) GetPageSize() int32

func (*PagingRequest) GetQuery

func (x *PagingRequest) GetQuery() map[string]*structpb.ListValue

func (*PagingRequest) ProtoMessage

func (*PagingRequest) ProtoMessage()

func (*PagingRequest) ProtoReflect

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

func (*PagingRequest) Reset

func (x *PagingRequest) Reset()

func (*PagingRequest) String

func (x *PagingRequest) String() string

type PagingRequest_QueryParam

type PagingRequest_QueryParam struct {
	Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

Query parameters

func (*PagingRequest_QueryParam) Descriptor deprecated

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

Deprecated: Use PagingRequest_QueryParam.ProtoReflect.Descriptor instead.

func (*PagingRequest_QueryParam) GetValues

func (x *PagingRequest_QueryParam) GetValues() []string

func (*PagingRequest_QueryParam) ProtoMessage

func (*PagingRequest_QueryParam) ProtoMessage()

func (*PagingRequest_QueryParam) ProtoReflect

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

func (*PagingRequest_QueryParam) Reset

func (x *PagingRequest_QueryParam) Reset()

func (*PagingRequest_QueryParam) String

func (x *PagingRequest_QueryParam) String() string

type PagingResponse

type PagingResponse struct {
	Success bool                       `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"`
	Total   int32                      `protobuf:"varint,2,opt,name=total,proto3" json:"total,omitempty"`
	Data    *PagingResponse_PagingData `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
	Error   *rpcerr.Error              `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"`
	Extra   *anypb.Any                 `protobuf:"bytes,5,opt,name=extra,proto3" json:"extra,omitempty"`
	// contains filtered or unexported fields
}

Paging general result

func (*PagingResponse) Descriptor deprecated

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

Deprecated: Use PagingResponse.ProtoReflect.Descriptor instead.

func (*PagingResponse) GetData

func (*PagingResponse) GetError

func (x *PagingResponse) GetError() *rpcerr.Error

func (*PagingResponse) GetExtra

func (x *PagingResponse) GetExtra() *anypb.Any

func (*PagingResponse) GetSuccess

func (x *PagingResponse) GetSuccess() bool

func (*PagingResponse) GetTotal

func (x *PagingResponse) GetTotal() int32

func (*PagingResponse) ProtoMessage

func (*PagingResponse) ProtoMessage()

func (*PagingResponse) ProtoReflect

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

func (*PagingResponse) Reset

func (x *PagingResponse) Reset()

func (*PagingResponse) String

func (x *PagingResponse) String() string

type PagingResponse_PagingData

type PagingResponse_PagingData struct {

	// Total number of records
	Total int32 `protobuf:"varint,1,opt,name=total,proto3" json:"total,omitempty"`
	// Current page
	Current int32 `protobuf:"varint,2,opt,name=current,proto3" json:"current,omitempty"`
	// The number of lines per page
	PageSize int32 `protobuf:"varint,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Response data
	Data *anypb.Any `protobuf:"bytes,4,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*PagingResponse_PagingData) Descriptor deprecated

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

Deprecated: Use PagingResponse_PagingData.ProtoReflect.Descriptor instead.

func (*PagingResponse_PagingData) GetCurrent

func (x *PagingResponse_PagingData) GetCurrent() int32

func (*PagingResponse_PagingData) GetData

func (x *PagingResponse_PagingData) GetData() *anypb.Any

func (*PagingResponse_PagingData) GetPageSize

func (x *PagingResponse_PagingData) GetPageSize() int32

func (*PagingResponse_PagingData) GetTotal

func (x *PagingResponse_PagingData) GetTotal() int32

func (*PagingResponse_PagingData) ProtoMessage

func (*PagingResponse_PagingData) ProtoMessage()

func (*PagingResponse_PagingData) ProtoReflect

func (*PagingResponse_PagingData) Reset

func (x *PagingResponse_PagingData) Reset()

func (*PagingResponse_PagingData) String

func (x *PagingResponse_PagingData) String() string

type SortOrder

type SortOrder int32

Paging sort

const (
	// No sort
	SortOrder_UNSORTED SortOrder = 0
	// Ascending order
	SortOrder_ASCENDING SortOrder = 1
	// Descending order
	SortOrder_DESCENDING SortOrder = 2
)

func (SortOrder) Descriptor

func (SortOrder) Descriptor() protoreflect.EnumDescriptor

func (SortOrder) Enum

func (x SortOrder) Enum() *SortOrder

func (SortOrder) EnumDescriptor deprecated

func (SortOrder) EnumDescriptor() ([]byte, []int)

Deprecated: Use SortOrder.Descriptor instead.

func (SortOrder) Number

func (x SortOrder) Number() protoreflect.EnumNumber

func (SortOrder) String

func (x SortOrder) String() string

func (SortOrder) Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL