matcher

package
Version: v0.0.0-...-113c6ea Latest Latest
Warning

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

Go to latest
Published: Nov 27, 2019 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Overview

Package matcher is a generated protocol buffer package.

It is generated from these files:

envoy/type/matcher/metadata.proto
envoy/type/matcher/number.proto
envoy/type/matcher/string.proto

It has these top-level messages:

MetadataMatcher
DoubleMatcher
StringMatcher

Index

Constants

This section is empty.

Variables

View Source
var (
	ErrInvalidLengthMetadata = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowMetadata   = fmt.Errorf("proto: integer overflow")
)
View Source
var (
	ErrInvalidLengthNumber = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowNumber   = fmt.Errorf("proto: integer overflow")
)
View Source
var (
	ErrInvalidLengthString = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowString   = fmt.Errorf("proto: integer overflow")
)

Functions

This section is empty.

Types

type DoubleMatcher

type DoubleMatcher struct {
	// Types that are valid to be assigned to MatchPattern:
	//	*DoubleMatcher_Range
	//	*DoubleMatcher_Exact
	MatchPattern isDoubleMatcher_MatchPattern `protobuf_oneof:"match_pattern"`
}

Specifies the way to match a double value.

func (*DoubleMatcher) Descriptor

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

func (*DoubleMatcher) GetExact

func (m *DoubleMatcher) GetExact() float64

func (*DoubleMatcher) GetMatchPattern

func (m *DoubleMatcher) GetMatchPattern() isDoubleMatcher_MatchPattern

func (*DoubleMatcher) GetRange

func (m *DoubleMatcher) GetRange() *envoy_type.DoubleRange

func (*DoubleMatcher) Marshal

func (m *DoubleMatcher) Marshal() (dAtA []byte, err error)

func (*DoubleMatcher) MarshalTo

func (m *DoubleMatcher) MarshalTo(dAtA []byte) (int, error)

func (*DoubleMatcher) ProtoMessage

func (*DoubleMatcher) ProtoMessage()

func (*DoubleMatcher) Reset

func (m *DoubleMatcher) Reset()

func (*DoubleMatcher) Size

func (m *DoubleMatcher) Size() (n int)

func (*DoubleMatcher) String

func (m *DoubleMatcher) String() string

func (*DoubleMatcher) Unmarshal

func (m *DoubleMatcher) Unmarshal(dAtA []byte) error

func (*DoubleMatcher) Validate

func (m *DoubleMatcher) Validate() error

Validate checks the field values on DoubleMatcher with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*DoubleMatcher) XXX_OneofFuncs

func (*DoubleMatcher) 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 DoubleMatcherValidationError

type DoubleMatcherValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

DoubleMatcherValidationError is the validation error returned by DoubleMatcher.Validate if the designated constraints aren't met.

func (DoubleMatcherValidationError) Error

Error satisfies the builtin error interface

type DoubleMatcher_Exact

type DoubleMatcher_Exact struct {
	Exact float64 `protobuf:"fixed64,2,opt,name=exact,proto3,oneof"`
}

func (*DoubleMatcher_Exact) MarshalTo

func (m *DoubleMatcher_Exact) MarshalTo(dAtA []byte) (int, error)

func (*DoubleMatcher_Exact) Size

func (m *DoubleMatcher_Exact) Size() (n int)

type DoubleMatcher_Range

type DoubleMatcher_Range struct {
	Range *envoy_type.DoubleRange `protobuf:"bytes,1,opt,name=range,oneof"`
}

func (*DoubleMatcher_Range) MarshalTo

func (m *DoubleMatcher_Range) MarshalTo(dAtA []byte) (int, error)

func (*DoubleMatcher_Range) Size

func (m *DoubleMatcher_Range) Size() (n int)

type MetadataMatcher

