options

package
v0.0.0-...-9c7b1c4 Latest Latest
Warning

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

Go to latest
Published: Dec 18, 2019 License: Apache-2.0, Apache-2.0 Imports: 7 Imported by: 0

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

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

func ValidateFieldSelection(fs *query.FieldSelection, allowedFields []string) error

func ValidateFiltering

func ValidateFiltering(f *query.Filtering, messageInfo map[string]FilteringOption) error

func ValidateSorting

func ValidateSorting(p *query.Sorting, fields []string) 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

type MessageQueryValidate struct {
	Validate []*MessageQueryValidate_QueryValidateEntry `protobuf:"bytes,1,rep,name=validate" json:"validate,omitempty"`
}

func (*MessageQueryValidate) Descriptor

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

func (*MessageQueryValidate) GetValidate

func (*MessageQueryValidate) ProtoMessage

func (*MessageQueryValidate) ProtoMessage()

func (*MessageQueryValidate) Reset

func (m *MessageQueryValidate) Reset()

func (*MessageQueryValidate) String

func (m *MessageQueryValidate) String() string

type MessageQueryValidate_QueryValidateEntry

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

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

func (*MessageQueryValidate_QueryValidateEntry) GetName

func (*MessageQueryValidate_QueryValidateEntry) GetValue

func (*MessageQueryValidate_QueryValidateEntry) ProtoMessage

func (*MessageQueryValidate_QueryValidateEntry) Reset

func (*MessageQueryValidate_QueryValidateEntry) String

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"`
	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

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

func (*QueryValidate) GetEnableNestedFields

func (m *QueryValidate) GetEnableNestedFields() bool

func (*QueryValidate) GetFieldSelection

func (m *QueryValidate) GetFieldSelection() *QueryValidate_FieldSelection

func (*QueryValidate) GetFiltering

func (m *QueryValidate) GetFiltering() *QueryValidate_Filtering

func (*QueryValidate) GetNestedFields

func (m *QueryValidate) GetNestedFields() []string

func (*QueryValidate) GetSorting

func (m *QueryValidate) GetSorting() *QueryValidate_Sorting

func (*QueryValidate) GetValueType

func (m *QueryValidate) GetValueType() QueryValidate_ValueType

func (*QueryValidate) GetValueTypeUrl

func (m *QueryValidate) GetValueTypeUrl() string

func (*QueryValidate) ProtoMessage

func (*QueryValidate) ProtoMessage()

func (*QueryValidate) Reset

func (m *QueryValidate) Reset()

func (*QueryValidate) String

func (m *QueryValidate) String() string

type QueryValidate_FieldSelection

type QueryValidate_FieldSelection struct {
	Disable bool `protobuf:"varint,1,opt,name=disable,proto3" json:"disable,omitempty"`
}

func (*QueryValidate_FieldSelection) Descriptor

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

func (*QueryValidate_FieldSelection) GetDisable

func (m *QueryValidate_FieldSelection) GetDisable() bool

func (*QueryValidate_FieldSelection) ProtoMessage

func (*QueryValidate_FieldSelection) ProtoMessage()

func (*QueryValidate_FieldSelection) Reset

func (m *QueryValidate_FieldSelection) Reset()

func (*QueryValidate_FieldSelection) 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
	QueryValidate_IEQ   QueryValidate_FilterOperator = 7
	QueryValidate_IN    QueryValidate_FilterOperator = 8
)

func (QueryValidate_FilterOperator) EnumDescriptor

func (QueryValidate_FilterOperator) EnumDescriptor() ([]byte, []int)

func (QueryValidate_FilterOperator) String

type QueryValidate_Filtering

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

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

func (*QueryValidate_Filtering) GetAllow

func (*QueryValidate_Filtering) GetDeny

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,proto3" json:"disable,omitempty"`
}

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
	QueryValidate_BOOL    QueryValidate_ValueType = 3
)

func (QueryValidate_ValueType) EnumDescriptor

func (QueryValidate_ValueType) EnumDescriptor() ([]byte, []int)

func (QueryValidate_ValueType) String

func (x QueryValidate_ValueType) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL