compositev3

Documentation

Index

• Variables
• type Composite
  • func (*Composite) Descriptor() ([]byte, []int)
  • func (*Composite) ProtoMessage()
  • func (x *Composite) ProtoReflect() protoreflect.Message
  • func (x *Composite) Reset()
  • func (x *Composite) String() string
  • func (m *Composite) Validate() error
  • func (m *Composite) ValidateAll() error
• type CompositeMultiError
  • func (m CompositeMultiError) AllErrors() []error
  • func (m CompositeMultiError) Error() string
• type CompositeValidationError
  • func (e CompositeValidationError) Cause() error
  • func (e CompositeValidationError) Error() string
  • func (e CompositeValidationError) ErrorName() string
  • func (e CompositeValidationError) Field() string
  • func (e CompositeValidationError) Key() bool
  • func (e CompositeValidationError) Reason() string
• type ExecuteFilterAction
  • func (*ExecuteFilterAction) Descriptor() ([]byte, []int)
  • func (x *ExecuteFilterAction) GetTypedConfig() *v3.TypedExtensionConfig
  • func (*ExecuteFilterAction) ProtoMessage()
  • func (x *ExecuteFilterAction) ProtoReflect() protoreflect.Message
  • func (x *ExecuteFilterAction) Reset()
  • func (x *ExecuteFilterAction) String() string
  • func (m *ExecuteFilterAction) Validate() error
  • func (m *ExecuteFilterAction) ValidateAll() error
• type ExecuteFilterActionMultiError
  • func (m ExecuteFilterActionMultiError) AllErrors() []error
  • func (m ExecuteFilterActionMultiError) Error() string
• type ExecuteFilterActionValidationError
  • func (e ExecuteFilterActionValidationError) Cause() error
  • func (e ExecuteFilterActionValidationError) Error() string
  • func (e ExecuteFilterActionValidationError) ErrorName() string
  • func (e ExecuteFilterActionValidationError) Field() string
  • func (e ExecuteFilterActionValidationError) Key() bool
  • func (e ExecuteFilterActionValidationError) Reason() string

Variables

var File_envoy_extensions_filters_http_composite_v3_composite_proto protoreflect.FileDescriptor

Types

type Composite

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

:ref:`Composite filter <config_http_filters_composite>` config. The composite filter config allows delegating filter handling to another filter as determined by matching on the request headers. This makes it possible to use different filters or filter configurations based on the incoming request.

This is intended to be used with :ref:`ExtensionWithMatcher <envoy_v3_api_msg_extensions.common.matching.v3.ExtensionWithMatcher>` where a match tree is specified that indicates (via :ref:`ExecuteFilterAction <envoy_v3_api_msg_extensions.filters.http.composite.v3.ExecuteFilterAction>`) which filter configuration to create and delegate to.

func (*Composite) Descriptor

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

Deprecated: Use Composite.ProtoReflect.Descriptor instead.

func (*Composite) ProtoMessage

func (*Composite) ProtoMessage()

func (*Composite) ProtoReflect

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

func (*Composite) Reset

func (x *Composite) Reset()

func (*Composite) String

func (x *Composite) String() string

func (*Composite) Validate

func (m *Composite) Validate() error

Validate checks the field values on Composite with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*Composite) ValidateAll

func (m *Composite) ValidateAll() error

ValidateAll checks the field values on Composite with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in CompositeMultiError, or nil if none found.

type CompositeMultiError

type CompositeMultiError []error

CompositeMultiError is an error wrapping multiple validation errors returned by Composite.ValidateAll() if the designated constraints aren't met.

func (CompositeMultiError) AllErrors

func (m CompositeMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CompositeMultiError) Error

func (m CompositeMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type CompositeValidationError

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

CompositeValidationError is the validation error returned by Composite.Validate if the designated constraints aren't met.

func (CompositeValidationError) Cause

func (e CompositeValidationError) Cause() error

Cause function returns cause value.

func (CompositeValidationError) Error

func (e CompositeValidationError) Error() string

Error satisfies the builtin error interface

func (CompositeValidationError) ErrorName

func (e CompositeValidationError) ErrorName() string

ErrorName returns error name.

func (CompositeValidationError) Field

func (e CompositeValidationError) Field() string

Field function returns field value.

func (CompositeValidationError) Key

func (e CompositeValidationError) Key() bool

Key function returns key value.

func (CompositeValidationError) Reason

func (e CompositeValidationError) Reason() string

Reason function returns reason value.

type ExecuteFilterAction

type ExecuteFilterAction struct {
	TypedConfig *v3.TypedExtensionConfig `protobuf:"bytes,1,opt,name=typed_config,json=typedConfig,proto3" json:"typed_config,omitempty"`
	// contains filtered or unexported fields
}

Composite match action (see :ref:`matching docs <arch_overview_matching_api>` for more info on match actions). This specifies the filter configuration of the filter that the composite filter should delegate filter interactions to.

func (*ExecuteFilterAction) Descriptor

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

Deprecated: Use ExecuteFilterAction.ProtoReflect.Descriptor instead.

func (*ExecuteFilterAction) GetTypedConfig

func (x *ExecuteFilterAction) GetTypedConfig() *v3.TypedExtensionConfig

func (*ExecuteFilterAction) ProtoMessage

func (*ExecuteFilterAction) ProtoMessage()

func (*ExecuteFilterAction) ProtoReflect

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

func (*ExecuteFilterAction) Reset

func (x *ExecuteFilterAction) Reset()

func (*ExecuteFilterAction) String

func (x *ExecuteFilterAction) String() string

func (*ExecuteFilterAction) Validate

func (m *ExecuteFilterAction) Validate() error

Validate checks the field values on ExecuteFilterAction with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*ExecuteFilterAction) ValidateAll

func (m *ExecuteFilterAction) ValidateAll() error

ValidateAll checks the field values on ExecuteFilterAction with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in ExecuteFilterActionMultiError, or nil if none found.

type ExecuteFilterActionMultiError

type ExecuteFilterActionMultiError []error

ExecuteFilterActionMultiError is an error wrapping multiple validation errors returned by ExecuteFilterAction.ValidateAll() if the designated constraints aren't met.

func (ExecuteFilterActionMultiError) AllErrors

func (m ExecuteFilterActionMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ExecuteFilterActionMultiError) Error

func (m ExecuteFilterActionMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type ExecuteFilterActionValidationError

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

ExecuteFilterActionValidationError is the validation error returned by ExecuteFilterAction.Validate if the designated constraints aren't met.

func (ExecuteFilterActionValidationError) Cause

func (e ExecuteFilterActionValidationError) Cause() error

Cause function returns cause value.

func (ExecuteFilterActionValidationError) Error

func (e ExecuteFilterActionValidationError) Error() string

Error satisfies the builtin error interface

func (ExecuteFilterActionValidationError) ErrorName

func (e ExecuteFilterActionValidationError) ErrorName() string

ErrorName returns error name.

func (ExecuteFilterActionValidationError) Field

func (e ExecuteFilterActionValidationError) Field() string

Field function returns field value.

func (ExecuteFilterActionValidationError) Key

func (e ExecuteFilterActionValidationError) Key() bool

Key function returns key value.

func (ExecuteFilterActionValidationError) Reason

func (e ExecuteFilterActionValidationError) Reason() string

Reason function returns reason value.