type MetadataMatcher struct {
	// The filter name to retrieve the Struct from the Metadata.
	Filter string `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// The path to retrieve the Value from the Struct.
	Path []*MetadataMatcher_PathSegment `protobuf:"bytes,2,rep,name=path" json:"path,omitempty"`
	// The MetadataMatcher is matched if the value retrieved by path is matched to this value.
	Value *MetadataMatcher_Value `protobuf:"bytes,3,opt,name=value" json:"value,omitempty"`
}

MetadataMatcher provides a general interface to check if a given value is matched in :ref:`Metadata <envoy_api_msg_core.Metadata>`. It uses `filter` and `path` to retrieve the value from the Metadata and then check if it's matched to the specified value.

For example, for the following Metadata:

.. code-block:: yaml

filter_metadata:
  envoy.filters.http.rbac:
    fields:
      a:
        struct_value:
          fields:
            b:
              struct_value:
                fields:
                  c:
                    string_value: pro
            t:
              list_value:
                values:
                  - string_value: m
                  - string_value: n

The following MetadataMatcher is matched as the path [a, b, c] will retrieve a string value "pro" from the Metadata which is matched to the specified prefix match.

.. code-block:: yaml

filter: envoy.filters.http.rbac
path:
- key: a
- key: b
- key: c
value:
  string_match:
    prefix: pr

The following MetadataMatcher is not matched as the path [a, t] is pointing to a list value in the Metadata which is not supported for now.

.. code-block:: yaml

filter: envoy.filters.http.rbac
path:
- key: a
- key: t
value:
  string_match:
    exact: m

An example use of MetadataMatcher is specifying additional metadata in envoy.filters.http.rbac to enforce access control based on dynamic metadata in a request. See :ref:`Permission <envoy_api_msg_config.rbac.v2alpha.Permission>` and :ref:`Principal <envoy_api_msg_config.rbac.v2alpha.Principal>`.

func (*MetadataMatcher) Descriptor

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

func (*MetadataMatcher) GetFilter

func (m *MetadataMatcher) GetFilter() string

func (*MetadataMatcher) GetPath

func (*MetadataMatcher) GetValue

func (m *MetadataMatcher) GetValue() *MetadataMatcher_Value

func (*MetadataMatcher) Marshal

func (m *MetadataMatcher) Marshal() (dAtA []byte, err error)

func (*MetadataMatcher) MarshalTo

func (m *MetadataMatcher) MarshalTo(dAtA []byte) (int, error)

func (*MetadataMatcher) ProtoMessage

func (*MetadataMatcher) ProtoMessage()

func (*MetadataMatcher) Reset

func (m *MetadataMatcher) Reset()

func (*MetadataMatcher) Size

func (m *MetadataMatcher) Size() (n int)

func (*MetadataMatcher) String

func (m *MetadataMatcher) String() string

func (*MetadataMatcher) Unmarshal

func (m *MetadataMatcher) Unmarshal(dAtA []byte) error

func (*MetadataMatcher) Validate

func (m *MetadataMatcher) Validate() error

Validate checks the field values on MetadataMatcher with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type MetadataMatcherValidationError

type MetadataMatcherValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

MetadataMatcherValidationError is the validation error returned by MetadataMatcher.Validate if the designated constraints aren't met.

func (MetadataMatcherValidationError) Error

Error satisfies the builtin error interface

type MetadataMatcher_PathSegment

type MetadataMatcher_PathSegment struct {
	// Types that are valid to be assigned to Segment:
	//	*MetadataMatcher_PathSegment_Key
	Segment isMetadataMatcher_PathSegment_Segment `protobuf_oneof:"segment"`
}

Specifies the segment in a path to retrieve value from Metadata. Note: Currently it's not supported to retrieve a value from a list in Metadata. This means it will always be not matched if the associated value of the key is a list.

func (*MetadataMatcher_PathSegment) Descriptor

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

func (*MetadataMatcher_PathSegment) GetKey

func (m *MetadataMatcher_PathSegment) GetKey() string

func (*MetadataMatcher_PathSegment) GetSegment

func (m *MetadataMatcher_PathSegment) GetSegment() isMetadataMatcher_PathSegment_Segment

func (*MetadataMatcher_PathSegment) Marshal

func (m *MetadataMatcher_PathSegment) Marshal() (dAtA []byte, err error)

func (*MetadataMatcher_PathSegment) MarshalTo

func (m *MetadataMatcher_PathSegment) MarshalTo(dAtA []byte) (int, error)

func (*MetadataMatcher_PathSegment) ProtoMessage

func (*MetadataMatcher_PathSegment) ProtoMessage()

func (*MetadataMatcher_PathSegment) Reset

func (m *MetadataMatcher_PathSegment) Reset()

func (*MetadataMatcher_PathSegment) Size

func (m *MetadataMatcher_PathSegment) Size() (n int)

func (*MetadataMatcher_PathSegment) String

func (m *MetadataMatcher_PathSegment) String() string

func (*MetadataMatcher_PathSegment) Unmarshal

func (m *MetadataMatcher_PathSegment) Unmarshal(dAtA []byte) error

func (*MetadataMatcher_PathSegment) Validate

func (m *MetadataMatcher_PathSegment) Validate() error

Validate checks the field values on MetadataMatcher_PathSegment with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*MetadataMatcher_PathSegment) XXX_OneofFuncs

func (*MetadataMatcher_PathSegment) 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 MetadataMatcher_PathSegmentValidationError

type MetadataMatcher_PathSegmentValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

MetadataMatcher_PathSegmentValidationError is the validation error returned by MetadataMatcher_PathSegment.Validate if the designated constraints aren't met.

func (MetadataMatcher_PathSegmentValidationError) Error

Error satisfies the builtin error interface

type MetadataMatcher_PathSegment_Key

type MetadataMatcher_PathSegment_Key struct {
	Key string `protobuf:"bytes,1,opt,name=key,proto3,oneof"`
}

func (*MetadataMatcher_PathSegment_Key) MarshalTo

func (m *MetadataMatcher_PathSegment_Key) MarshalTo(dAtA []byte) (int, error)

func (*MetadataMatcher_PathSegment_Key) Size

func (m *MetadataMatcher_PathSegment_Key) Size() (n int)

type MetadataMatcher_Value

type MetadataMatcher_Value struct {
	// Specifies how to match a value.
	//
	// Types that are valid to be assigned to MatchPattern:
	//	*MetadataMatcher_Value_NullMatch_
	//	*MetadataMatcher_Value_DoubleMatch
	//	*MetadataMatcher_Value_StringMatch
	//	*MetadataMatcher_Value_BoolMatch
	//	*MetadataMatcher_Value_PresentMatch
	MatchPattern isMetadataMatcher_Value_MatchPattern `protobuf_oneof:"match_pattern"`
}

Specifies the value to match. Only primitive value are supported. For non-primitive values, the result is always not matched.

func (*MetadataMatcher_Value) Descriptor

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

func (*MetadataMatcher_Value) GetBoolMatch

func (m *MetadataMatcher_Value) GetBoolMatch() bool

func (*MetadataMatcher_Value) GetDoubleMatch

func (m *MetadataMatcher_Value) GetDoubleMatch() *DoubleMatcher

func (*MetadataMatcher_Value) GetMatchPattern

func (m *MetadataMatcher_Value) GetMatchPattern() isMetadataMatcher_Value_MatchPattern

func (*MetadataMatcher_Value) GetNullMatch

func (*MetadataMatcher_Value) GetPresentMatch

func (m *MetadataMatcher_Value) GetPresentMatch() bool

func (*MetadataMatcher_Value) GetStringMatch

func (m *MetadataMatcher_Value) GetStringMatch() *StringMatcher

func (*MetadataMatcher_Value) Marshal

func (m *MetadataMatcher_Value) Marshal() (dAtA []byte, err error)

func (*MetadataMatcher_Value) MarshalTo

func (m *MetadataMatcher_Value) MarshalTo(dAtA []byte) (int, error)

func (*MetadataMatcher_Value) ProtoMessage

func (*MetadataMatcher_Value) ProtoMessage()

func (*MetadataMatcher_Value) Reset

func (m *MetadataMatcher_Value) Reset()

func (*MetadataMatcher_Value) Size

func (m *MetadataMatcher_Value) Size() (n int)

func (*MetadataMatcher_Value) String

func (m *MetadataMatcher_Value) String() string

func (*MetadataMatcher_Value) Unmarshal

func (m *MetadataMatcher_Value) Unmarshal(dAtA []byte) error

func (*MetadataMatcher_Value) Validate

func (m *MetadataMatcher_Value) Validate() error

Validate checks the field values on MetadataMatcher_Value with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*MetadataMatcher_Value) XXX_OneofFuncs

func (*MetadataMatcher_Value) 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 MetadataMatcher_ValueValidationError

type MetadataMatcher_ValueValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

MetadataMatcher_ValueValidationError is the validation error returned by MetadataMatcher_Value.Validate if the designated constraints aren't met.

func (MetadataMatcher_ValueValidationError) Error

Error satisfies the builtin error interface

type MetadataMatcher_Value_BoolMatch

type MetadataMatcher_Value_BoolMatch struct {
	BoolMatch bool `protobuf:"varint,4,opt,name=bool_match,json=boolMatch,proto3,oneof"`
}

func (*MetadataMatcher_Value_BoolMatch) MarshalTo

func (m *MetadataMatcher_Value_BoolMatch) MarshalTo(dAtA []byte) (int, error)

func (*MetadataMatcher_Value_BoolMatch) Size

func (m *MetadataMatcher_Value_BoolMatch) Size() (n int)

type MetadataMatcher_Value_DoubleMatch

type MetadataMatcher_Value_DoubleMatch struct {
	DoubleMatch *DoubleMatcher `protobuf:"bytes,2,opt,name=double_match,json=doubleMatch,oneof"`
}

func (*MetadataMatcher_Value_DoubleMatch) MarshalTo

func (m *MetadataMatcher_Value_DoubleMatch) MarshalTo(dAtA []byte) (int, error)

func (*MetadataMatcher_Value_DoubleMatch) Size

func (m *MetadataMatcher_Value_DoubleMatch) Size() (n int)

type MetadataMatcher_Value_NullMatch

type MetadataMatcher_Value_NullMatch struct {
}

NullMatch is an empty message to specify a null value.

func (*MetadataMatcher_Value_NullMatch) Descriptor

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

func (*MetadataMatcher_Value_NullMatch) Marshal

func (m *MetadataMatcher_Value_NullMatch) Marshal() (dAtA []byte, err error)

func (*MetadataMatcher_Value_NullMatch) MarshalTo

func (m *MetadataMatcher_Value_NullMatch) MarshalTo(dAtA []byte) (int, error)

func (*MetadataMatcher_Value_NullMatch) ProtoMessage

func (*MetadataMatcher_Value_NullMatch) ProtoMessage()

func (*MetadataMatcher_Value_NullMatch) Reset

func (*MetadataMatcher_Value_NullMatch) Size

func (m *MetadataMatcher_Value_NullMatch) Size() (n int)

func (*MetadataMatcher_Value_NullMatch) String

func (*MetadataMatcher_Value_NullMatch) Unmarshal

func (m *MetadataMatcher_Value_NullMatch) Unmarshal(dAtA []byte) error

func (*MetadataMatcher_Value_NullMatch) Validate

func (m *MetadataMatcher_Value_NullMatch) Validate() error

Validate checks the field values on MetadataMatcher_Value_NullMatch with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type MetadataMatcher_Value_NullMatchValidationError

type MetadataMatcher_Value_NullMatchValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

MetadataMatcher_Value_NullMatchValidationError is the validation error returned by MetadataMatcher_Value_NullMatch.Validate if the designated constraints aren't met.

func (MetadataMatcher_Value_NullMatchValidationError) Error

Error satisfies the builtin error interface

type MetadataMatcher_Value_NullMatch_

type MetadataMatcher_Value_NullMatch_ struct {
	NullMatch *MetadataMatcher_Value_NullMatch `protobuf:"bytes,1,opt,name=null_match,json=nullMatch,oneof"`
}

func (*MetadataMatcher_Value_NullMatch_) MarshalTo

func (m *MetadataMatcher_Value_NullMatch_) MarshalTo(dAtA []byte) (int, error)

func (*MetadataMatcher_Value_NullMatch_) Size

func (m *MetadataMatcher_Value_NullMatch_) Size() (n int)

type MetadataMatcher_Value_PresentMatch

type MetadataMatcher_Value_PresentMatch struct {
	PresentMatch bool `protobuf:"varint,5,opt,name=present_match,json=presentMatch,proto3,oneof"`
}

func (*MetadataMatcher_Value_PresentMatch) MarshalTo

func (m *MetadataMatcher_Value_PresentMatch) MarshalTo(dAtA []byte) (int, error)

func (*MetadataMatcher_Value_PresentMatch) Size

type MetadataMatcher_Value_StringMatch

type MetadataMatcher_Value_StringMatch struct {
	StringMatch *StringMatcher `protobuf:"bytes,3,opt,name=string_match,json=stringMatch,oneof"`
}

func (*MetadataMatcher_Value_StringMatch) MarshalTo

func (m *MetadataMatcher_Value_StringMatch) MarshalTo(dAtA []byte) (int, error)

func (*MetadataMatcher_Value_StringMatch) Size

func (m *MetadataMatcher_Value_StringMatch) Size() (n int)

type StringMatcher

type StringMatcher struct {
	// Types that are valid to be assigned to MatchPattern:
	//	*StringMatcher_Exact
	//	*StringMatcher_Prefix
	//	*StringMatcher_Suffix
	//	*StringMatcher_Regex
	MatchPattern isStringMatcher_MatchPattern `protobuf_oneof:"match_pattern"`
}

Specifies the way to match a string.

func (*StringMatcher) Descriptor

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

func (*StringMatcher) GetExact

func (m *StringMatcher) GetExact() string

func (*StringMatcher) GetMatchPattern

func (m *StringMatcher) GetMatchPattern() isStringMatcher_MatchPattern

func (*StringMatcher) GetPrefix

func (m *StringMatcher) GetPrefix() string

func (*StringMatcher) GetRegex

func (m *StringMatcher) GetRegex() string

func (*StringMatcher) GetSuffix

func (m *StringMatcher) GetSuffix() string

func (*StringMatcher) Marshal

func (m *StringMatcher) Marshal() (dAtA []byte, err error)

func (*StringMatcher) MarshalTo

func (m *StringMatcher) MarshalTo(dAtA []byte) (int, error)

func (*StringMatcher) ProtoMessage

func (*StringMatcher) ProtoMessage()

func (*StringMatcher) Reset

func (m *StringMatcher) Reset()

func (*StringMatcher) Size

func (m *StringMatcher) Size() (n int)

func (*StringMatcher) String

func (m *StringMatcher) String() string

func (*StringMatcher) Unmarshal

func (m *StringMatcher) Unmarshal(dAtA []byte) error

func (*StringMatcher) Validate

func (m *StringMatcher) Validate() error

Validate checks the field values on StringMatcher with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*StringMatcher) XXX_OneofFuncs

func (*StringMatcher) 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 StringMatcherValidationError

type StringMatcherValidationError struct {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

StringMatcherValidationError is the validation error returned by StringMatcher.Validate if the designated constraints aren't met.

func (StringMatcherValidationError) Error

Error satisfies the builtin error interface

type StringMatcher_Exact

type StringMatcher_Exact struct {
	Exact string `protobuf:"bytes,1,opt,name=exact,proto3,oneof"`
}

func (*StringMatcher_Exact) MarshalTo

func (m *StringMatcher_Exact) MarshalTo(dAtA []byte) (int, error)

func (*StringMatcher_Exact) Size

func (m *StringMatcher_Exact) Size() (n int)

type StringMatcher_Prefix

type StringMatcher_Prefix struct {
	Prefix string `protobuf:"bytes,2,opt,name=prefix,proto3,oneof"`
}

func (*StringMatcher_Prefix) MarshalTo

func (m *StringMatcher_Prefix) MarshalTo(dAtA []byte) (int, error)

func (*StringMatcher_Prefix) Size

func (m *StringMatcher_Prefix) Size() (n int)

type StringMatcher_Regex

type StringMatcher_Regex struct {
	Regex string `protobuf:"bytes,4,opt,name=regex,proto3,oneof"`
}

func (*StringMatcher_Regex) MarshalTo

func (m *StringMatcher_Regex) MarshalTo(dAtA []byte) (int, error)

func (*StringMatcher_Regex) Size

func (m *StringMatcher_Regex) Size() (n int)

type StringMatcher_Suffix

type StringMatcher_Suffix struct {
	Suffix string `protobuf:"bytes,3,opt,name=suffix,proto3,oneof"`
}

func (*StringMatcher_Suffix) MarshalTo

func (m *StringMatcher_Suffix) MarshalTo(dAtA []byte) (int, error)

func (*StringMatcher_Suffix) Size

func (m *StringMatcher_Suffix) Size() (n int)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL