options

Documentation

Overview

Package options is a generated protocol buffer package.

It is generated from these files:

options/collection_permissions.proto

It has these top-level messages:

CollectionPermissions
FilterOptions
FieldPermissions
MethodOptions

Index

• Variables
• func ValidateFilteringPermissions(f *query.Filtering, objName string, ...) error
• func ValidateSortingPermissions(p *query.Sorting, objName string, perms map[string]map[string]FilteringOption) error
• type CollectionPermissions
  • func (*CollectionPermissions) Descriptor() ([]byte, []int)
  • func (m *CollectionPermissions) GetDisableSorting() bool
  • func (m *CollectionPermissions) GetFilters() *FilterOptions
  • func (*CollectionPermissions) ProtoMessage()
  • func (m *CollectionPermissions) Reset()
  • func (m *CollectionPermissions) String() string
• type FieldPermissions
  • func (*FieldPermissions) Descriptor() ([]byte, []int)
  • func (m *FieldPermissions) GetDisableSorting() bool
  • func (m *FieldPermissions) GetFilters() *FilterOptions
  • func (m *FieldPermissions) GetName() string
  • func (*FieldPermissions) ProtoMessage()
  • func (m *FieldPermissions) Reset()
  • func (m *FieldPermissions) String() string
• type FilterOptions
  • func (*FilterOptions) Descriptor() ([]byte, []int)
  • func (m *FilterOptions) GetAllow() string
  • func (m *FilterOptions) GetDeny() string
  • func (m *FilterOptions) GetOperators() isFilterOptions_Operators
  • func (*FilterOptions) ProtoMessage()
  • func (m *FilterOptions) Reset()
  • func (m *FilterOptions) String() string
  • func (*FilterOptions) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
• type FilterOptions_Allow
• type FilterOptions_Deny
• type FilteringOption
• type FilteringOptions
• type MethodOptions
  • func (*MethodOptions) Descriptor() ([]byte, []int)
  • func (m *MethodOptions) GetAllowMissingFields() bool
  • func (m *MethodOptions) GetFields() []*FieldPermissions
  • func (m *MethodOptions) GetForMessage() string
  • func (*MethodOptions) ProtoMessage()
  • func (m *MethodOptions) Reset()
  • func (m *MethodOptions) String() string

Variables

var E_MethodPermissions = &proto.ExtensionDesc{
	ExtendedType:  (*google_protobuf.MethodOptions)(nil),
	ExtensionType: (*MethodOptions)(nil),
	Field:         52121,
	Name:          "atlas.query.method_permissions",
	Tag:           "bytes,52121,opt,name=method_permissions,json=methodPermissions",
	Filename:      "options/collection_permissions.proto",
}

var E_Permissions = &proto.ExtensionDesc{
	ExtendedType:  (*google_protobuf.FieldOptions)(nil),
	ExtensionType: (*CollectionPermissions)(nil),
	Field:         52121,
	Name:          "atlas.query.permissions",
	Tag:           "bytes,52121,opt,name=permissions",
	Filename:      "options/collection_permissions.proto",
}

Functions

func ValidateFilteringPermissions

func ValidateFilteringPermissions(f *query.Filtering, objName string, perms map[string]map[string]FilteringOption) error

func ValidateSortingPermissions

func ValidateSortingPermissions(p *query.Sorting, objName string, perms map[string]map[string]FilteringOption) error

Types

type CollectionPermissions

type CollectionPermissions struct {
	DisableSorting   *bool          `protobuf:"varint,1,opt,name=disable_sorting,json=disableSorting" json:"disable_sorting,omitempty"`
	Filters          *FilterOptions `protobuf:"bytes,2,opt,name=filters" json:"filters,omitempty"`
	XXX_unrecognized []byte         `json:"-"`
}

func (*CollectionPermissions) Descriptor

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

func (*CollectionPermissions) GetDisableSorting

func (m *CollectionPermissions) GetDisableSorting() bool

func (*CollectionPermissions) GetFilters

func (m *CollectionPermissions) GetFilters() *FilterOptions

func (*CollectionPermissions) ProtoMessage

func (*CollectionPermissions) ProtoMessage()

func (*CollectionPermissions) Reset

func (m *CollectionPermissions) Reset()

func (*CollectionPermissions) String

func (m *CollectionPermissions) String() string

type FieldPermissions

type FieldPermissions struct {
	Name             *string        `protobuf:"bytes,1,req,name=name" json:"name,omitempty"`
	DisableSorting   *bool          `protobuf:"varint,2,opt,name=disable_sorting,json=disableSorting" json:"disable_sorting,omitempty"`
	Filters          *FilterOptions `protobuf:"bytes,3,opt,name=filters" json:"filters,omitempty"`
	XXX_unrecognized []byte         `json:"-"`
}

func (*FieldPermissions) Descriptor

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

func (*FieldPermissions) GetDisableSorting

func (m *FieldPermissions) GetDisableSorting() bool

func (*FieldPermissions) GetFilters

func (m *FieldPermissions) GetFilters() *FilterOptions

func (*FieldPermissions) GetName

func (m *FieldPermissions) GetName() string

func (*FieldPermissions) ProtoMessage

func (*FieldPermissions) ProtoMessage()

func (*FieldPermissions) Reset

func (m *FieldPermissions) Reset()

func (*FieldPermissions) String

func (m *FieldPermissions) String() string

type FilterOptions

type FilterOptions struct {
	// Types that are valid to be assigned to Operators:
	//	*FilterOptions_Allow
	//	*FilterOptions_Deny
	Operators        isFilterOptions_Operators `protobuf_oneof:"operators"`
	XXX_unrecognized []byte                    `json:"-"`
}

func (*FilterOptions) Descriptor

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

func (*FilterOptions) GetAllow

func (m *FilterOptions) GetAllow() string

func (*FilterOptions) GetDeny

func (m *FilterOptions) GetDeny() string

func (*FilterOptions) GetOperators

func (m *FilterOptions) GetOperators() isFilterOptions_Operators

func (*FilterOptions) ProtoMessage

func (*FilterOptions) ProtoMessage()

func (*FilterOptions) Reset

func (m *FilterOptions) Reset()

func (*FilterOptions) String

func (m *FilterOptions) String() string

func (*FilterOptions) XXX_OneofFuncs

func (*FilterOptions) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type FilterOptions_Allow

type FilterOptions_Allow struct {
	Allow string `protobuf:"bytes,1,opt,name=allow,oneof"`
}

type FilterOptions_Deny

type FilterOptions_Deny struct {
	Deny string `protobuf:"bytes,2,opt,name=deny,oneof"`
}

type FilteringOption

type FilteringOption struct {
	DisableSorting bool
	Deny           []string
}

type FilteringOptions

type FilteringOptions struct {
	AllowMissingFields bool
	Options            map[string]FilteringOption
}

type MethodOptions

type MethodOptions struct {
	ForMessage         *string             `protobuf:"bytes,1,opt,name=for_message,json=forMessage" json:"for_message,omitempty"`
	Fields             []*FieldPermissions `protobuf:"bytes,2,rep,name=fields" json:"fields,omitempty"`
	AllowMissingFields *bool               `protobuf:"varint,3,opt,name=allow_missing_fields,json=allowMissingFields" json:"allow_missing_fields,omitempty"`
	XXX_unrecognized   []byte              `json:"-"`
}

func (*MethodOptions) Descriptor

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

func (*MethodOptions) GetAllowMissingFields

func (m *MethodOptions) GetAllowMissingFields() bool

func (*MethodOptions) GetFields

func (m *MethodOptions) GetFields() []*FieldPermissions

func (*MethodOptions) GetForMessage

func (m *MethodOptions) GetForMessage() string

func (*MethodOptions) ProtoMessage

func (*MethodOptions) ProtoMessage()

func (*MethodOptions) Reset

func (m *MethodOptions) Reset()

func (*MethodOptions) String

func (m *MethodOptions) String() string