envoy_extensions_filters_http_dynamic_forward_proxy_v3

Documentation

Index

• Variables
• type FilterConfig
  • func (*FilterConfig) Descriptor() ([]byte, []int)
  • func (x *FilterConfig) GetDnsCacheConfig() *v3.DnsCacheConfig
  • func (*FilterConfig) ProtoMessage()
  • func (x *FilterConfig) ProtoReflect() protoreflect.Message
  • func (x *FilterConfig) Reset()
  • func (x *FilterConfig) String() string
  • func (m *FilterConfig) Validate() error
• type FilterConfigValidationError
  • func (e FilterConfigValidationError) Cause() error
  • func (e FilterConfigValidationError) Error() string
  • func (e FilterConfigValidationError) ErrorName() string
  • func (e FilterConfigValidationError) Field() string
  • func (e FilterConfigValidationError) Key() bool
  • func (e FilterConfigValidationError) Reason() string
• type PerRouteConfig
  • func (*PerRouteConfig) Descriptor() ([]byte, []int)
  • func (x *PerRouteConfig) GetHostRewriteHeader() string
  • func (x *PerRouteConfig) GetHostRewriteLiteral() string
  • func (m *PerRouteConfig) GetHostRewriteSpecifier() isPerRouteConfig_HostRewriteSpecifier
  • func (*PerRouteConfig) ProtoMessage()
  • func (x *PerRouteConfig) ProtoReflect() protoreflect.Message
  • func (x *PerRouteConfig) Reset()
  • func (x *PerRouteConfig) String() string
  • func (m *PerRouteConfig) Validate() error
• type PerRouteConfigValidationError
  • func (e PerRouteConfigValidationError) Cause() error
  • func (e PerRouteConfigValidationError) Error() string
  • func (e PerRouteConfigValidationError) ErrorName() string
  • func (e PerRouteConfigValidationError) Field() string
  • func (e PerRouteConfigValidationError) Key() bool
  • func (e PerRouteConfigValidationError) Reason() string
• type PerRouteConfig_HostRewriteHeader
• type PerRouteConfig_HostRewriteLiteral

Variables

var File_envoy_extensions_filters_http_dynamic_forward_proxy_v3_dynamic_forward_proxy_proto protoreflect.FileDescriptor

Types

type FilterConfig

type FilterConfig struct {

	// The DNS cache configuration that the filter will attach to. Note this configuration must
	// match that of associated :ref:`dynamic forward proxy cluster configuration
	// <envoy_api_field_extensions.clusters.dynamic_forward_proxy.v3.ClusterConfig.dns_cache_config>`.
	DnsCacheConfig *v3.DnsCacheConfig `protobuf:"bytes,1,opt,name=dns_cache_config,json=dnsCacheConfig,proto3" json:"dns_cache_config,omitempty"`
	// contains filtered or unexported fields
}

