dynamic_modulesv3

package
v1.40.0 Latest Latest
Warning

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

Go to latest
Published: Oct 13, 2026 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_envoy_extensions_matching_http_dynamic_modules_v3_dynamic_modules_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type DynamicModuleDataInput

type DynamicModuleDataInput struct {

	// Specifies the shared-object level configuration. This field is required. Remote module sources
	// are not supported for data inputs, so the module must be available locally or by name.
	DynamicModuleConfig *v3.DynamicModuleConfig `protobuf:"bytes,1,opt,name=dynamic_module_config,json=dynamicModuleConfig,proto3" json:"dynamic_module_config,omitempty"`
	// The name for this data input configuration. If not specified, defaults to an empty string.
	//
	// This can be used to distinguish between different data input implementations inside a dynamic
	// module. When Envoy receives this configuration, it passes the “input_name“ to the dynamic
	// module's data input config init function together with the “input_config“. That way a module
	// can decide which in-module implementation to use based on the name at load time.
	InputName string `protobuf:"bytes,2,opt,name=input_name,json=inputName,proto3" json:"input_name,omitempty"`
	// The configuration for the data input chosen by “input_name“. If not specified, an empty
	// configuration is passed to the module.
	//
	// “google.protobuf.Struct“ and the “value“ field of “xds.type.v3.TypedStruct“ are
	// serialized as JSON before passing them to the module.
	// “google.protobuf.BytesValue“ and “google.protobuf.StringValue“ are passed directly without
	// the wrapper.
	InputConfig *anypb.Any `protobuf:"bytes,3,opt,name=input_config,json=inputConfig,proto3" json:"input_config,omitempty"`
	// contains filtered or unexported fields
}

Configuration for the dynamic modules data input. This input loads a shared object file via “dlopen“ and invokes it during match evaluation to extract a value from the HTTP request and response. The extracted value is a string that an exact match map can dispatch on, so a module can select one of many matches with a single evaluation.

Unlike :ref:`HttpDynamicModuleMatchInput <envoy_v3_api_msg_extensions.matching.http.dynamic_modules.v3.HttpDynamicModuleMatchInput>`, the module produces the value directly rather than pairing with the dynamic modules input matcher. [#extension: envoy.matching.inputs.dynamic_module_string_data_input]

func (*DynamicModuleDataInput) Descriptor deprecated

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

Deprecated: Use DynamicModuleDataInput.ProtoReflect.Descriptor instead.

func (*DynamicModuleDataInput) GetDynamicModuleConfig

func (x *DynamicModuleDataInput) GetDynamicModuleConfig() *v3.DynamicModuleConfig

func (*DynamicModuleDataInput) GetInputConfig

func (x *DynamicModuleDataInput) GetInputConfig() *anypb.Any

func (*DynamicModuleDataInput) GetInputName

func (x *DynamicModuleDataInput) GetInputName() string

func (*DynamicModuleDataInput) ProtoMessage

func (*DynamicModuleDataInput) ProtoMessage()

func (*DynamicModuleDataInput) ProtoReflect

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

func (*DynamicModuleDataInput) Reset

func (x *DynamicModuleDataInput) Reset()

func (*DynamicModuleDataInput) String

func (x *DynamicModuleDataInput) String() string

func (*DynamicModuleDataInput) Validate

func (m *DynamicModuleDataInput) Validate() error

Validate checks the field values on DynamicModuleDataInput 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 (*DynamicModuleDataInput) ValidateAll

func (m *DynamicModuleDataInput) ValidateAll() error

ValidateAll checks the field values on DynamicModuleDataInput 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 DynamicModuleDataInputMultiError, or nil if none found.

type DynamicModuleDataInputMultiError

type DynamicModuleDataInputMultiError []error

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

func (DynamicModuleDataInputMultiError) AllErrors

func (m DynamicModuleDataInputMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (DynamicModuleDataInputMultiError) Error

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

type DynamicModuleDataInputValidationError

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

DynamicModuleDataInputValidationError is the validation error returned by DynamicModuleDataInput.Validate if the designated constraints aren't met.

func (DynamicModuleDataInputValidationError) Cause

Cause function returns cause value.

func (DynamicModuleDataInputValidationError) Error

Error satisfies the builtin error interface

func (DynamicModuleDataInputValidationError) ErrorName

ErrorName returns error name.

func (DynamicModuleDataInputValidationError) Field

Field function returns field value.

func (DynamicModuleDataInputValidationError) Key

Key function returns key value.

func (DynamicModuleDataInputValidationError) Reason

Reason function returns reason value.

type HttpDynamicModuleMatchInput

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

Configuration for the dynamic modules HTTP match input. This input extracts HTTP request and response data from the matching context and makes it available to the dynamic module matcher via ABI callbacks during match evaluation.

This data input should be used together with the :ref:`dynamic modules input matcher <envoy_v3_api_msg_extensions.matching.input_matchers.dynamic_modules.v3.DynamicModuleMatcher>`.

func (*HttpDynamicModuleMatchInput) Descriptor deprecated

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

Deprecated: Use HttpDynamicModuleMatchInput.ProtoReflect.Descriptor instead.

func (*HttpDynamicModuleMatchInput) ProtoMessage

func (*HttpDynamicModuleMatchInput) ProtoMessage()

func (*HttpDynamicModuleMatchInput) ProtoReflect

func (*HttpDynamicModuleMatchInput) Reset

func (x *HttpDynamicModuleMatchInput) Reset()

func (*HttpDynamicModuleMatchInput) String

func (x *HttpDynamicModuleMatchInput) String() string

func (*HttpDynamicModuleMatchInput) Validate

func (m *HttpDynamicModuleMatchInput) Validate() error

Validate checks the field values on HttpDynamicModuleMatchInput 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 (*HttpDynamicModuleMatchInput) ValidateAll

func (m *HttpDynamicModuleMatchInput) ValidateAll() error

ValidateAll checks the field values on HttpDynamicModuleMatchInput 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 HttpDynamicModuleMatchInputMultiError, or nil if none found.

type HttpDynamicModuleMatchInputMultiError

type HttpDynamicModuleMatchInputMultiError []error

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

func (HttpDynamicModuleMatchInputMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (HttpDynamicModuleMatchInputMultiError) Error

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

type HttpDynamicModuleMatchInputValidationError

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

HttpDynamicModuleMatchInputValidationError is the validation error returned by HttpDynamicModuleMatchInput.Validate if the designated constraints aren't met.

func (HttpDynamicModuleMatchInputValidationError) Cause

Cause function returns cause value.

func (HttpDynamicModuleMatchInputValidationError) Error

Error satisfies the builtin error interface

func (HttpDynamicModuleMatchInputValidationError) ErrorName

ErrorName returns error name.

func (HttpDynamicModuleMatchInputValidationError) Field

Field function returns field value.

func (HttpDynamicModuleMatchInputValidationError) Key

Key function returns key value.

func (HttpDynamicModuleMatchInputValidationError) Reason

Reason function returns reason value.

Jump to

Keyboard shortcuts

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