routerv2

Documentation

Index

• Variables
• type Router
  • func (*Router) Descriptor() ([]byte, []int)
  • func (x *Router) GetDynamicStats() *wrappers.BoolValue
  • func (x *Router) GetRespectExpectedRqTimeout() bool
  • func (x *Router) GetStartChildSpan() bool
  • func (x *Router) GetStrictCheckHeaders() []string
  • func (x *Router) GetSuppressEnvoyHeaders() bool
  • func (x *Router) GetUpstreamLog() []*v2.AccessLog
  • func (*Router) ProtoMessage()
  • func (x *Router) ProtoReflect() protoreflect.Message
  • func (x *Router) Reset()
  • func (x *Router) String() string
  • func (m *Router) Validate() error
  • func (m *Router) ValidateAll() error
• type RouterMultiError
  • func (m RouterMultiError) AllErrors() []error
  • func (m RouterMultiError) Error() string
• type RouterValidationError
  • func (e RouterValidationError) Cause() error
  • func (e RouterValidationError) Error() string
  • func (e RouterValidationError) ErrorName() string
  • func (e RouterValidationError) Field() string
  • func (e RouterValidationError) Key() bool
  • func (e RouterValidationError) Reason() string

Variables

var File_envoy_config_filter_http_router_v2_router_proto protoreflect.FileDescriptor

Types

type Router

type Router struct {

	// Whether the router generates dynamic cluster statistics. Defaults to
	// true. Can be disabled in high performance scenarios.
	DynamicStats *wrappers.BoolValue `protobuf:"bytes,1,opt,name=dynamic_stats,json=dynamicStats,proto3" json:"dynamic_stats,omitempty"`
	// Whether to start a child span for egress routed calls. This can be
	// useful in scenarios where other filters (auth, ratelimit, etc.) make
	// outbound calls and have child spans rooted at the same ingress
	// parent. Defaults to false.
	StartChildSpan bool `protobuf:"varint,2,opt,name=start_child_span,json=startChildSpan,proto3" json:"start_child_span,omitempty"`
	// Configuration for HTTP upstream logs emitted by the router. Upstream logs
	// are configured in the same way as access logs, but each log entry represents
	// an upstream request. Presuming retries are configured, multiple upstream
	// requests may be made for each downstream (inbound) request.
	UpstreamLog []*v2.AccessLog `protobuf:"bytes,3,rep,name=upstream_log,json=upstreamLog,proto3" json:"upstream_log,omitempty"`
	// Do not add any additional *x-envoy-* headers to requests or responses. This
	// only affects the :ref:`router filter generated *x-envoy-* headers
	// <config_http_filters_router_headers_set>`, other Envoy filters and the HTTP
	// connection manager may continue to set *x-envoy-* headers.
	SuppressEnvoyHeaders bool `protobuf:"varint,4,opt,name=suppress_envoy_headers,json=suppressEnvoyHeaders,proto3" json:"suppress_envoy_headers,omitempty"`
	// Specifies a list of HTTP headers to strictly validate. Envoy will reject a
	// request and respond with HTTP status 400 if the request contains an invalid
	// value for any of the headers listed in this field. Strict header checking
	// is only supported for the following headers:
	//
	// Value must be a ','-delimited list (i.e. no spaces) of supported retry
	// policy values:
	//
	// * :ref:`config_http_filters_router_x-envoy-retry-grpc-on`
	// * :ref:`config_http_filters_router_x-envoy-retry-on`
	//
	// Value must be an integer:
	//
	// * :ref:`config_http_filters_router_x-envoy-max-retries`
	// * :ref:`config_http_filters_router_x-envoy-upstream-rq-timeout-ms`
	// * :ref:`config_http_filters_router_x-envoy-upstream-rq-per-try-timeout-ms`
	StrictCheckHeaders []string `protobuf:"bytes,5,rep,name=strict_check_headers,json=strictCheckHeaders,proto3" json:"strict_check_headers,omitempty"`
	// If not set, ingress Envoy will ignore
	// :ref:`config_http_filters_router_x-envoy-expected-rq-timeout-ms` header, populated by egress
	// Envoy, when deriving timeout for upstream cluster.
	RespectExpectedRqTimeout bool `` /* 138-byte string literal not displayed */
	// contains filtered or unexported fields
}

[#next-free-field: 7]

func (*Router) Descriptor

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

Deprecated: Use Router.ProtoReflect.Descriptor instead.

func (*Router) GetDynamicStats

func (x *Router) GetDynamicStats() *wrappers.BoolValue

func (*Router) GetRespectExpectedRqTimeout

func (x *Router) GetRespectExpectedRqTimeout() bool

func (*Router) GetStartChildSpan

func (x *Router) GetStartChildSpan() bool

func (*Router) GetStrictCheckHeaders

func (x *Router) GetStrictCheckHeaders() []string

func (*Router) GetSuppressEnvoyHeaders

func (x *Router) GetSuppressEnvoyHeaders() bool

func (*Router) GetUpstreamLog

func (x *Router) GetUpstreamLog() []*v2.AccessLog

func (*Router) ProtoMessage

func (*Router) ProtoMessage()

func (*Router) ProtoReflect

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

func (*Router) Reset

func (x *Router) Reset()

func (*Router) String

func (x *Router) String() string

func (*Router) Validate

func (m *Router) Validate() error

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

func (m *Router) ValidateAll() error

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

type RouterMultiError

type RouterMultiError []error

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

func (RouterMultiError) AllErrors

func (m RouterMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (RouterMultiError) Error

func (m RouterMultiError) Error() string

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

type RouterValidationError

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

RouterValidationError is the validation error returned by Router.Validate if the designated constraints aren't met.

func (RouterValidationError) Cause

func (e RouterValidationError) Cause() error

Cause function returns cause value.

func (RouterValidationError) Error

func (e RouterValidationError) Error() string

Error satisfies the builtin error interface

func (RouterValidationError) ErrorName

func (e RouterValidationError) ErrorName() string

ErrorName returns error name.

func (RouterValidationError) Field

func (e RouterValidationError) Field() string

Field function returns field value.

func (RouterValidationError) Key

func (e RouterValidationError) Key() bool

Key function returns key value.

func (RouterValidationError) Reason

func (e RouterValidationError) Reason() string

Reason function returns reason value.