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 MessageQueryValidate
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 MessageQueryValidate
- type MessageQueryValidate_QueryValidateEntry
- func (*MessageQueryValidate_QueryValidateEntry) Descriptor() ([]byte, []int)
- func (m *MessageQueryValidate_QueryValidateEntry) GetName() string
- func (m *MessageQueryValidate_QueryValidateEntry) GetValue() *QueryValidate
- func (*MessageQueryValidate_QueryValidateEntry) ProtoMessage()
- func (m *MessageQueryValidate_QueryValidateEntry) Reset()
- func (m *MessageQueryValidate_QueryValidateEntry) String() string
- type QueryValidate
- func (*QueryValidate) Descriptor() ([]byte, []int)
- func (m *QueryValidate) GetEnableNestedFields() bool
- func (m *QueryValidate) GetFieldSelection() *QueryValidate_FieldSelection
- func (m *QueryValidate) GetFiltering() *QueryValidate_Filtering
- func (m *QueryValidate) GetNestedFields() []string
- func (m *QueryValidate) GetSorting() *QueryValidate_Sorting
- func (m *QueryValidate) GetValueType() QueryValidate_ValueType
- func (m *QueryValidate) GetValueTypeUrl() string
- func (*QueryValidate) ProtoMessage()
- func (m *QueryValidate) Reset()
- func (m *QueryValidate) String() string
- type QueryValidate_FieldSelection
- 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_Message = &proto.ExtensionDesc{ ExtendedType: (*google_protobuf.MessageOptions)(nil), ExtensionType: (*MessageQueryValidate)(nil), Field: 52121, Name: "atlas.query.message", Tag: "bytes,52121,opt,name=message", Filename: "options/query_validate.proto", }
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",
7: "IEQ",
8: "IN",
}
View Source
var QueryValidate_FilterOperator_value = map[string]int32{
"EQ": 0,
"MATCH": 1,
"GT": 2,
"GE": 3,
"LT": 4,
"LE": 5,
"ALL": 6,
"IEQ": 7,
"IN": 8,
}
View Source
var QueryValidate_ValueType_name = map[int32]string{
0: "DEFAULT",
1: "STRING",
2: "NUMBER",
3: "BOOL",
}
View Source
var QueryValidate_ValueType_value = map[string]int32{
"DEFAULT": 0,
"STRING": 1,
"NUMBER": 2,
"BOOL": 3,
}
Functions ¶
func ValidateFieldSelection ¶ added in v0.3.0
func ValidateFieldSelection(fs *query.FieldSelection, allowedFields []string) error
func ValidateFiltering ¶ added in v0.2.0
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 MessageQueryValidate ¶ added in v0.5.0
type MessageQueryValidate struct {
Validate []*MessageQueryValidate_QueryValidateEntry `protobuf:"bytes,1,rep,name=validate" json:"validate,omitempty"`
}
func (*MessageQueryValidate) Descriptor ¶ added in v0.5.0
func (*MessageQueryValidate) Descriptor() ([]byte, []int)
func (*MessageQueryValidate) GetValidate ¶ added in v0.5.0
func (m *MessageQueryValidate) GetValidate() []*MessageQueryValidate_QueryValidateEntry
func (*MessageQueryValidate) ProtoMessage ¶ added in v0.5.0
func (*MessageQueryValidate) ProtoMessage()
func (*MessageQueryValidate) Reset ¶ added in v0.5.0
func (m *MessageQueryValidate) Reset()
func (*MessageQueryValidate) String ¶ added in v0.5.0
func (m *MessageQueryValidate) String() string
type MessageQueryValidate_QueryValidateEntry ¶ added in v0.5.0
type MessageQueryValidate_QueryValidateEntry struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Value *QueryValidate `protobuf:"bytes,2,opt,name=value" json:"value,omitempty"` }
func (*MessageQueryValidate_QueryValidateEntry) Descriptor ¶ added in v0.5.0
func (*MessageQueryValidate_QueryValidateEntry) Descriptor() ([]byte, []int)
func (*MessageQueryValidate_QueryValidateEntry) GetName ¶ added in v0.5.0
func (m *MessageQueryValidate_QueryValidateEntry) GetName() string
func (*MessageQueryValidate_QueryValidateEntry) GetValue ¶ added in v0.5.0
func (m *MessageQueryValidate_QueryValidateEntry) GetValue() *QueryValidate
func (*MessageQueryValidate_QueryValidateEntry) ProtoMessage ¶ added in v0.5.0
func (*MessageQueryValidate_QueryValidateEntry) ProtoMessage()
func (*MessageQueryValidate_QueryValidateEntry) Reset ¶ added in v0.5.0
func (m *MessageQueryValidate_QueryValidateEntry) Reset()
func (*MessageQueryValidate_QueryValidateEntry) String ¶ added in v0.5.0
func (m *MessageQueryValidate_QueryValidateEntry) String() string
type QueryValidate ¶ added in v0.2.0
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"` FieldSelection *QueryValidate_FieldSelection `protobuf:"bytes,3,opt,name=field_selection,json=fieldSelection" json:"field_selection,omitempty"` ValueType QueryValidate_ValueType `` /* 130-byte string literal not displayed */ ValueTypeUrl string `protobuf:"bytes,5,opt,name=value_type_url,json=valueTypeUrl,proto3" json:"value_type_url,omitempty"` EnableNestedFields bool `protobuf:"varint,6,opt,name=enable_nested_fields,json=enableNestedFields,proto3" json:"enable_nested_fields,omitempty"` NestedFields []string `protobuf:"bytes,7,rep,name=nested_fields,json=nestedFields" json:"nested_fields,omitempty"` }
func (*QueryValidate) Descriptor ¶ added in v0.2.0
func (*QueryValidate) Descriptor() ([]byte, []int)
func (*QueryValidate) GetEnableNestedFields ¶ added in v0.2.0
func (m *QueryValidate) GetEnableNestedFields() bool
func (*QueryValidate) GetFieldSelection ¶ added in v0.5.0
func (m *QueryValidate) GetFieldSelection() *QueryValidate_FieldSelection
func (*QueryValidate) GetFiltering ¶ added in v0.3.0
func (m *QueryValidate) GetFiltering() *QueryValidate_Filtering
func (*QueryValidate) GetNestedFields ¶ added in v0.5.0
func (m *QueryValidate) GetNestedFields() []string
func (*QueryValidate) GetSorting ¶ added in v0.3.0
func (m *QueryValidate) GetSorting() *QueryValidate_Sorting
func (*QueryValidate) GetValueType ¶ added in v0.3.0
func (m *QueryValidate) GetValueType() QueryValidate_ValueType
func (*QueryValidate) GetValueTypeUrl ¶ added in v0.5.0
func (m *QueryValidate) GetValueTypeUrl() string
func (*QueryValidate) ProtoMessage ¶ added in v0.2.0
func (*QueryValidate) ProtoMessage()
func (*QueryValidate) Reset ¶ added in v0.2.0
func (m *QueryValidate) Reset()
func (*QueryValidate) String ¶ added in v0.2.0
func (m *QueryValidate) String() string
type QueryValidate_FieldSelection ¶ added in v0.5.0
type QueryValidate_FieldSelection struct {
Disable bool `protobuf:"varint,1,opt,name=disable,proto3" json:"disable,omitempty"`
}
func (*QueryValidate_FieldSelection) Descriptor ¶ added in v0.5.0
func (*QueryValidate_FieldSelection) Descriptor() ([]byte, []int)
func (*QueryValidate_FieldSelection) GetDisable ¶ added in v0.5.0
func (m *QueryValidate_FieldSelection) GetDisable() bool
func (*QueryValidate_FieldSelection) ProtoMessage ¶ added in v0.5.0
func (*QueryValidate_FieldSelection) ProtoMessage()
func (*QueryValidate_FieldSelection) Reset ¶ added in v0.5.0
func (m *QueryValidate_FieldSelection) Reset()
func (*QueryValidate_FieldSelection) String ¶ added in v0.5.0
func (m *QueryValidate_FieldSelection) String() string
type QueryValidate_FilterOperator ¶ added in v0.2.0
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 QueryValidate_IEQ QueryValidate_FilterOperator = 7 QueryValidate_IN QueryValidate_FilterOperator = 8 )
func (QueryValidate_FilterOperator) EnumDescriptor ¶ added in v0.2.0
func (QueryValidate_FilterOperator) EnumDescriptor() ([]byte, []int)
func (QueryValidate_FilterOperator) String ¶ added in v0.2.0
func (x QueryValidate_FilterOperator) String() string
type QueryValidate_Filtering ¶ added in v0.3.0
type QueryValidate_Filtering struct { Allow []QueryValidate_FilterOperator `protobuf:"varint,1,rep,packed,name=allow,enum=atlas.query.QueryValidate_FilterOperator" json:"allow,omitempty"` Deny []QueryValidate_FilterOperator `protobuf:"varint,2,rep,packed,name=deny,enum=atlas.query.QueryValidate_FilterOperator" json:"deny,omitempty"` }
func (*QueryValidate_Filtering) Descriptor ¶ added in v0.3.0
func (*QueryValidate_Filtering) Descriptor() ([]byte, []int)
func (*QueryValidate_Filtering) GetAllow ¶ added in v0.3.0
func (m *QueryValidate_Filtering) GetAllow() []QueryValidate_FilterOperator
func (*QueryValidate_Filtering) GetDeny ¶ added in v0.3.0
func (m *QueryValidate_Filtering) GetDeny() []QueryValidate_FilterOperator
func (*QueryValidate_Filtering) ProtoMessage ¶ added in v0.3.0
func (*QueryValidate_Filtering) ProtoMessage()
func (*QueryValidate_Filtering) Reset ¶ added in v0.3.0
func (m *QueryValidate_Filtering) Reset()
func (*QueryValidate_Filtering) String ¶ added in v0.3.0
func (m *QueryValidate_Filtering) String() string
type QueryValidate_Sorting ¶ added in v0.3.0
type QueryValidate_Sorting struct {
Disable bool `protobuf:"varint,1,opt,name=disable,proto3" json:"disable,omitempty"`
}
func (*QueryValidate_Sorting) Descriptor ¶ added in v0.3.0
func (*QueryValidate_Sorting) Descriptor() ([]byte, []int)
func (*QueryValidate_Sorting) GetDisable ¶ added in v0.3.0
func (m *QueryValidate_Sorting) GetDisable() bool
func (*QueryValidate_Sorting) ProtoMessage ¶ added in v0.3.0
func (*QueryValidate_Sorting) ProtoMessage()
func (*QueryValidate_Sorting) Reset ¶ added in v0.3.0
func (m *QueryValidate_Sorting) Reset()
func (*QueryValidate_Sorting) String ¶ added in v0.3.0
func (m *QueryValidate_Sorting) String() string
type QueryValidate_ValueType ¶ added in v0.3.0
type QueryValidate_ValueType int32
const ( QueryValidate_DEFAULT QueryValidate_ValueType = 0 QueryValidate_STRING QueryValidate_ValueType = 1 QueryValidate_NUMBER QueryValidate_ValueType = 2 QueryValidate_BOOL QueryValidate_ValueType = 3 )
func (QueryValidate_ValueType) EnumDescriptor ¶ added in v0.3.0
func (QueryValidate_ValueType) EnumDescriptor() ([]byte, []int)
func (QueryValidate_ValueType) String ¶ added in v0.3.0
func (x QueryValidate_ValueType) String() string
Click to show internal directories.
Click to hide internal directories.