dynamic_forward_proxyv3

package
v0.12.0 Latest Latest
Warning

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

Go to latest
Published: Jan 2, 2024 License: Apache-2.0 Imports: 20 Imported by: 16

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_envoy_extensions_filters_http_dynamic_forward_proxy_v3_dynamic_forward_proxy_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type FilterConfig

type FilterConfig struct {

	// Types that are assignable to ImplementationSpecifier:
	//
	//	*FilterConfig_DnsCacheConfig
	//	*FilterConfig_SubClusterConfig
	ImplementationSpecifier isFilterConfig_ImplementationSpecifier `protobuf_oneof:"implementation_specifier"`
	// When this flag is set, the filter will add the resolved upstream address in the filter
	// state. The state should be saved with key
	// “envoy.stream.upstream_address“ (See
	// :repo:`upstream_address.h<source/common/stream_info/upstream_address.h>`).
	SaveUpstreamAddress bool `protobuf:"varint,2,opt,name=save_upstream_address,json=saveUpstreamAddress,proto3" json:"save_upstream_address,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 deprecated

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

Deprecated: Use FilterConfig.ProtoReflect.Descriptor instead.

func (*FilterConfig) GetDnsCacheConfig

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

func (*FilterConfig) GetImplementationSpecifier added in v0.11.1

func (m *FilterConfig) GetImplementationSpecifier() isFilterConfig_ImplementationSpecifier

func (*FilterConfig) GetSaveUpstreamAddress added in v0.10.0

func (x *FilterConfig) GetSaveUpstreamAddress() bool

func (*FilterConfig) GetSubClusterConfig added in v0.11.1

func (x *FilterConfig) GetSubClusterConfig() *SubClusterConfig

func (*FilterConfig) ProtoMessage

func (*FilterConfig) ProtoMessage()

func (*FilterConfig) ProtoReflect added in v0.9.6

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, the first error encountered is returned, or nil if there are no violations.

func (*FilterConfig) ValidateAll added in v0.10.0

func (m *FilterConfig) ValidateAll() error

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

type FilterConfigMultiError added in v0.10.0

type FilterConfigMultiError []error

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

func (FilterConfigMultiError) AllErrors added in v0.10.0

func (m FilterConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (FilterConfigMultiError) Error added in v0.10.0

func (m FilterConfigMultiError) Error() string

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

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

Cause function returns cause value.

func (FilterConfigValidationError) Error

Error satisfies the builtin error interface

func (FilterConfigValidationError) ErrorName

func (e FilterConfigValidationError) ErrorName() string

ErrorName returns error name.

func (FilterConfigValidationError) Field

Field function returns field value.

func (FilterConfigValidationError) Key

Key function returns key value.

func (FilterConfigValidationError) Reason

Reason function returns reason value.

type FilterConfig_DnsCacheConfig added in v0.11.1

type FilterConfig_DnsCacheConfig 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_v3_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,oneof"`
}

type FilterConfig_SubClusterConfig added in v0.11.1

type FilterConfig_SubClusterConfig struct {
	// The configuration that the filter will use, when the related dynamic forward proxy cluster enabled
	// sub clusters.
	SubClusterConfig *SubClusterConfig `protobuf:"bytes,3,opt,name=sub_cluster_config,json=subClusterConfig,proto3,oneof"`
}

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 deprecated

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 added in v0.9.6

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, the first error encountered is returned, or nil if there are no violations.

func (*PerRouteConfig) ValidateAll added in v0.10.0

func (m *PerRouteConfig) ValidateAll() error

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

type PerRouteConfigMultiError added in v0.10.0

type PerRouteConfigMultiError []error

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

func (PerRouteConfigMultiError) AllErrors added in v0.10.0

func (m PerRouteConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PerRouteConfigMultiError) Error added in v0.10.0

func (m PerRouteConfigMultiError) Error() string

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

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

Cause function returns cause value.

func (PerRouteConfigValidationError) Error

Error satisfies the builtin error interface

func (PerRouteConfigValidationError) ErrorName

func (e PerRouteConfigValidationError) ErrorName() string

ErrorName returns error name.

func (PerRouteConfigValidationError) Field

Field function returns field value.

func (PerRouteConfigValidationError) Key

Key function returns key value.

func (PerRouteConfigValidationError) Reason

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_v3_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_v3_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"`
}

type SubClusterConfig added in v0.11.1

type SubClusterConfig struct {

	// The timeout used for sub cluster initialization. Defaults to 5s if not set.
	ClusterInitTimeout *duration.Duration `protobuf:"bytes,3,opt,name=cluster_init_timeout,json=clusterInitTimeout,proto3" json:"cluster_init_timeout,omitempty"`
	// contains filtered or unexported fields
}

func (*SubClusterConfig) Descriptor deprecated added in v0.11.1

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

Deprecated: Use SubClusterConfig.ProtoReflect.Descriptor instead.

func (*SubClusterConfig) GetClusterInitTimeout added in v0.11.1

func (x *SubClusterConfig) GetClusterInitTimeout() *duration.Duration

func (*SubClusterConfig) ProtoMessage added in v0.11.1

func (*SubClusterConfig) ProtoMessage()

func (*SubClusterConfig) ProtoReflect added in v0.11.1

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

func (*SubClusterConfig) Reset added in v0.11.1

func (x *SubClusterConfig) Reset()

func (*SubClusterConfig) String added in v0.11.1

func (x *SubClusterConfig) String() string

func (*SubClusterConfig) Validate added in v0.11.1

func (m *SubClusterConfig) Validate() error

Validate checks the field values on SubClusterConfig 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 (*SubClusterConfig) ValidateAll added in v0.11.1

func (m *SubClusterConfig) ValidateAll() error

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

type SubClusterConfigMultiError added in v0.11.1

type SubClusterConfigMultiError []error

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

func (SubClusterConfigMultiError) AllErrors added in v0.11.1

func (m SubClusterConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (SubClusterConfigMultiError) Error added in v0.11.1

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

type SubClusterConfigValidationError added in v0.11.1

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

SubClusterConfigValidationError is the validation error returned by SubClusterConfig.Validate if the designated constraints aren't met.

func (SubClusterConfigValidationError) Cause added in v0.11.1

Cause function returns cause value.

func (SubClusterConfigValidationError) Error added in v0.11.1

Error satisfies the builtin error interface

func (SubClusterConfigValidationError) ErrorName added in v0.11.1

ErrorName returns error name.

func (SubClusterConfigValidationError) Field added in v0.11.1

Field function returns field value.

func (SubClusterConfigValidationError) Key added in v0.11.1

Key function returns key value.

func (SubClusterConfigValidationError) Reason added in v0.11.1

Reason function returns reason value.

Jump to

Keyboard shortcuts

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