Configuration for the dynamic forward proxy HTTP filter. See the :ref:`architecture overview <arch_overview_http_dynamic_forward_proxy>` for more information. [#extension: envoy.filters.http.dynamic_forward_proxy]

func (*FilterConfig) Descriptor

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

Deprecated: Use FilterConfig.ProtoReflect.Descriptor instead.

func (*FilterConfig) GetDnsCacheConfig

func (x *FilterConfig) GetDnsCacheConfig() *v3.DnsCacheConfig

func (*FilterConfig) ProtoMessage

func (*FilterConfig) ProtoMessage()

func (*FilterConfig) ProtoReflect

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

func (*FilterConfig) Reset

func (x *FilterConfig) Reset()

func (*FilterConfig) String

func (x *FilterConfig) String() string

func (*FilterConfig) Validate

func (m *FilterConfig) Validate() error

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

type FilterConfigValidationError

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

FilterConfigValidationError is the validation error returned by FilterConfig.Validate if the designated constraints aren't met.

func (FilterConfigValidationError) Cause

func (e FilterConfigValidationError) Cause() error

Cause function returns cause value.

func (FilterConfigValidationError) Error

func (e FilterConfigValidationError) Error() string

Error satisfies the builtin error interface

func (FilterConfigValidationError) ErrorName

func (e FilterConfigValidationError) ErrorName() string

ErrorName returns error name.

func (FilterConfigValidationError) Field

func (e FilterConfigValidationError) Field() string

Field function returns field value.

func (FilterConfigValidationError) Key

func (e FilterConfigValidationError) Key() bool

Key function returns key value.

func (FilterConfigValidationError) Reason

func (e FilterConfigValidationError) Reason() string

Reason function returns reason value.

type PerRouteConfig

type PerRouteConfig struct {

	// Types that are assignable to HostRewriteSpecifier:
	//	*PerRouteConfig_HostRewriteLiteral
	//	*PerRouteConfig_HostRewriteHeader
	HostRewriteSpecifier isPerRouteConfig_HostRewriteSpecifier `protobuf_oneof:"host_rewrite_specifier"`
	// contains filtered or unexported fields
}

Per route Configuration for the dynamic forward proxy HTTP filter.

func (*PerRouteConfig) Descriptor

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

Deprecated: Use PerRouteConfig.ProtoReflect.Descriptor instead.

func (*PerRouteConfig) GetHostRewriteHeader

func (x *PerRouteConfig) GetHostRewriteHeader() string

func (*PerRouteConfig) GetHostRewriteLiteral

func (x *PerRouteConfig) GetHostRewriteLiteral() string

func (*PerRouteConfig) GetHostRewriteSpecifier

func (m *PerRouteConfig) GetHostRewriteSpecifier() isPerRouteConfig_HostRewriteSpecifier

func (*PerRouteConfig) ProtoMessage

func (*PerRouteConfig) ProtoMessage()

func (*PerRouteConfig) ProtoReflect

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

func (*PerRouteConfig) Reset

func (x *PerRouteConfig) Reset()

func (*PerRouteConfig) String

func (x *PerRouteConfig) String() string

func (*PerRouteConfig) Validate

func (m *PerRouteConfig) Validate() error

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

type PerRouteConfigValidationError

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

PerRouteConfigValidationError is the validation error returned by PerRouteConfig.Validate if the designated constraints aren't met.

func (PerRouteConfigValidationError) Cause

func (e PerRouteConfigValidationError) Cause() error

Cause function returns cause value.

func (PerRouteConfigValidationError) Error

func (e PerRouteConfigValidationError) Error() string

Error satisfies the builtin error interface

func (PerRouteConfigValidationError) ErrorName

func (e PerRouteConfigValidationError) ErrorName() string

ErrorName returns error name.

func (PerRouteConfigValidationError) Field

func (e PerRouteConfigValidationError) Field() string

Field function returns field value.

func (PerRouteConfigValidationError) Key

func (e PerRouteConfigValidationError) Key() bool

Key function returns key value.

func (PerRouteConfigValidationError) Reason

func (e PerRouteConfigValidationError) Reason() string

Reason function returns reason value.

type PerRouteConfig_HostRewriteHeader

type PerRouteConfig_HostRewriteHeader struct {
	// Indicates that before DNS lookup, the host header will be swapped with
	// the value of this header. If not set or empty, the original host header
	// value will be used and no rewrite will happen.
	//
	// Note: this rewrite affects both DNS lookup and host header forwarding. However, this
	// option shouldn't be used with
	// :ref:`HCM host rewrite header <envoy_api_field_config.route.v3.RouteAction.auto_host_rewrite>`
	// given that the value set here would be used for DNS lookups whereas the value set in the HCM
	// would be used for host header forwarding which is not the desired outcome.
	//
	// .. note::
	//
	//   If the header appears multiple times only the first value is used.
	HostRewriteHeader string `protobuf:"bytes,2,opt,name=host_rewrite_header,json=hostRewriteHeader,proto3,oneof"`
}

type PerRouteConfig_HostRewriteLiteral

type PerRouteConfig_HostRewriteLiteral struct {
	// Indicates that before DNS lookup, the host header will be swapped with
	// this value. If not set or empty, the original host header value
	// will be used and no rewrite will happen.
	//
	// Note: this rewrite affects both DNS lookup and host header forwarding. However, this
	// option shouldn't be used with
	// :ref:`HCM host rewrite <envoy_api_field_config.route.v3.RouteAction.host_rewrite_literal>` given that the
	// value set here would be used for DNS lookups whereas the value set in the HCM would be used
	// for host header forwarding which is not the desired outcome.
	HostRewriteLiteral string `protobuf:"bytes,1,opt,name=host_rewrite_literal,json=hostRewriteLiteral,proto3,oneof"`
}