Documentation
¶
Index ¶
- Variables
- type DynamicModuleHeaderFormatter
- func (*DynamicModuleHeaderFormatter) Descriptor() ([]byte, []int)deprecated
- func (x *DynamicModuleHeaderFormatter) GetDynamicModuleConfig() *v3.DynamicModuleConfig
- func (x *DynamicModuleHeaderFormatter) GetHeaderFormatterConfig() *anypb.Any
- func (x *DynamicModuleHeaderFormatter) GetHeaderFormatterName() string
- func (*DynamicModuleHeaderFormatter) ProtoMessage()
- func (x *DynamicModuleHeaderFormatter) ProtoReflect() protoreflect.Message
- func (x *DynamicModuleHeaderFormatter) Reset()
- func (x *DynamicModuleHeaderFormatter) String() string
- func (m *DynamicModuleHeaderFormatter) Validate() error
- func (m *DynamicModuleHeaderFormatter) ValidateAll() error
- type DynamicModuleHeaderFormatterMultiError
- type DynamicModuleHeaderFormatterValidationError
- func (e DynamicModuleHeaderFormatterValidationError) Cause() error
- func (e DynamicModuleHeaderFormatterValidationError) Error() string
- func (e DynamicModuleHeaderFormatterValidationError) ErrorName() string
- func (e DynamicModuleHeaderFormatterValidationError) Field() string
- func (e DynamicModuleHeaderFormatterValidationError) Key() bool
- func (e DynamicModuleHeaderFormatterValidationError) Reason() string
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_http_header_formatters_dynamic_modules_v3_dynamic_modules_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type DynamicModuleHeaderFormatter ¶
type DynamicModuleHeaderFormatter struct {
// Specifies the shared-object level configuration. This field is required.
//
// Only sources that are available synchronously are supported, i.e. “name“, “module.local“,
// and a “module.remote“ that is already present in the on-disk cache. A remote source that
// would need to be fetched is rejected, since the codec must be able to format headers for the
// first message the connection serves.
DynamicModuleConfig *v3.DynamicModuleConfig `protobuf:"bytes,1,opt,name=dynamic_module_config,json=dynamicModuleConfig,proto3" json:"dynamic_module_config,omitempty"`
// The name for this header formatter configuration. If not specified, defaults to an empty
// string.
//
// This can be used to distinguish between different header formatter implementations inside a
// dynamic module. When Envoy receives this configuration, it passes the
// “header_formatter_name“ to the dynamic module's header formatter config init function
// together with the “header_formatter_config“. That way a module can decide which in-module
// implementation to use based on the name at load time.
HeaderFormatterName string `protobuf:"bytes,2,opt,name=header_formatter_name,json=headerFormatterName,proto3" json:"header_formatter_name,omitempty"`
// The configuration for the header formatter chosen by “header_formatter_name“. If not
// specified, an empty configuration is passed to the module.
//
// This is passed to the module's header formatter initialization function. Together with the
// “header_formatter_name“, the module can decide which in-module implementation to use and
// fine-tune its behavior.
//
// “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.
//
// .. code-block:: yaml
//
// # Passing a JSON struct configuration
// header_formatter_config:
// "@type": "type.googleapis.com/google.protobuf.Struct"
// value:
// known_headers:
// - X-Request-ID
//
// # Passing a simple string configuration
// header_formatter_config:
// "@type": "type.googleapis.com/google.protobuf.StringValue"
// value: "proper_case"
//
HeaderFormatterConfig *anypb.Any `` /* 126-byte string literal not displayed */
// contains filtered or unexported fields
}
Configuration for the Dynamic Modules HTTP/1 header formatter. This extension allows loading shared object files via “dlopen“ to decide the casing of header keys written on the wire, which is what the :ref:`preserve case formatter <envoy_v3_api_msg_extensions.http.header_formatters.preserve_case.v3.PreserveCaseFormatterConfig>` does with a fixed policy. See the :ref:`header casing <config_http_conn_man_header_casing>` configuration guide for how to select a stateful formatter.
This extension only affects HTTP/1 traffic: HTTP/2 and HTTP/3 require lower-cased header keys.
func (*DynamicModuleHeaderFormatter) Descriptor
deprecated
func (*DynamicModuleHeaderFormatter) Descriptor() ([]byte, []int)
Deprecated: Use DynamicModuleHeaderFormatter.ProtoReflect.Descriptor instead.
func (*DynamicModuleHeaderFormatter) GetDynamicModuleConfig ¶
func (x *DynamicModuleHeaderFormatter) GetDynamicModuleConfig() *v3.DynamicModuleConfig
func (*DynamicModuleHeaderFormatter) GetHeaderFormatterConfig ¶
func (x *DynamicModuleHeaderFormatter) GetHeaderFormatterConfig() *anypb.Any
func (*DynamicModuleHeaderFormatter) GetHeaderFormatterName ¶
func (x *DynamicModuleHeaderFormatter) GetHeaderFormatterName() string
func (*DynamicModuleHeaderFormatter) ProtoMessage ¶
func (*DynamicModuleHeaderFormatter) ProtoMessage()
func (*DynamicModuleHeaderFormatter) ProtoReflect ¶
func (x *DynamicModuleHeaderFormatter) ProtoReflect() protoreflect.Message
func (*DynamicModuleHeaderFormatter) Reset ¶
func (x *DynamicModuleHeaderFormatter) Reset()
func (*DynamicModuleHeaderFormatter) String ¶
func (x *DynamicModuleHeaderFormatter) String() string
func (*DynamicModuleHeaderFormatter) Validate ¶
func (m *DynamicModuleHeaderFormatter) Validate() error
Validate checks the field values on DynamicModuleHeaderFormatter 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 (*DynamicModuleHeaderFormatter) ValidateAll ¶
func (m *DynamicModuleHeaderFormatter) ValidateAll() error
ValidateAll checks the field values on DynamicModuleHeaderFormatter 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 DynamicModuleHeaderFormatterMultiError, or nil if none found.
type DynamicModuleHeaderFormatterMultiError ¶
type DynamicModuleHeaderFormatterMultiError []error
DynamicModuleHeaderFormatterMultiError is an error wrapping multiple validation errors returned by DynamicModuleHeaderFormatter.ValidateAll() if the designated constraints aren't met.
func (DynamicModuleHeaderFormatterMultiError) AllErrors ¶
func (m DynamicModuleHeaderFormatterMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (DynamicModuleHeaderFormatterMultiError) Error ¶
func (m DynamicModuleHeaderFormatterMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type DynamicModuleHeaderFormatterValidationError ¶
type DynamicModuleHeaderFormatterValidationError struct {
// contains filtered or unexported fields
}
DynamicModuleHeaderFormatterValidationError is the validation error returned by DynamicModuleHeaderFormatter.Validate if the designated constraints aren't met.
func (DynamicModuleHeaderFormatterValidationError) Cause ¶
func (e DynamicModuleHeaderFormatterValidationError) Cause() error
Cause function returns cause value.
func (DynamicModuleHeaderFormatterValidationError) Error ¶
func (e DynamicModuleHeaderFormatterValidationError) Error() string
Error satisfies the builtin error interface
func (DynamicModuleHeaderFormatterValidationError) ErrorName ¶
func (e DynamicModuleHeaderFormatterValidationError) ErrorName() string
ErrorName returns error name.
func (DynamicModuleHeaderFormatterValidationError) Field ¶
func (e DynamicModuleHeaderFormatterValidationError) Field() string
Field function returns field value.
func (DynamicModuleHeaderFormatterValidationError) Key ¶
func (e DynamicModuleHeaderFormatterValidationError) Key() bool
Key function returns key value.
func (DynamicModuleHeaderFormatterValidationError) Reason ¶
func (e DynamicModuleHeaderFormatterValidationError) Reason() string
Reason function returns reason value.