commonv1

package
v0.0.0-...-f0a7105 Latest Latest
Warning

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

 Go to latest Published: Jul 19, 2024 License: MIT Imports: 18 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_common_v1_common_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type PagingRequest 

type PagingRequest struct {
	Page      *int32                 `protobuf:"varint,1,opt,name=page,proto3,oneof" json:"page,omitempty"`
	PageSize  *int32                 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3,oneof" json:"page_size,omitempty"`
	Query     *string                `protobuf:"bytes,3,opt,name=query,proto3,oneof" json:"query,omitempty"`
	OrQuery   *string                `protobuf:"bytes,4,opt,name=or_query,json=orQuery,proto3,oneof" json:"or_query,omitempty"`
	OrderBy   []string               `protobuf:"bytes,5,rep,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	NoPaging  *bool                  `protobuf:"varint,6,opt,name=no_paging,json=noPaging,proto3,oneof" json:"no_paging,omitempty"`
	FieldMask *fieldmaskpb.FieldMask `protobuf:"bytes,7,opt,name=field_mask,json=fieldMask,proto3" json:"field_mask,omitempty"`
	// contains filtered or unexported fields
}

pagination common request

func (*PagingRequest) Descriptor deprecated 

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

Deprecated: Use PagingRequest.ProtoReflect.Descriptor instead.

func (*PagingRequest) GetFieldMask 

func (x *PagingRequest) GetFieldMask() *fieldmaskpb.FieldMask

func (*PagingRequest) GetNoPaging 

func (x *PagingRequest) GetNoPaging() bool

func (*PagingRequest) GetOrQuery 

func (x *PagingRequest) GetOrQuery() string

func (*PagingRequest) GetOrderBy 

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

func (*PagingRequest) GetPage 

func (x *PagingRequest) GetPage() int32

func (*PagingRequest) GetPageSize 

func (x *PagingRequest) GetPageSize() int32

func (*PagingRequest) GetQuery 

func (x *PagingRequest) GetQuery() string

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

func (*PagingRequest) Validate 

func (m *PagingRequest) Validate() error

Validate checks the field values on PagingRequest 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 (*PagingRequest) ValidateAll 

func (m *PagingRequest) ValidateAll() error

ValidateAll checks the field values on PagingRequest 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 PagingRequestMultiError, or nil if none found.

type PagingRequestMultiError 

type PagingRequestMultiError []error

PagingRequestMultiError is an error wrapping multiple validation errors returned by PagingRequest.ValidateAll() if the designated constraints aren't met.

func (PagingRequestMultiError) AllErrors 

func (m PagingRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PagingRequestMultiError) Error 

func (m PagingRequestMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type PagingRequestValidationError 

type PagingRequestValidationError struct {
	// contains filtered or unexported fields
}

PagingRequestValidationError is the validation error returned by PagingRequest.Validate if the designated constraints aren't met.

func (PagingRequestValidationError) Cause 

func (e PagingRequestValidationError) Cause() error

Cause function returns cause value.

func (PagingRequestValidationError) Error 

func (e PagingRequestValidationError) Error() string

Error satisfies the builtin error interface

func (PagingRequestValidationError) ErrorName 

func (e PagingRequestValidationError) ErrorName() string

ErrorName returns error name.

func (PagingRequestValidationError) Field 

func (e PagingRequestValidationError) Field() string

Field function returns field value.

func (PagingRequestValidationError) Key 

func (e PagingRequestValidationError) Key() bool

Key function returns key value.

func (PagingRequestValidationError) Reason 

func (e PagingRequestValidationError) Reason() string

Reason function returns reason value.

type PagingResponse 

type PagingResponse struct {

	// total
	Total int32 `protobuf:"varint,1,opt,name=total,proto3" json:"total,omitempty"`
	// paginated data
	Items []*anypb.Any `protobuf:"bytes,2,rep,name=items,proto3" json:"items,omitempty"`
	// contains filtered or unexported fields
}

Paginated universal results

func (*PagingResponse) Descriptor deprecated 

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

Deprecated: Use PagingResponse.ProtoReflect.Descriptor instead.

func (*PagingResponse) GetItems 

func (x *PagingResponse) GetItems() []*anypb.Any

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

func (*PagingResponse) Validate 

func (m *PagingResponse) Validate() error

Validate checks the field values on PagingResponse 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 (*PagingResponse) ValidateAll 

func (m *PagingResponse) ValidateAll() error

ValidateAll checks the field values on PagingResponse 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 PagingResponseMultiError, or nil if none found.

type PagingResponseMultiError 

type PagingResponseMultiError []error

PagingResponseMultiError is an error wrapping multiple validation errors returned by PagingResponse.ValidateAll() if the designated constraints aren't met.

func (PagingResponseMultiError) AllErrors 

func (m PagingResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PagingResponseMultiError) Error 

func (m PagingResponseMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type PagingResponseValidationError 

type PagingResponseValidationError struct {
	// contains filtered or unexported fields
}

PagingResponseValidationError is the validation error returned by PagingResponse.Validate if the designated constraints aren't met.

func (PagingResponseValidationError) Cause 

func (e PagingResponseValidationError) Cause() error

Cause function returns cause value.

func (PagingResponseValidationError) Error 

func (e PagingResponseValidationError) Error() string

Error satisfies the builtin error interface

func (PagingResponseValidationError) ErrorName 

func (e PagingResponseValidationError) ErrorName() string

ErrorName returns error name.

func (PagingResponseValidationError) Field 

func (e PagingResponseValidationError) Field() string

Field function returns field value.

func (PagingResponseValidationError) Key 

func (e PagingResponseValidationError) Key() bool

Key function returns key value.

func (PagingResponseValidationError) Reason 

func (e PagingResponseValidationError) Reason() string

Reason function returns reason value.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.