Documentation ¶
Index ¶
- Variables
- type PaginationRequest
- func (*PaginationRequest) Descriptor() ([]byte, []int)deprecated
- func (*PaginationRequest) ProtoMessage()
- func (x *PaginationRequest) ProtoReflect() protoreflect.Message
- func (x *PaginationRequest) Reset()
- func (x *PaginationRequest) String() string
- func (m *PaginationRequest) Validate() error
- func (m *PaginationRequest) ValidateAll() error
- type PaginationRequestMultiError
- type PaginationRequestValidationError
- func (e PaginationRequestValidationError) Cause() error
- func (e PaginationRequestValidationError) Error() string
- func (e PaginationRequestValidationError) ErrorName() string
- func (e PaginationRequestValidationError) Field() string
- func (e PaginationRequestValidationError) Key() bool
- func (e PaginationRequestValidationError) Reason() string
- type PaginationResponse
- func (*PaginationResponse) Descriptor() ([]byte, []int)deprecated
- func (x *PaginationResponse) GetCurrentPage() int32
- func (x *PaginationResponse) GetNextPage() int32
- func (x *PaginationResponse) GetPerPage() int32
- func (x *PaginationResponse) GetPreviousPage() int32
- func (x *PaginationResponse) GetTotalCount() int32deprecated
- func (x *PaginationResponse) GetTotalPages() int32deprecated
- func (*PaginationResponse) ProtoMessage()
- func (x *PaginationResponse) ProtoReflect() protoreflect.Message
- func (x *PaginationResponse) Reset()
- func (x *PaginationResponse) String() string
- func (m *PaginationResponse) Validate() error
- func (m *PaginationResponse) ValidateAll() error
- type PaginationResponseMultiError
- type PaginationResponseValidationError
- func (e PaginationResponseValidationError) Cause() error
- func (e PaginationResponseValidationError) Error() string
- func (e PaginationResponseValidationError) ErrorName() string
- func (e PaginationResponseValidationError) Field() string
- func (e PaginationResponseValidationError) Key() bool
- func (e PaginationResponseValidationError) Reason() string
Constants ¶
This section is empty.
Variables ¶
var File_pagination_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type PaginationRequest ¶
type PaginationRequest struct {
// contains filtered or unexported fields
}
func (*PaginationRequest) Descriptor
deprecated
func (*PaginationRequest) Descriptor() ([]byte, []int)
Deprecated: Use PaginationRequest.ProtoReflect.Descriptor instead.
func (*PaginationRequest) ProtoMessage ¶
func (*PaginationRequest) ProtoMessage()
func (*PaginationRequest) ProtoReflect ¶
func (x *PaginationRequest) ProtoReflect() protoreflect.Message
func (*PaginationRequest) Reset ¶
func (x *PaginationRequest) Reset()
func (*PaginationRequest) String ¶
func (x *PaginationRequest) String() string
func (*PaginationRequest) Validate ¶
func (m *PaginationRequest) Validate() error
Validate checks the field values on PaginationRequest with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*PaginationRequest) ValidateAll ¶
func (m *PaginationRequest) ValidateAll() error
ValidateAll checks the field values on PaginationRequest with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PaginationRequestMultiError, or nil if none found.
type PaginationRequestMultiError ¶
type PaginationRequestMultiError []error
PaginationRequestMultiError is an error wrapping multiple validation errors returned by PaginationRequest.ValidateAll() if the designated constraints aren't met.
func (PaginationRequestMultiError) AllErrors ¶
func (m PaginationRequestMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (PaginationRequestMultiError) Error ¶
func (m PaginationRequestMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type PaginationRequestValidationError ¶
type PaginationRequestValidationError struct {
// contains filtered or unexported fields
}
PaginationRequestValidationError is the validation error returned by PaginationRequest.Validate if the designated constraints aren't met.
func (PaginationRequestValidationError) Cause ¶
func (e PaginationRequestValidationError) Cause() error
Cause function returns cause value.
func (PaginationRequestValidationError) Error ¶
func (e PaginationRequestValidationError) Error() string
Error satisfies the builtin error interface
func (PaginationRequestValidationError) ErrorName ¶
func (e PaginationRequestValidationError) ErrorName() string
ErrorName returns error name.
func (PaginationRequestValidationError) Field ¶
func (e PaginationRequestValidationError) Field() string
Field function returns field value.
func (PaginationRequestValidationError) Key ¶
func (e PaginationRequestValidationError) Key() bool
Key function returns key value.
func (PaginationRequestValidationError) Reason ¶
func (e PaginationRequestValidationError) Reason() string
Reason function returns reason value.
type PaginationResponse ¶
type PaginationResponse struct { // current page number. CurrentPage int32 `protobuf:"varint,1,opt,name=current_page,json=currentPage,proto3" json:"current_page,omitempty"` // previous page number, 1 if on the first page. PreviousPage int32 `protobuf:"varint,2,opt,name=previous_page,json=previousPage,proto3" json:"previous_page,omitempty"` // next page number, total_pages if on the last page. NextPage int32 `protobuf:"varint,3,opt,name=next_page,json=nextPage,proto3" json:"next_page,omitempty"` // number of items per page. PerPage int32 `protobuf:"varint,4,opt,name=per_page,json=perPage,proto3" json:"per_page,omitempty"` // total pages with current settings (deprecated due to performance concerns). // // Deprecated: Do not use. TotalPages int32 `protobuf:"varint,5,opt,name=total_pages,json=totalPages,proto3" json:"total_pages,omitempty"` // total number of items (deprecated due to performance concerns). // // Deprecated: Do not use. TotalCount int32 `protobuf:"varint,6,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty"` // contains filtered or unexported fields }
func (*PaginationResponse) Descriptor
deprecated
func (*PaginationResponse) Descriptor() ([]byte, []int)
Deprecated: Use PaginationResponse.ProtoReflect.Descriptor instead.
func (*PaginationResponse) GetCurrentPage ¶
func (x *PaginationResponse) GetCurrentPage() int32
func (*PaginationResponse) GetNextPage ¶
func (x *PaginationResponse) GetNextPage() int32
func (*PaginationResponse) GetPerPage ¶
func (x *PaginationResponse) GetPerPage() int32
func (*PaginationResponse) GetPreviousPage ¶
func (x *PaginationResponse) GetPreviousPage() int32
func (*PaginationResponse) GetTotalCount
deprecated
func (x *PaginationResponse) GetTotalCount() int32
Deprecated: Do not use.
func (*PaginationResponse) GetTotalPages
deprecated
func (x *PaginationResponse) GetTotalPages() int32
Deprecated: Do not use.
func (*PaginationResponse) ProtoMessage ¶
func (*PaginationResponse) ProtoMessage()
func (*PaginationResponse) ProtoReflect ¶
func (x *PaginationResponse) ProtoReflect() protoreflect.Message
func (*PaginationResponse) Reset ¶
func (x *PaginationResponse) Reset()
func (*PaginationResponse) String ¶
func (x *PaginationResponse) String() string
func (*PaginationResponse) Validate ¶
func (m *PaginationResponse) Validate() error
Validate checks the field values on PaginationResponse with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.
func (*PaginationResponse) ValidateAll ¶
func (m *PaginationResponse) ValidateAll() error
ValidateAll checks the field values on PaginationResponse with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in PaginationResponseMultiError, or nil if none found.
type PaginationResponseMultiError ¶
type PaginationResponseMultiError []error
PaginationResponseMultiError is an error wrapping multiple validation errors returned by PaginationResponse.ValidateAll() if the designated constraints aren't met.
func (PaginationResponseMultiError) AllErrors ¶
func (m PaginationResponseMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (PaginationResponseMultiError) Error ¶
func (m PaginationResponseMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type PaginationResponseValidationError ¶
type PaginationResponseValidationError struct {
// contains filtered or unexported fields
}
PaginationResponseValidationError is the validation error returned by PaginationResponse.Validate if the designated constraints aren't met.
func (PaginationResponseValidationError) Cause ¶
func (e PaginationResponseValidationError) Cause() error
Cause function returns cause value.
func (PaginationResponseValidationError) Error ¶
func (e PaginationResponseValidationError) Error() string
Error satisfies the builtin error interface
func (PaginationResponseValidationError) ErrorName ¶
func (e PaginationResponseValidationError) ErrorName() string
ErrorName returns error name.
func (PaginationResponseValidationError) Field ¶
func (e PaginationResponseValidationError) Field() string
Field function returns field value.
func (PaginationResponseValidationError) Key ¶
func (e PaginationResponseValidationError) Key() bool
Key function returns key value.
func (PaginationResponseValidationError) Reason ¶
func (e PaginationResponseValidationError) Reason() string
Reason function returns reason value.