acl

package

v0.0.0-...-0fffe9f Latest Latest Go to latest Published: Feb 23, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/appbaseio/reactivesearch-api

Links

Open Source Insights

Documentation ¶

Index ¶

func ACLStrings() []string
func Contains(acls []ACL, acl ACL) bool
func NewContext(ctx context.Context, acl *ACL) context.Context
type ACL

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ACLStrings ¶

func ACLStrings() []string

ACLStrings returns a slice of all String values of the enum

func Contains ¶

func Contains(acls []ACL, acl ACL) bool

Contains checks if the given slice of category contains the given acl.

func NewContext ¶

func NewContext(ctx context.Context, acl *ACL) context.Context

NewContext returns a new context with the given ACL.

Types ¶

type ACL ¶

type ACL int

ACL is a type that represents an elasticsearch acl.

const (
	Cat ACL = iota
	Bulk
	Cluster
	Search
	Remote
	Create
	Count
	Scripts
	Delete
	Doc
	Source
	FieldCaps
	Close
	Analyze
	Exists
	Get
	Template
	Explain
	Indices
	Alias
	Aliases
	DeleteByQuery
	Cache
	Index
	Mapping
	Flush
	Forcemerge
	Upgrade
	Settings
	Open
	Recovery
	Mappings
	Rollover
	Refresh
	Segments
	Shrink
	Split
	ShardStores
	Stats
	Ingest
	Validate
	Msearch
	Mget
	Nodes
	Mtermvectors
	Reindex
	UpdateByQuery
	Render
	RankEval
	SearchShards
	Snapshot
	Tasks
	Termvectors
	Update
)

Elasticsearch request Categories.

func ACLString ¶

func ACLString(s string) (ACL, error)

ACLString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func ACLValues ¶

func ACLValues() []ACL

ACLValues returns all values of the enum

func FromContext ¶

func FromContext(ctx context.Context) (*ACL, error)

FromContext retrieves the acl stored against the acl.CtxKey from the context.

func (ACL) IsAACL ¶

func (i ACL) IsAACL() bool

IsAACL returns "true" if the value is listed in the enum definition. "false" otherwise

func (ACL) JSONSchema ¶

func (a ACL) JSONSchema() *jsonschema.Schema

func (ACL) MarshalJSON ¶

func (i ACL) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ACL

func (ACL) String ¶

func (i ACL) String() string

func (*ACL) UnmarshalJSON ¶

func (i *ACL) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ACL

Source Files ¶

View all Source files

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