Documentation
¶
Index ¶
- Variables
- type FilterConfig
- func (*FilterConfig) Descriptor() ([]byte, []int)deprecated
- func (x *FilterConfig) GetContentType() string
- func (x *FilterConfig) GetResponseSizeHeader() string
- func (x *FilterConfig) GetWithholdGrpcFrames() bool
- func (*FilterConfig) ProtoMessage()
- func (x *FilterConfig) ProtoReflect() protoreflect.Message
- func (x *FilterConfig) Reset()
- func (x *FilterConfig) String() string
- func (m *FilterConfig) Validate() error
- func (m *FilterConfig) ValidateAll() error
- type FilterConfigMultiError
- type FilterConfigPerRoute
- func (*FilterConfigPerRoute) Descriptor() ([]byte, []int)deprecated
- func (x *FilterConfigPerRoute) GetDisabled() bool
- func (*FilterConfigPerRoute) ProtoMessage()
- func (x *FilterConfigPerRoute) ProtoReflect() protoreflect.Message
- func (x *FilterConfigPerRoute) Reset()
- func (x *FilterConfigPerRoute) String() string
- func (m *FilterConfigPerRoute) Validate() error
- func (m *FilterConfigPerRoute) ValidateAll() error
- type FilterConfigPerRouteMultiError
- type FilterConfigPerRouteValidationError
- func (e FilterConfigPerRouteValidationError) Cause() error
- func (e FilterConfigPerRouteValidationError) Error() string
- func (e FilterConfigPerRouteValidationError) ErrorName() string
- func (e FilterConfigPerRouteValidationError) Field() string
- func (e FilterConfigPerRouteValidationError) Key() bool
- func (e FilterConfigPerRouteValidationError) Reason() string
- 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
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_filters_http_grpc_http1_reverse_bridge_v3_config_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type FilterConfig ¶
type FilterConfig struct { // The content-type to pass to the upstream when the gRPC bridge filter is applied. // The filter will also validate that the upstream responds with the same content type. ContentType string `protobuf:"bytes,1,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"` // If true, Envoy will assume that the upstream doesn't understand gRPC frames and // strip the gRPC frame from the request, and add it back in to the response. This will // hide the gRPC semantics from the upstream, allowing it to receive and respond with a // simple binary encoded protobuf. In order to calculate the `Content-Length` header value, Envoy // will buffer the upstream response unless :ref:`response_size_header // <envoy_v3_api_field_extensions.filters.http.grpc_http1_reverse_bridge.v3.FilterConfig.response_size_header>` // is set, in which case Envoy will use the value of an upstream header to calculate the content // length. WithholdGrpcFrames bool `protobuf:"varint,2,opt,name=withhold_grpc_frames,json=withholdGrpcFrames,proto3" json:"withhold_grpc_frames,omitempty"` // When :ref:`withhold_grpc_frames // <envoy_v3_api_field_extensions.filters.http.grpc_http1_reverse_bridge.v3.FilterConfig.withhold_grpc_frames>` // is true, this option controls how Envoy calculates the `Content-Length`. When // *response_size_header* is empty, Envoy will buffer the upstream response to calculate its // size. When *response_size_header* is set to a non-empty string, Envoy will stream the response // to the downstream and it will use the value of the response header with this name to set the // `Content-Length` header and gRPC frame size. If the header with this name is repeated, only // the first value will be used. // // Envoy will treat the upstream response as an error if this option is specified and the header // is missing or if the value does not match the actual response body size. ResponseSizeHeader string `protobuf:"bytes,3,opt,name=response_size_header,json=responseSizeHeader,proto3" json:"response_size_header,omitempty"` // contains filtered or unexported fields }
gRPC reverse bridge filter configuration
func (*FilterConfig) Descriptor
deprecated
func (*FilterConfig) Descriptor() ([]byte, []int)
Deprecated: Use FilterConfig.ProtoReflect.Descriptor instead.
func (*FilterConfig) GetContentType ¶
func (x *FilterConfig) GetContentType() string
func (*FilterConfig) GetResponseSizeHeader ¶ added in v0.10.0
func (x *FilterConfig) GetResponseSizeHeader() string
func (*FilterConfig) GetWithholdGrpcFrames ¶
func (x *FilterConfig) GetWithholdGrpcFrames() bool
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 FilterConfigPerRoute ¶
type FilterConfigPerRoute struct { // If true, disables gRPC reverse bridge filter for this particular vhost or route. // If disabled is specified in multiple per-filter-configs, the most specific one will be used. Disabled bool `protobuf:"varint,1,opt,name=disabled,proto3" json:"disabled,omitempty"` // contains filtered or unexported fields }
gRPC reverse bridge filter configuration per virtualhost/route/weighted-cluster level.
func (*FilterConfigPerRoute) Descriptor
deprecated
func (*FilterConfigPerRoute) Descriptor() ([]byte, []int)
Deprecated: Use FilterConfigPerRoute.ProtoReflect.Descriptor instead.
func (*FilterConfigPerRoute) GetDisabled ¶
func (x *FilterConfigPerRoute) GetDisabled() bool
func (*FilterConfigPerRoute) ProtoMessage ¶
func (*FilterConfigPerRoute) ProtoMessage()
func (*FilterConfigPerRoute) ProtoReflect ¶ added in v0.9.6
func (x *FilterConfigPerRoute) ProtoReflect() protoreflect.Message
func (*FilterConfigPerRoute) Reset ¶
func (x *FilterConfigPerRoute) Reset()
func (*FilterConfigPerRoute) String ¶
func (x *FilterConfigPerRoute) String() string
func (*FilterConfigPerRoute) Validate ¶
func (m *FilterConfigPerRoute) Validate() error
Validate checks the field values on FilterConfigPerRoute 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 (*FilterConfigPerRoute) ValidateAll ¶ added in v0.10.0
func (m *FilterConfigPerRoute) ValidateAll() error
ValidateAll checks the field values on FilterConfigPerRoute 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 FilterConfigPerRouteMultiError, or nil if none found.
type FilterConfigPerRouteMultiError ¶ added in v0.10.0
type FilterConfigPerRouteMultiError []error
FilterConfigPerRouteMultiError is an error wrapping multiple validation errors returned by FilterConfigPerRoute.ValidateAll() if the designated constraints aren't met.
func (FilterConfigPerRouteMultiError) AllErrors ¶ added in v0.10.0
func (m FilterConfigPerRouteMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (FilterConfigPerRouteMultiError) Error ¶ added in v0.10.0
func (m FilterConfigPerRouteMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type FilterConfigPerRouteValidationError ¶
type FilterConfigPerRouteValidationError struct {
// contains filtered or unexported fields
}
FilterConfigPerRouteValidationError is the validation error returned by FilterConfigPerRoute.Validate if the designated constraints aren't met.
func (FilterConfigPerRouteValidationError) Cause ¶
func (e FilterConfigPerRouteValidationError) Cause() error
Cause function returns cause value.
func (FilterConfigPerRouteValidationError) Error ¶
func (e FilterConfigPerRouteValidationError) Error() string
Error satisfies the builtin error interface
func (FilterConfigPerRouteValidationError) ErrorName ¶
func (e FilterConfigPerRouteValidationError) ErrorName() string
ErrorName returns error name.
func (FilterConfigPerRouteValidationError) Field ¶
func (e FilterConfigPerRouteValidationError) Field() string
Field function returns field value.
func (FilterConfigPerRouteValidationError) Key ¶
func (e FilterConfigPerRouteValidationError) Key() bool
Key function returns key value.
func (FilterConfigPerRouteValidationError) Reason ¶
func (e FilterConfigPerRouteValidationError) Reason() string
Reason function returns reason value.
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.