Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_envoy_config_common_matcher_v3_matcher_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type HttpGenericBodyMatch

type HttpGenericBodyMatch struct {

	// Limits search to specified number of bytes - default zero (no limit - match entire captured buffer).
	BytesLimit uint32 `protobuf:"varint,1,opt,name=bytes_limit,json=bytesLimit,proto3" json:"bytes_limit,omitempty"`
	// List of patterns to match.
	Patterns []*HttpGenericBodyMatch_GenericTextMatch `protobuf:"bytes,2,rep,name=patterns,proto3" json:"patterns,omitempty"`
	// contains filtered or unexported fields
}

    HTTP generic body match configuration. List of text strings and hex strings to be located in HTTP body. All specified strings must be found in the HTTP body for positive match. The search may be limited to specified number of bytes from the body start.

    .. attention::

    Searching for patterns in HTTP body is potentially cpu intensive. For each specified pattern, http body is scanned byte by byte to find a match.
    If multiple patterns are specified, the process is repeated for each pattern. If location of a pattern is known, “bytes_limit“ should be specified
    to scan only part of the http body.
    

    func (*HttpGenericBodyMatch) Descriptor

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

      Deprecated: Use HttpGenericBodyMatch.ProtoReflect.Descriptor instead.

      func (*HttpGenericBodyMatch) GetBytesLimit

      func (x *HttpGenericBodyMatch) GetBytesLimit() uint32

      func (*HttpGenericBodyMatch) GetPatterns

      func (*HttpGenericBodyMatch) ProtoMessage

      func (*HttpGenericBodyMatch) ProtoMessage()

      func (*HttpGenericBodyMatch) ProtoReflect

      func (x *HttpGenericBodyMatch) ProtoReflect() protoreflect.Message

      func (*HttpGenericBodyMatch) Reset

      func (x *HttpGenericBodyMatch) Reset()

      func (*HttpGenericBodyMatch) String

      func (x *HttpGenericBodyMatch) String() string

      func (*HttpGenericBodyMatch) Validate

      func (m *HttpGenericBodyMatch) Validate() error

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

        type HttpGenericBodyMatchValidationError

        type HttpGenericBodyMatchValidationError struct {
        	// contains filtered or unexported fields
        }

          HttpGenericBodyMatchValidationError is the validation error returned by HttpGenericBodyMatch.Validate if the designated constraints aren't met.

          func (HttpGenericBodyMatchValidationError) Cause

            Cause function returns cause value.

            func (HttpGenericBodyMatchValidationError) Error

              Error satisfies the builtin error interface

              func (HttpGenericBodyMatchValidationError) ErrorName

                ErrorName returns error name.

                func (HttpGenericBodyMatchValidationError) Field

                  Field function returns field value.

                  func (HttpGenericBodyMatchValidationError) Key

                    Key function returns key value.

                    func (HttpGenericBodyMatchValidationError) Reason

                      Reason function returns reason value.

                      type HttpGenericBodyMatch_GenericTextMatch

                      type HttpGenericBodyMatch_GenericTextMatch struct {
                      
                      	// Types that are assignable to Rule:
                      	//	*HttpGenericBodyMatch_GenericTextMatch_StringMatch
                      	//	*HttpGenericBodyMatch_GenericTextMatch_BinaryMatch
                      	Rule isHttpGenericBodyMatch_GenericTextMatch_Rule `protobuf_oneof:"rule"`
                      	// contains filtered or unexported fields
                      }

                      func (*HttpGenericBodyMatch_GenericTextMatch) Descriptor

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

                        Deprecated: Use HttpGenericBodyMatch_GenericTextMatch.ProtoReflect.Descriptor instead.

                        func (*HttpGenericBodyMatch_GenericTextMatch) GetBinaryMatch

                        func (x *HttpGenericBodyMatch_GenericTextMatch) GetBinaryMatch() []byte

                        func (*HttpGenericBodyMatch_GenericTextMatch) GetRule

                        func (m *HttpGenericBodyMatch_GenericTextMatch) GetRule() isHttpGenericBodyMatch_GenericTextMatch_Rule

                        func (*HttpGenericBodyMatch_GenericTextMatch) GetStringMatch

                        func (x *HttpGenericBodyMatch_GenericTextMatch) GetStringMatch() string

                        func (*HttpGenericBodyMatch_GenericTextMatch) ProtoMessage

                        func (*HttpGenericBodyMatch_GenericTextMatch) ProtoMessage()

                        func (*HttpGenericBodyMatch_GenericTextMatch) ProtoReflect

                        func (*HttpGenericBodyMatch_GenericTextMatch) Reset

                        func (*HttpGenericBodyMatch_GenericTextMatch) String

                        func (*HttpGenericBodyMatch_GenericTextMatch) Validate

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

                          type HttpGenericBodyMatch_GenericTextMatchValidationError

                          type HttpGenericBodyMatch_GenericTextMatchValidationError struct {
                          	// contains filtered or unexported fields
                          }

                            HttpGenericBodyMatch_GenericTextMatchValidationError is the validation error returned by HttpGenericBodyMatch_GenericTextMatch.Validate if the designated constraints aren't met.

                            func (HttpGenericBodyMatch_GenericTextMatchValidationError) Cause

                              Cause function returns cause value.

                              func (HttpGenericBodyMatch_GenericTextMatchValidationError) Error

                                Error satisfies the builtin error interface

                                func (HttpGenericBodyMatch_GenericTextMatchValidationError) ErrorName

                                  ErrorName returns error name.

                                  func (HttpGenericBodyMatch_GenericTextMatchValidationError) Field

                                    Field function returns field value.

                                    func (HttpGenericBodyMatch_GenericTextMatchValidationError) Key

                                      Key function returns key value.

                                      func (HttpGenericBodyMatch_GenericTextMatchValidationError) Reason

                                        Reason function returns reason value.

                                        type HttpGenericBodyMatch_GenericTextMatch_BinaryMatch

                                        type HttpGenericBodyMatch_GenericTextMatch_BinaryMatch struct {
                                        	// Sequence of bytes to be located in HTTP body.
                                        	BinaryMatch []byte `protobuf:"bytes,2,opt,name=binary_match,json=binaryMatch,proto3,oneof"`
                                        }

                                        type HttpGenericBodyMatch_GenericTextMatch_StringMatch

                                        type HttpGenericBodyMatch_GenericTextMatch_StringMatch struct {
                                        	// Text string to be located in HTTP body.
                                        	StringMatch string `protobuf:"bytes,1,opt,name=string_match,json=stringMatch,proto3,oneof"`
                                        }

                                        type HttpHeadersMatch

                                        type HttpHeadersMatch struct {
                                        
                                        	// HTTP headers to match.
                                        	Headers []*v3.HeaderMatcher `protobuf:"bytes,1,rep,name=headers,proto3" json:"headers,omitempty"`
                                        	// contains filtered or unexported fields
                                        }

                                          HTTP headers match configuration.

                                          func (*HttpHeadersMatch) Descriptor

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

                                            Deprecated: Use HttpHeadersMatch.ProtoReflect.Descriptor instead.

                                            func (*HttpHeadersMatch) GetHeaders

                                            func (x *HttpHeadersMatch) GetHeaders() []*v3.HeaderMatcher

                                            func (*HttpHeadersMatch) ProtoMessage

                                            func (*HttpHeadersMatch) ProtoMessage()

                                            func (*HttpHeadersMatch) ProtoReflect

                                            func (x *HttpHeadersMatch) ProtoReflect() protoreflect.Message

                                            func (*HttpHeadersMatch) Reset

                                            func (x *HttpHeadersMatch) Reset()

                                            func (*HttpHeadersMatch) String

                                            func (x *HttpHeadersMatch) String() string

                                            func (*HttpHeadersMatch) Validate

                                            func (m *HttpHeadersMatch) Validate() error

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

                                              type HttpHeadersMatchValidationError

                                              type HttpHeadersMatchValidationError struct {
                                              	// contains filtered or unexported fields
                                              }

                                                HttpHeadersMatchValidationError is the validation error returned by HttpHeadersMatch.Validate if the designated constraints aren't met.

                                                func (HttpHeadersMatchValidationError) Cause

                                                  Cause function returns cause value.

                                                  func (HttpHeadersMatchValidationError) Error

                                                    Error satisfies the builtin error interface

                                                    func (HttpHeadersMatchValidationError) ErrorName

                                                      ErrorName returns error name.

                                                      func (HttpHeadersMatchValidationError) Field

                                                        Field function returns field value.

                                                        func (HttpHeadersMatchValidationError) Key

                                                          Key function returns key value.

                                                          func (HttpHeadersMatchValidationError) Reason

                                                            Reason function returns reason value.

                                                            type MatchPredicate

                                                            type MatchPredicate struct {
                                                            
                                                            	// Types that are assignable to Rule:
                                                            	//	*MatchPredicate_OrMatch
                                                            	//	*MatchPredicate_AndMatch
                                                            	//	*MatchPredicate_NotMatch
                                                            	//	*MatchPredicate_AnyMatch
                                                            	//	*MatchPredicate_HttpRequestHeadersMatch
                                                            	//	*MatchPredicate_HttpRequestTrailersMatch
                                                            	//	*MatchPredicate_HttpResponseHeadersMatch
                                                            	//	*MatchPredicate_HttpResponseTrailersMatch
                                                            	//	*MatchPredicate_HttpRequestGenericBodyMatch
                                                            	//	*MatchPredicate_HttpResponseGenericBodyMatch
                                                            	Rule isMatchPredicate_Rule `protobuf_oneof:"rule"`
                                                            	// contains filtered or unexported fields
                                                            }

                                                              Match configuration. This is a recursive structure which allows complex nested match configurations to be built using various logical operators. [#next-free-field: 11]

                                                              func (*MatchPredicate) Descriptor

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

                                                                Deprecated: Use MatchPredicate.ProtoReflect.Descriptor instead.

                                                                func (*MatchPredicate) GetAndMatch

                                                                func (x *MatchPredicate) GetAndMatch() *MatchPredicate_MatchSet

                                                                func (*MatchPredicate) GetAnyMatch

                                                                func (x *MatchPredicate) GetAnyMatch() bool

                                                                func (*MatchPredicate) GetHttpRequestGenericBodyMatch

                                                                func (x *MatchPredicate) GetHttpRequestGenericBodyMatch() *HttpGenericBodyMatch

                                                                func (*MatchPredicate) GetHttpRequestHeadersMatch

                                                                func (x *MatchPredicate) GetHttpRequestHeadersMatch() *HttpHeadersMatch

                                                                func (*MatchPredicate) GetHttpRequestTrailersMatch

                                                                func (x *MatchPredicate) GetHttpRequestTrailersMatch() *HttpHeadersMatch

                                                                func (*MatchPredicate) GetHttpResponseGenericBodyMatch

                                                                func (x *MatchPredicate) GetHttpResponseGenericBodyMatch() *HttpGenericBodyMatch

                                                                func (*MatchPredicate) GetHttpResponseHeadersMatch

                                                                func (x *MatchPredicate) GetHttpResponseHeadersMatch() *HttpHeadersMatch

                                                                func (*MatchPredicate) GetHttpResponseTrailersMatch

                                                                func (x *MatchPredicate) GetHttpResponseTrailersMatch() *HttpHeadersMatch

                                                                func (*MatchPredicate) GetNotMatch

                                                                func (x *MatchPredicate) GetNotMatch() *MatchPredicate

                                                                func (*MatchPredicate) GetOrMatch

                                                                func (x *MatchPredicate) GetOrMatch() *MatchPredicate_MatchSet

                                                                func (*MatchPredicate) GetRule

                                                                func (m *MatchPredicate) GetRule() isMatchPredicate_Rule

                                                                func (*MatchPredicate) ProtoMessage

                                                                func (*MatchPredicate) ProtoMessage()

                                                                func (*MatchPredicate) ProtoReflect

                                                                func (x *MatchPredicate) ProtoReflect() protoreflect.Message

                                                                func (*MatchPredicate) Reset

                                                                func (x *MatchPredicate) Reset()

                                                                func (*MatchPredicate) String

                                                                func (x *MatchPredicate) String() string

                                                                func (*MatchPredicate) Validate

                                                                func (m *MatchPredicate) Validate() error

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

                                                                  type MatchPredicateValidationError

                                                                  type MatchPredicateValidationError struct {
                                                                  	// contains filtered or unexported fields
                                                                  }

                                                                    MatchPredicateValidationError is the validation error returned by MatchPredicate.Validate if the designated constraints aren't met.

                                                                    func (MatchPredicateValidationError) Cause

                                                                      Cause function returns cause value.

                                                                      func (MatchPredicateValidationError) Error

                                                                        Error satisfies the builtin error interface

                                                                        func (MatchPredicateValidationError) ErrorName

                                                                        func (e MatchPredicateValidationError) ErrorName() string

                                                                          ErrorName returns error name.

                                                                          func (MatchPredicateValidationError) Field

                                                                            Field function returns field value.

                                                                            func (MatchPredicateValidationError) Key

                                                                              Key function returns key value.

                                                                              func (MatchPredicateValidationError) Reason

                                                                                Reason function returns reason value.

                                                                                type MatchPredicate_AndMatch

                                                                                type MatchPredicate_AndMatch struct {
                                                                                	// A set that describes a logical AND. If all members of the set match, the match configuration
                                                                                	// matches.
                                                                                	AndMatch *MatchPredicate_MatchSet `protobuf:"bytes,2,opt,name=and_match,json=andMatch,proto3,oneof"`
                                                                                }

                                                                                type MatchPredicate_AnyMatch

                                                                                type MatchPredicate_AnyMatch struct {
                                                                                	// The match configuration will always match.
                                                                                	AnyMatch bool `protobuf:"varint,4,opt,name=any_match,json=anyMatch,proto3,oneof"`
                                                                                }

                                                                                type MatchPredicate_HttpRequestGenericBodyMatch

                                                                                type MatchPredicate_HttpRequestGenericBodyMatch struct {
                                                                                	// HTTP request generic body match configuration.
                                                                                	HttpRequestGenericBodyMatch *HttpGenericBodyMatch `protobuf:"bytes,9,opt,name=http_request_generic_body_match,json=httpRequestGenericBodyMatch,proto3,oneof"`
                                                                                }

                                                                                type MatchPredicate_HttpRequestHeadersMatch

                                                                                type MatchPredicate_HttpRequestHeadersMatch struct {
                                                                                	// HTTP request headers match configuration.
                                                                                	HttpRequestHeadersMatch *HttpHeadersMatch `protobuf:"bytes,5,opt,name=http_request_headers_match,json=httpRequestHeadersMatch,proto3,oneof"`
                                                                                }

                                                                                type MatchPredicate_HttpRequestTrailersMatch

                                                                                type MatchPredicate_HttpRequestTrailersMatch struct {
                                                                                	// HTTP request trailers match configuration.
                                                                                	HttpRequestTrailersMatch *HttpHeadersMatch `protobuf:"bytes,6,opt,name=http_request_trailers_match,json=httpRequestTrailersMatch,proto3,oneof"`
                                                                                }

                                                                                type MatchPredicate_HttpResponseGenericBodyMatch

                                                                                type MatchPredicate_HttpResponseGenericBodyMatch struct {
                                                                                	// HTTP response generic body match configuration.
                                                                                	HttpResponseGenericBodyMatch *HttpGenericBodyMatch `protobuf:"bytes,10,opt,name=http_response_generic_body_match,json=httpResponseGenericBodyMatch,proto3,oneof"`
                                                                                }

                                                                                type MatchPredicate_HttpResponseHeadersMatch

                                                                                type MatchPredicate_HttpResponseHeadersMatch struct {
                                                                                	// HTTP response headers match configuration.
                                                                                	HttpResponseHeadersMatch *HttpHeadersMatch `protobuf:"bytes,7,opt,name=http_response_headers_match,json=httpResponseHeadersMatch,proto3,oneof"`
                                                                                }

                                                                                type MatchPredicate_HttpResponseTrailersMatch

                                                                                type MatchPredicate_HttpResponseTrailersMatch struct {
                                                                                	// HTTP response trailers match configuration.
                                                                                	HttpResponseTrailersMatch *HttpHeadersMatch `protobuf:"bytes,8,opt,name=http_response_trailers_match,json=httpResponseTrailersMatch,proto3,oneof"`
                                                                                }

                                                                                type MatchPredicate_MatchSet

                                                                                type MatchPredicate_MatchSet struct {
                                                                                
                                                                                	// The list of rules that make up the set.
                                                                                	Rules []*MatchPredicate `protobuf:"bytes,1,rep,name=rules,proto3" json:"rules,omitempty"`
                                                                                	// contains filtered or unexported fields
                                                                                }

                                                                                  A set of match configurations used for logical operations.

                                                                                  func (*MatchPredicate_MatchSet) Descriptor

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

                                                                                    Deprecated: Use MatchPredicate_MatchSet.ProtoReflect.Descriptor instead.

                                                                                    func (*MatchPredicate_MatchSet) GetRules

                                                                                    func (x *MatchPredicate_MatchSet) GetRules() []*MatchPredicate

                                                                                    func (*MatchPredicate_MatchSet) ProtoMessage

                                                                                    func (*MatchPredicate_MatchSet) ProtoMessage()

                                                                                    func (*MatchPredicate_MatchSet) ProtoReflect

                                                                                    func (x *MatchPredicate_MatchSet) ProtoReflect() protoreflect.Message

                                                                                    func (*MatchPredicate_MatchSet) Reset

                                                                                    func (x *MatchPredicate_MatchSet) Reset()

                                                                                    func (*MatchPredicate_MatchSet) String

                                                                                    func (x *MatchPredicate_MatchSet) String() string

                                                                                    func (*MatchPredicate_MatchSet) Validate

                                                                                    func (m *MatchPredicate_MatchSet) Validate() error

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

                                                                                      type MatchPredicate_MatchSetValidationError

                                                                                      type MatchPredicate_MatchSetValidationError struct {
                                                                                      	// contains filtered or unexported fields
                                                                                      }

                                                                                        MatchPredicate_MatchSetValidationError is the validation error returned by MatchPredicate_MatchSet.Validate if the designated constraints aren't met.

                                                                                        func (MatchPredicate_MatchSetValidationError) Cause

                                                                                          Cause function returns cause value.

                                                                                          func (MatchPredicate_MatchSetValidationError) Error

                                                                                            Error satisfies the builtin error interface

                                                                                            func (MatchPredicate_MatchSetValidationError) ErrorName

                                                                                              ErrorName returns error name.

                                                                                              func (MatchPredicate_MatchSetValidationError) Field

                                                                                                Field function returns field value.

                                                                                                func (MatchPredicate_MatchSetValidationError) Key

                                                                                                  Key function returns key value.

                                                                                                  func (MatchPredicate_MatchSetValidationError) Reason

                                                                                                    Reason function returns reason value.

                                                                                                    type MatchPredicate_NotMatch

                                                                                                    type MatchPredicate_NotMatch struct {
                                                                                                    	// A negation match. The match configuration will match if the negated match condition matches.
                                                                                                    	NotMatch *MatchPredicate `protobuf:"bytes,3,opt,name=not_match,json=notMatch,proto3,oneof"`
                                                                                                    }

                                                                                                    type MatchPredicate_OrMatch

                                                                                                    type MatchPredicate_OrMatch struct {
                                                                                                    	// A set that describes a logical OR. If any member of the set matches, the match configuration
                                                                                                    	// matches.
                                                                                                    	OrMatch *MatchPredicate_MatchSet `protobuf:"bytes,1,opt,name=or_match,json=orMatch,proto3,oneof"`
                                                                                                    }