Documentation ¶
Overview ¶
Package options is a generated protocol buffer package.
It is generated from these files:
options/query_validate.proto
It has these top-level messages:
QueryValidate
Index ¶
- Variables
- func ValidateFieldSelection(fs *query.FieldSelection, allowedFields []string) error
- func ValidateFiltering(f *query.Filtering, messageInfo map[string]FilteringOption) error
- func ValidateSorting(p *query.Sorting, fields []string) error
- type FilteringOption
- type FilteringOptions
- type QueryValidate
- func (*QueryValidate) Descriptor() ([]byte, []int)
- func (m *QueryValidate) GetEnableNestedFields() bool
- func (m *QueryValidate) GetFiltering() *QueryValidate_Filtering
- func (m *QueryValidate) GetSorting() *QueryValidate_Sorting
- func (m *QueryValidate) GetValueType() QueryValidate_ValueType
- func (*QueryValidate) ProtoMessage()
- func (m *QueryValidate) Reset()
- func (m *QueryValidate) String() string
- type QueryValidate_FilterOperator
- type QueryValidate_Filtering
- func (*QueryValidate_Filtering) Descriptor() ([]byte, []int)
- func (m *QueryValidate_Filtering) GetAllow() []QueryValidate_FilterOperator
- func (m *QueryValidate_Filtering) GetDeny() []QueryValidate_FilterOperator
- func (*QueryValidate_Filtering) ProtoMessage()
- func (m *QueryValidate_Filtering) Reset()
- func (m *QueryValidate_Filtering) String() string
- type QueryValidate_Sorting
- type QueryValidate_ValueType
Constants ¶
This section is empty.
Variables ¶
View Source
var E_Validate = &proto.ExtensionDesc{ ExtendedType: (*google_protobuf.FieldOptions)(nil), ExtensionType: (*QueryValidate)(nil), Field: 52121, Name: "atlas.query.validate", Tag: "bytes,52121,opt,name=validate", Filename: "options/query_validate.proto", }
View Source
var QueryValidate_FilterOperator_name = map[int32]string{
0: "EQ",
1: "MATCH",
2: "GT",
3: "GE",
4: "LT",
5: "LE",
6: "ALL",
}
View Source
var QueryValidate_FilterOperator_value = map[string]int32{
"EQ": 0,
"MATCH": 1,
"GT": 2,
"GE": 3,
"LT": 4,
"LE": 5,
"ALL": 6,
}
View Source
var QueryValidate_ValueType_name = map[int32]string{
0: "DEFAULT",
1: "STRING",
2: "NUMBER",
}
View Source
var QueryValidate_ValueType_value = map[string]int32{
"DEFAULT": 0,
"STRING": 1,
"NUMBER": 2,
}
Functions ¶
func ValidateFieldSelection ¶
func ValidateFieldSelection(fs *query.FieldSelection, allowedFields []string) error
func ValidateFiltering ¶
func ValidateFiltering(f *query.Filtering, messageInfo map[string]FilteringOption) error
Types ¶
type FilteringOption ¶
type FilteringOption struct { ValueType QueryValidate_ValueType Deny []QueryValidate_FilterOperator }
type FilteringOptions ¶
type FilteringOptions struct { AllowMissingFields bool Options map[string]FilteringOption }
type QueryValidate ¶
type QueryValidate struct { Filtering *QueryValidate_Filtering `protobuf:"bytes,1,opt,name=filtering" json:"filtering,omitempty"` Sorting *QueryValidate_Sorting `protobuf:"bytes,2,opt,name=sorting" json:"sorting,omitempty"` ValueType *QueryValidate_ValueType `protobuf:"varint,3,opt,name=value_type,json=valueType,enum=atlas.query.QueryValidate_ValueType" json:"value_type,omitempty"` EnableNestedFields *bool `protobuf:"varint,4,opt,name=enable_nested_fields,json=enableNestedFields" json:"enable_nested_fields,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*QueryValidate) Descriptor ¶
func (*QueryValidate) Descriptor() ([]byte, []int)
func (*QueryValidate) GetEnableNestedFields ¶
func (m *QueryValidate) GetEnableNestedFields() bool
func (*QueryValidate) GetFiltering ¶
func (m *QueryValidate) GetFiltering() *QueryValidate_Filtering
func (*QueryValidate) GetSorting ¶
func (m *QueryValidate) GetSorting() *QueryValidate_Sorting
func (*QueryValidate) GetValueType ¶
func (m *QueryValidate) GetValueType() QueryValidate_ValueType
func (*QueryValidate) ProtoMessage ¶
func (*QueryValidate) ProtoMessage()
func (*QueryValidate) Reset ¶
func (m *QueryValidate) Reset()
func (*QueryValidate) String ¶
func (m *QueryValidate) String() string
type QueryValidate_FilterOperator ¶
type QueryValidate_FilterOperator int32
const ( QueryValidate_EQ QueryValidate_FilterOperator = 0 QueryValidate_MATCH QueryValidate_FilterOperator = 1 QueryValidate_GT QueryValidate_FilterOperator = 2 QueryValidate_GE QueryValidate_FilterOperator = 3 QueryValidate_LT QueryValidate_FilterOperator = 4 QueryValidate_LE QueryValidate_FilterOperator = 5 QueryValidate_ALL QueryValidate_FilterOperator = 6 )
func (QueryValidate_FilterOperator) Enum ¶
func (x QueryValidate_FilterOperator) Enum() *QueryValidate_FilterOperator
func (QueryValidate_FilterOperator) EnumDescriptor ¶
func (QueryValidate_FilterOperator) EnumDescriptor() ([]byte, []int)
func (QueryValidate_FilterOperator) String ¶
func (x QueryValidate_FilterOperator) String() string
func (*QueryValidate_FilterOperator) UnmarshalJSON ¶
func (x *QueryValidate_FilterOperator) UnmarshalJSON(data []byte) error
type QueryValidate_Filtering ¶
type QueryValidate_Filtering struct { Allow []QueryValidate_FilterOperator `protobuf:"varint,1,rep,name=allow,enum=atlas.query.QueryValidate_FilterOperator" json:"allow,omitempty"` Deny []QueryValidate_FilterOperator `protobuf:"varint,2,rep,name=deny,enum=atlas.query.QueryValidate_FilterOperator" json:"deny,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*QueryValidate_Filtering) Descriptor ¶
func (*QueryValidate_Filtering) Descriptor() ([]byte, []int)
func (*QueryValidate_Filtering) GetAllow ¶
func (m *QueryValidate_Filtering) GetAllow() []QueryValidate_FilterOperator
func (*QueryValidate_Filtering) GetDeny ¶
func (m *QueryValidate_Filtering) GetDeny() []QueryValidate_FilterOperator
func (*QueryValidate_Filtering) ProtoMessage ¶
func (*QueryValidate_Filtering) ProtoMessage()
func (*QueryValidate_Filtering) Reset ¶
func (m *QueryValidate_Filtering) Reset()
func (*QueryValidate_Filtering) String ¶
func (m *QueryValidate_Filtering) String() string
type QueryValidate_Sorting ¶
type QueryValidate_Sorting struct { Disable *bool `protobuf:"varint,1,opt,name=disable" json:"disable,omitempty"` XXX_unrecognized []byte `json:"-"` }
func (*QueryValidate_Sorting) Descriptor ¶
func (*QueryValidate_Sorting) Descriptor() ([]byte, []int)
func (*QueryValidate_Sorting) GetDisable ¶
func (m *QueryValidate_Sorting) GetDisable() bool
func (*QueryValidate_Sorting) ProtoMessage ¶
func (*QueryValidate_Sorting) ProtoMessage()
func (*QueryValidate_Sorting) Reset ¶
func (m *QueryValidate_Sorting) Reset()
func (*QueryValidate_Sorting) String ¶
func (m *QueryValidate_Sorting) String() string
type QueryValidate_ValueType ¶
type QueryValidate_ValueType int32
const ( QueryValidate_DEFAULT QueryValidate_ValueType = 0 QueryValidate_STRING QueryValidate_ValueType = 1 QueryValidate_NUMBER QueryValidate_ValueType = 2 )
func (QueryValidate_ValueType) Enum ¶
func (x QueryValidate_ValueType) Enum() *QueryValidate_ValueType
func (QueryValidate_ValueType) EnumDescriptor ¶
func (QueryValidate_ValueType) EnumDescriptor() ([]byte, []int)
func (QueryValidate_ValueType) String ¶
func (x QueryValidate_ValueType) String() string
func (*QueryValidate_ValueType) UnmarshalJSON ¶
func (x *QueryValidate_ValueType) UnmarshalJSON(data []byte) error
Click to show internal directories.
Click to hide internal directories.