Documentation ¶
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
- func (*MessageQueryValidate) Descriptor() ([]byte, []int)deprecated
- func (x *MessageQueryValidate) GetEnableNestedFields() bool
- func (x *MessageQueryValidate) GetNestedFieldDepthLimit() int32
- func (x *MessageQueryValidate) GetValidate() []*MessageQueryValidate_QueryValidateEntry
- func (*MessageQueryValidate) ProtoMessage()
- func (x *MessageQueryValidate) ProtoReflect() protoreflect.Message
- func (x *MessageQueryValidate) Reset()
- func (x *MessageQueryValidate) String() string
- type MessageQueryValidate_QueryValidateEntry
- func (*MessageQueryValidate_QueryValidateEntry) Descriptor() ([]byte, []int)deprecated
- func (x *MessageQueryValidate_QueryValidateEntry) GetName() string
- func (x *MessageQueryValidate_QueryValidateEntry) GetValue() *QueryValidate
- func (*MessageQueryValidate_QueryValidateEntry) ProtoMessage()
- func (x *MessageQueryValidate_QueryValidateEntry) ProtoReflect() protoreflect.Message
- func (x *MessageQueryValidate_QueryValidateEntry) Reset()
- func (x *MessageQueryValidate_QueryValidateEntry) String() string
- type QueryValidate
- func (*QueryValidate) Descriptor() ([]byte, []int)deprecated
- func (x *QueryValidate) GetEnableNestedFields() bool
- func (x *QueryValidate) GetFieldSelection() *QueryValidate_FieldSelection
- func (x *QueryValidate) GetFiltering() *QueryValidate_Filtering
- func (x *QueryValidate) GetNestedFields() []string
- func (x *QueryValidate) GetSorting() *QueryValidate_Sorting
- func (x *QueryValidate) GetValueType() QueryValidate_ValueType
- func (x *QueryValidate) GetValueTypeUrl() string
- func (*QueryValidate) ProtoMessage()
- func (x *QueryValidate) ProtoReflect() protoreflect.Message
- func (x *QueryValidate) Reset()
- func (x *QueryValidate) String() string
- type QueryValidate_FieldSelection
- func (*QueryValidate_FieldSelection) Descriptor() ([]byte, []int)deprecated
- func (x *QueryValidate_FieldSelection) GetDisable() bool
- func (*QueryValidate_FieldSelection) ProtoMessage()
- func (x *QueryValidate_FieldSelection) ProtoReflect() protoreflect.Message
- func (x *QueryValidate_FieldSelection) Reset()
- func (x *QueryValidate_FieldSelection) String() string
- type QueryValidate_FilterOperator
- func (QueryValidate_FilterOperator) Descriptor() protoreflect.EnumDescriptor
- func (x QueryValidate_FilterOperator) Enum() *QueryValidate_FilterOperator
- func (QueryValidate_FilterOperator) EnumDescriptor() ([]byte, []int)deprecated
- func (x QueryValidate_FilterOperator) Number() protoreflect.EnumNumber
- func (x QueryValidate_FilterOperator) String() string
- func (QueryValidate_FilterOperator) Type() protoreflect.EnumType
- type QueryValidate_Filtering
- func (*QueryValidate_Filtering) Descriptor() ([]byte, []int)deprecated
- func (x *QueryValidate_Filtering) GetAllow() []QueryValidate_FilterOperator
- func (x *QueryValidate_Filtering) GetDeny() []QueryValidate_FilterOperator
- func (*QueryValidate_Filtering) ProtoMessage()
- func (x *QueryValidate_Filtering) ProtoReflect() protoreflect.Message
- func (x *QueryValidate_Filtering) Reset()
- func (x *QueryValidate_Filtering) String() string
- type QueryValidate_Sorting
- func (*QueryValidate_Sorting) Descriptor() ([]byte, []int)deprecated
- func (x *QueryValidate_Sorting) GetDisable() bool
- func (*QueryValidate_Sorting) ProtoMessage()
- func (x *QueryValidate_Sorting) ProtoReflect() protoreflect.Message
- func (x *QueryValidate_Sorting) Reset()
- func (x *QueryValidate_Sorting) String() string
- type QueryValidate_ValueType
- func (QueryValidate_ValueType) Descriptor() protoreflect.EnumDescriptor
- func (x QueryValidate_ValueType) Enum() *QueryValidate_ValueType
- func (QueryValidate_ValueType) EnumDescriptor() ([]byte, []int)deprecated
- func (x QueryValidate_ValueType) Number() protoreflect.EnumNumber
- func (x QueryValidate_ValueType) String() string
- func (QueryValidate_ValueType) Type() protoreflect.EnumType
Constants ¶
This section is empty.
Variables ¶
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", } QueryValidate_FilterOperator_value = map[string]int32{ "EQ": 0, "MATCH": 1, "GT": 2, "GE": 3, "LT": 4, "LE": 5, "ALL": 6, "IEQ": 7, "IN": 8, } )
Enum value maps for QueryValidate_FilterOperator.
var ( QueryValidate_ValueType_name = map[int32]string{ 0: "DEFAULT", 1: "STRING", 2: "NUMBER", 3: "BOOL", } QueryValidate_ValueType_value = map[string]int32{ "DEFAULT": 0, "STRING": 1, "NUMBER": 2, "BOOL": 3, } )
Enum value maps for QueryValidate_ValueType.
var (
// optional atlas.query.MessageQueryValidate message = 52121;
E_Message = &file_options_query_validate_proto_extTypes[1]
)
Extension fields to descriptorpb.MessageOptions.
var (
// optional atlas.query.QueryValidate validate = 52121;
E_Validate = &file_options_query_validate_proto_extTypes[0]
)
Extension fields to descriptorpb.FieldOptions.
var File_options_query_validate_proto protoreflect.FileDescriptor
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,proto3" json:"validate,omitempty"` NestedFieldDepthLimit int32 `` /* 129-byte string literal not displayed */ EnableNestedFields bool `protobuf:"varint,3,opt,name=enable_nested_fields,json=enableNestedFields,proto3" json:"enable_nested_fields,omitempty"` // contains filtered or unexported fields }
func (*MessageQueryValidate) Descriptor
deprecated
added in
v0.5.0
func (*MessageQueryValidate) Descriptor() ([]byte, []int)
Deprecated: Use MessageQueryValidate.ProtoReflect.Descriptor instead.
func (*MessageQueryValidate) GetEnableNestedFields ¶ added in v0.5.2
func (x *MessageQueryValidate) GetEnableNestedFields() bool
func (*MessageQueryValidate) GetNestedFieldDepthLimit ¶ added in v0.5.2
func (x *MessageQueryValidate) GetNestedFieldDepthLimit() int32
func (*MessageQueryValidate) GetValidate ¶ added in v0.5.0
func (x *MessageQueryValidate) GetValidate() []*MessageQueryValidate_QueryValidateEntry
func (*MessageQueryValidate) ProtoMessage ¶ added in v0.5.0
func (*MessageQueryValidate) ProtoMessage()
func (*MessageQueryValidate) ProtoReflect ¶ added in v0.6.0
func (x *MessageQueryValidate) ProtoReflect() protoreflect.Message
func (*MessageQueryValidate) Reset ¶ added in v0.5.0
func (x *MessageQueryValidate) Reset()
func (*MessageQueryValidate) String ¶ added in v0.5.0
func (x *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,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
func (*MessageQueryValidate_QueryValidateEntry) Descriptor
deprecated
added in
v0.5.0
func (*MessageQueryValidate_QueryValidateEntry) Descriptor() ([]byte, []int)
Deprecated: Use MessageQueryValidate_QueryValidateEntry.ProtoReflect.Descriptor instead.
func (*MessageQueryValidate_QueryValidateEntry) GetName ¶ added in v0.5.0
func (x *MessageQueryValidate_QueryValidateEntry) GetName() string
func (*MessageQueryValidate_QueryValidateEntry) GetValue ¶ added in v0.5.0
func (x *MessageQueryValidate_QueryValidateEntry) GetValue() *QueryValidate
func (*MessageQueryValidate_QueryValidateEntry) ProtoMessage ¶ added in v0.5.0
func (*MessageQueryValidate_QueryValidateEntry) ProtoMessage()
func (*MessageQueryValidate_QueryValidateEntry) ProtoReflect ¶ added in v0.6.0
func (x *MessageQueryValidate_QueryValidateEntry) ProtoReflect() protoreflect.Message
func (*MessageQueryValidate_QueryValidateEntry) Reset ¶ added in v0.5.0
func (x *MessageQueryValidate_QueryValidateEntry) Reset()
func (*MessageQueryValidate_QueryValidateEntry) String ¶ added in v0.5.0
func (x *MessageQueryValidate_QueryValidateEntry) String() string
type QueryValidate ¶ added in v0.2.0
type QueryValidate struct { Filtering *QueryValidate_Filtering `protobuf:"bytes,1,opt,name=filtering,proto3" json:"filtering,omitempty"` Sorting *QueryValidate_Sorting `protobuf:"bytes,2,opt,name=sorting,proto3" json:"sorting,omitempty"` FieldSelection *QueryValidate_FieldSelection `protobuf:"bytes,3,opt,name=field_selection,json=fieldSelection,proto3" 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,proto3" json:"nested_fields,omitempty"` // contains filtered or unexported fields }
func (*QueryValidate) Descriptor
deprecated
added in
v0.2.0
func (*QueryValidate) Descriptor() ([]byte, []int)
Deprecated: Use QueryValidate.ProtoReflect.Descriptor instead.
func (*QueryValidate) GetEnableNestedFields ¶ added in v0.2.0
func (x *QueryValidate) GetEnableNestedFields() bool
func (*QueryValidate) GetFieldSelection ¶ added in v0.5.0
func (x *QueryValidate) GetFieldSelection() *QueryValidate_FieldSelection
func (*QueryValidate) GetFiltering ¶ added in v0.3.0
func (x *QueryValidate) GetFiltering() *QueryValidate_Filtering
func (*QueryValidate) GetNestedFields ¶ added in v0.5.0
func (x *QueryValidate) GetNestedFields() []string
func (*QueryValidate) GetSorting ¶ added in v0.3.0
func (x *QueryValidate) GetSorting() *QueryValidate_Sorting
func (*QueryValidate) GetValueType ¶ added in v0.3.0
func (x *QueryValidate) GetValueType() QueryValidate_ValueType
func (*QueryValidate) GetValueTypeUrl ¶ added in v0.5.0
func (x *QueryValidate) GetValueTypeUrl() string
func (*QueryValidate) ProtoMessage ¶ added in v0.2.0
func (*QueryValidate) ProtoMessage()
func (*QueryValidate) ProtoReflect ¶ added in v0.6.0
func (x *QueryValidate) ProtoReflect() protoreflect.Message
func (*QueryValidate) Reset ¶ added in v0.2.0
func (x *QueryValidate) Reset()
func (*QueryValidate) String ¶ added in v0.2.0
func (x *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"` // contains filtered or unexported fields }
func (*QueryValidate_FieldSelection) Descriptor
deprecated
added in
v0.5.0
func (*QueryValidate_FieldSelection) Descriptor() ([]byte, []int)
Deprecated: Use QueryValidate_FieldSelection.ProtoReflect.Descriptor instead.
func (*QueryValidate_FieldSelection) GetDisable ¶ added in v0.5.0
func (x *QueryValidate_FieldSelection) GetDisable() bool
func (*QueryValidate_FieldSelection) ProtoMessage ¶ added in v0.5.0
func (*QueryValidate_FieldSelection) ProtoMessage()
func (*QueryValidate_FieldSelection) ProtoReflect ¶ added in v0.6.0
func (x *QueryValidate_FieldSelection) ProtoReflect() protoreflect.Message
func (*QueryValidate_FieldSelection) Reset ¶ added in v0.5.0
func (x *QueryValidate_FieldSelection) Reset()
func (*QueryValidate_FieldSelection) String ¶ added in v0.5.0
func (x *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) Descriptor ¶ added in v0.6.0
func (QueryValidate_FilterOperator) Descriptor() protoreflect.EnumDescriptor
func (QueryValidate_FilterOperator) Enum ¶ added in v0.2.0
func (x QueryValidate_FilterOperator) Enum() *QueryValidate_FilterOperator
func (QueryValidate_FilterOperator) EnumDescriptor
deprecated
added in
v0.2.0
func (QueryValidate_FilterOperator) EnumDescriptor() ([]byte, []int)
Deprecated: Use QueryValidate_FilterOperator.Descriptor instead.
func (QueryValidate_FilterOperator) Number ¶ added in v0.6.0
func (x QueryValidate_FilterOperator) Number() protoreflect.EnumNumber
func (QueryValidate_FilterOperator) String ¶ added in v0.2.0
func (x QueryValidate_FilterOperator) String() string
func (QueryValidate_FilterOperator) Type ¶ added in v0.6.0
func (QueryValidate_FilterOperator) Type() protoreflect.EnumType
type QueryValidate_Filtering ¶ added in v0.3.0
type QueryValidate_Filtering struct { Allow []QueryValidate_FilterOperator `protobuf:"varint,1,rep,packed,name=allow,proto3,enum=atlas.query.QueryValidate_FilterOperator" json:"allow,omitempty"` Deny []QueryValidate_FilterOperator `protobuf:"varint,2,rep,packed,name=deny,proto3,enum=atlas.query.QueryValidate_FilterOperator" json:"deny,omitempty"` // contains filtered or unexported fields }
func (*QueryValidate_Filtering) Descriptor
deprecated
added in
v0.3.0
func (*QueryValidate_Filtering) Descriptor() ([]byte, []int)
Deprecated: Use QueryValidate_Filtering.ProtoReflect.Descriptor instead.
func (*QueryValidate_Filtering) GetAllow ¶ added in v0.3.0
func (x *QueryValidate_Filtering) GetAllow() []QueryValidate_FilterOperator
func (*QueryValidate_Filtering) GetDeny ¶ added in v0.3.0
func (x *QueryValidate_Filtering) GetDeny() []QueryValidate_FilterOperator
func (*QueryValidate_Filtering) ProtoMessage ¶ added in v0.3.0
func (*QueryValidate_Filtering) ProtoMessage()
func (*QueryValidate_Filtering) ProtoReflect ¶ added in v0.6.0
func (x *QueryValidate_Filtering) ProtoReflect() protoreflect.Message
func (*QueryValidate_Filtering) Reset ¶ added in v0.3.0
func (x *QueryValidate_Filtering) Reset()
func (*QueryValidate_Filtering) String ¶ added in v0.3.0
func (x *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"` // contains filtered or unexported fields }
func (*QueryValidate_Sorting) Descriptor
deprecated
added in
v0.3.0
func (*QueryValidate_Sorting) Descriptor() ([]byte, []int)
Deprecated: Use QueryValidate_Sorting.ProtoReflect.Descriptor instead.
func (*QueryValidate_Sorting) GetDisable ¶ added in v0.3.0
func (x *QueryValidate_Sorting) GetDisable() bool
func (*QueryValidate_Sorting) ProtoMessage ¶ added in v0.3.0
func (*QueryValidate_Sorting) ProtoMessage()
func (*QueryValidate_Sorting) ProtoReflect ¶ added in v0.6.0
func (x *QueryValidate_Sorting) ProtoReflect() protoreflect.Message
func (*QueryValidate_Sorting) Reset ¶ added in v0.3.0
func (x *QueryValidate_Sorting) Reset()
func (*QueryValidate_Sorting) String ¶ added in v0.3.0
func (x *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) Descriptor ¶ added in v0.6.0
func (QueryValidate_ValueType) Descriptor() protoreflect.EnumDescriptor
func (QueryValidate_ValueType) Enum ¶ added in v0.3.0
func (x QueryValidate_ValueType) Enum() *QueryValidate_ValueType
func (QueryValidate_ValueType) EnumDescriptor
deprecated
added in
v0.3.0
func (QueryValidate_ValueType) EnumDescriptor() ([]byte, []int)
Deprecated: Use QueryValidate_ValueType.Descriptor instead.
func (QueryValidate_ValueType) Number ¶ added in v0.6.0
func (x QueryValidate_ValueType) Number() protoreflect.EnumNumber
func (QueryValidate_ValueType) String ¶ added in v0.3.0
func (x QueryValidate_ValueType) String() string
func (QueryValidate_ValueType) Type ¶ added in v0.6.0
func (QueryValidate_ValueType) Type() protoreflect.EnumType