Documentation ¶
Index ¶
- Variables
- type ExtProcOverrides
- func (*ExtProcOverrides) Descriptor() ([]byte, []int)deprecated
- func (x *ExtProcOverrides) GetAsyncMode() bool
- func (x *ExtProcOverrides) GetGrpcService() *v3.GrpcService
- func (x *ExtProcOverrides) GetProcessingMode() *ProcessingMode
- func (x *ExtProcOverrides) GetRequestAttributes() []string
- func (x *ExtProcOverrides) GetResponseAttributes() []string
- func (*ExtProcOverrides) ProtoMessage()
- func (x *ExtProcOverrides) ProtoReflect() protoreflect.Message
- func (x *ExtProcOverrides) Reset()
- func (x *ExtProcOverrides) String() string
- type ExtProcPerRoute
- func (*ExtProcPerRoute) Descriptor() ([]byte, []int)deprecated
- func (x *ExtProcPerRoute) GetDisabled() bool
- func (m *ExtProcPerRoute) GetOverride() isExtProcPerRoute_Override
- func (x *ExtProcPerRoute) GetOverrides() *ExtProcOverrides
- func (*ExtProcPerRoute) ProtoMessage()
- func (x *ExtProcPerRoute) ProtoReflect() protoreflect.Message
- func (x *ExtProcPerRoute) Reset()
- func (x *ExtProcPerRoute) String() string
- type ExtProcPerRoute_Disabled
- type ExtProcPerRoute_Overrides
- type ExternalProcessor
- func (*ExternalProcessor) Descriptor() ([]byte, []int)deprecated
- func (x *ExternalProcessor) GetAsyncMode() bool
- func (x *ExternalProcessor) GetDisableClearRouteCache() bool
- func (x *ExternalProcessor) GetFailureModeAllow() bool
- func (x *ExternalProcessor) GetGrpcService() *v3.GrpcService
- func (x *ExternalProcessor) GetMaxMessageTimeout() *durationpb.Duration
- func (x *ExternalProcessor) GetMessageTimeout() *durationpb.Duration
- func (x *ExternalProcessor) GetMutationRules() *v31.HeaderMutationRules
- func (x *ExternalProcessor) GetProcessingMode() *ProcessingMode
- func (x *ExternalProcessor) GetRequestAttributes() []string
- func (x *ExternalProcessor) GetResponseAttributes() []string
- func (x *ExternalProcessor) GetStatPrefix() string
- func (*ExternalProcessor) ProtoMessage()
- func (x *ExternalProcessor) ProtoReflect() protoreflect.Message
- func (x *ExternalProcessor) Reset()
- func (x *ExternalProcessor) String() string
- type ProcessingMode
- func (*ProcessingMode) Descriptor() ([]byte, []int)deprecated
- func (x *ProcessingMode) GetRequestBodyMode() ProcessingMode_BodySendMode
- func (x *ProcessingMode) GetRequestHeaderMode() ProcessingMode_HeaderSendMode
- func (x *ProcessingMode) GetRequestTrailerMode() ProcessingMode_HeaderSendMode
- func (x *ProcessingMode) GetResponseBodyMode() ProcessingMode_BodySendMode
- func (x *ProcessingMode) GetResponseHeaderMode() ProcessingMode_HeaderSendMode
- func (x *ProcessingMode) GetResponseTrailerMode() ProcessingMode_HeaderSendMode
- func (*ProcessingMode) ProtoMessage()
- func (x *ProcessingMode) ProtoReflect() protoreflect.Message
- func (x *ProcessingMode) Reset()
- func (x *ProcessingMode) String() string
- type ProcessingMode_BodySendMode
- func (ProcessingMode_BodySendMode) Descriptor() protoreflect.EnumDescriptor
- func (x ProcessingMode_BodySendMode) Enum() *ProcessingMode_BodySendMode
- func (ProcessingMode_BodySendMode) EnumDescriptor() ([]byte, []int)deprecated
- func (x ProcessingMode_BodySendMode) Number() protoreflect.EnumNumber
- func (x ProcessingMode_BodySendMode) String() string
- func (ProcessingMode_BodySendMode) Type() protoreflect.EnumType
- type ProcessingMode_HeaderSendMode
- func (ProcessingMode_HeaderSendMode) Descriptor() protoreflect.EnumDescriptor
- func (x ProcessingMode_HeaderSendMode) Enum() *ProcessingMode_HeaderSendMode
- func (ProcessingMode_HeaderSendMode) EnumDescriptor() ([]byte, []int)deprecated
- func (x ProcessingMode_HeaderSendMode) Number() protoreflect.EnumNumber
- func (x ProcessingMode_HeaderSendMode) String() string
- func (ProcessingMode_HeaderSendMode) Type() protoreflect.EnumType
Constants ¶
This section is empty.
Variables ¶
var ( ProcessingMode_HeaderSendMode_name = map[int32]string{ 0: "DEFAULT", 1: "SEND", 2: "SKIP", } ProcessingMode_HeaderSendMode_value = map[string]int32{ "DEFAULT": 0, "SEND": 1, "SKIP": 2, } )
Enum value maps for ProcessingMode_HeaderSendMode.
var ( ProcessingMode_BodySendMode_name = map[int32]string{ 0: "NONE", 1: "STREAMED", 2: "BUFFERED", 3: "BUFFERED_PARTIAL", } ProcessingMode_BodySendMode_value = map[string]int32{ "NONE": 0, "STREAMED": 1, "BUFFERED": 2, "BUFFERED_PARTIAL": 3, } )
Enum value maps for ProcessingMode_BodySendMode.
var File_envoy_extensions_filters_http_ext_proc_v3_ext_proc_proto protoreflect.FileDescriptor
var File_envoy_extensions_filters_http_ext_proc_v3_processing_mode_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type ExtProcOverrides ¶
type ExtProcOverrides struct { // Set a different processing mode for this route than the default. ProcessingMode *ProcessingMode `protobuf:"bytes,1,opt,name=processing_mode,json=processingMode,proto3" json:"processing_mode,omitempty"` // [#not-implemented-hide:] // Set a different asynchronous processing option than the default. AsyncMode bool `protobuf:"varint,2,opt,name=async_mode,json=asyncMode,proto3" json:"async_mode,omitempty"` // [#not-implemented-hide:] // Set different optional attributes than the default setting of the // “request_attributes“ field. RequestAttributes []string `protobuf:"bytes,3,rep,name=request_attributes,json=requestAttributes,proto3" json:"request_attributes,omitempty"` // [#not-implemented-hide:] // Set different optional properties than the default setting of the // “response_attributes“ field. ResponseAttributes []string `protobuf:"bytes,4,rep,name=response_attributes,json=responseAttributes,proto3" json:"response_attributes,omitempty"` // Set a different gRPC service for this route than the default. GrpcService *v3.GrpcService `protobuf:"bytes,5,opt,name=grpc_service,json=grpcService,proto3" json:"grpc_service,omitempty"` // contains filtered or unexported fields }
Overrides that may be set on a per-route basis [#next-free-field: 6]
func (*ExtProcOverrides) Descriptor
deprecated
func (*ExtProcOverrides) Descriptor() ([]byte, []int)
Deprecated: Use ExtProcOverrides.ProtoReflect.Descriptor instead.
func (*ExtProcOverrides) GetAsyncMode ¶
func (x *ExtProcOverrides) GetAsyncMode() bool
func (*ExtProcOverrides) GetGrpcService ¶
func (x *ExtProcOverrides) GetGrpcService() *v3.GrpcService
func (*ExtProcOverrides) GetProcessingMode ¶
func (x *ExtProcOverrides) GetProcessingMode() *ProcessingMode
func (*ExtProcOverrides) GetRequestAttributes ¶
func (x *ExtProcOverrides) GetRequestAttributes() []string
func (*ExtProcOverrides) GetResponseAttributes ¶
func (x *ExtProcOverrides) GetResponseAttributes() []string
func (*ExtProcOverrides) ProtoMessage ¶
func (*ExtProcOverrides) ProtoMessage()
func (*ExtProcOverrides) ProtoReflect ¶
func (x *ExtProcOverrides) ProtoReflect() protoreflect.Message
func (*ExtProcOverrides) Reset ¶
func (x *ExtProcOverrides) Reset()
func (*ExtProcOverrides) String ¶
func (x *ExtProcOverrides) String() string
type ExtProcPerRoute ¶
type ExtProcPerRoute struct { // Types that are assignable to Override: // // *ExtProcPerRoute_Disabled // *ExtProcPerRoute_Overrides Override isExtProcPerRoute_Override `protobuf_oneof:"override"` // contains filtered or unexported fields }
Extra settings that may be added to per-route configuration for a virtual host or cluster.
func (*ExtProcPerRoute) Descriptor
deprecated
func (*ExtProcPerRoute) Descriptor() ([]byte, []int)
Deprecated: Use ExtProcPerRoute.ProtoReflect.Descriptor instead.
func (*ExtProcPerRoute) GetDisabled ¶
func (x *ExtProcPerRoute) GetDisabled() bool
func (*ExtProcPerRoute) GetOverride ¶
func (m *ExtProcPerRoute) GetOverride() isExtProcPerRoute_Override
func (*ExtProcPerRoute) GetOverrides ¶
func (x *ExtProcPerRoute) GetOverrides() *ExtProcOverrides
func (*ExtProcPerRoute) ProtoMessage ¶
func (*ExtProcPerRoute) ProtoMessage()
func (*ExtProcPerRoute) ProtoReflect ¶
func (x *ExtProcPerRoute) ProtoReflect() protoreflect.Message
func (*ExtProcPerRoute) Reset ¶
func (x *ExtProcPerRoute) Reset()
func (*ExtProcPerRoute) String ¶
func (x *ExtProcPerRoute) String() string
type ExtProcPerRoute_Disabled ¶
type ExtProcPerRoute_Disabled struct { // Disable the 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,oneof"` }
type ExtProcPerRoute_Overrides ¶
type ExtProcPerRoute_Overrides struct { // Override aspects of the configuration for this route. A set of // overrides in a more specific configuration will override a "disabled" // flag set in a less-specific one. Overrides *ExtProcOverrides `protobuf:"bytes,2,opt,name=overrides,proto3,oneof"` }
type ExternalProcessor ¶
type ExternalProcessor struct { // Configuration for the gRPC service that the filter will communicate with. // The filter supports both the "Envoy" and "Google" gRPC clients. GrpcService *v3.GrpcService `protobuf:"bytes,1,opt,name=grpc_service,json=grpcService,proto3" json:"grpc_service,omitempty"` // By default, if the gRPC stream cannot be established, or if it is closed // prematurely with an error, the filter will fail. Specifically, if the // response headers have not yet been delivered, then it will return a 500 // error downstream. If they have been delivered, then instead the HTTP stream to the // downstream client will be reset. // With this parameter set to true, however, then if the gRPC stream is prematurely closed // or could not be opened, processing continues without error. FailureModeAllow bool `protobuf:"varint,2,opt,name=failure_mode_allow,json=failureModeAllow,proto3" json:"failure_mode_allow,omitempty"` // Specifies default options for how HTTP headers, trailers, and bodies are // sent. See ProcessingMode for details. ProcessingMode *ProcessingMode `protobuf:"bytes,3,opt,name=processing_mode,json=processingMode,proto3" json:"processing_mode,omitempty"` // [#not-implemented-hide:] // If true, send each part of the HTTP request or response specified by ProcessingMode // asynchronously -- in other words, send the message on the gRPC stream and then continue // filter processing. If false, which is the default, suspend filter execution after // each message is sent to the remote service and wait up to "message_timeout" // for a reply. AsyncMode bool `protobuf:"varint,4,opt,name=async_mode,json=asyncMode,proto3" json:"async_mode,omitempty"` // [#not-implemented-hide:] // Envoy provides a number of :ref:`attributes <arch_overview_attributes>` // for expressive policies. Each attribute name provided in this field will be // matched against that list and populated in the request_headers message. // See the :ref:`attribute documentation <arch_overview_request_attributes>` // for the list of supported attributes and their types. RequestAttributes []string `protobuf:"bytes,5,rep,name=request_attributes,json=requestAttributes,proto3" json:"request_attributes,omitempty"` // [#not-implemented-hide:] // Envoy provides a number of :ref:`attributes <arch_overview_attributes>` // for expressive policies. Each attribute name provided in this field will be // matched against that list and populated in the response_headers message. // See the :ref:`attribute documentation <arch_overview_attributes>` // for the list of supported attributes and their types. ResponseAttributes []string `protobuf:"bytes,6,rep,name=response_attributes,json=responseAttributes,proto3" json:"response_attributes,omitempty"` // Specifies the timeout for each individual message sent on the stream and // when the filter is running in synchronous mode. Whenever // the proxy sends a message on the stream that requires a response, it will // reset this timer, and will stop processing and return an error (subject // to the processing mode) if the timer expires before a matching response // is received. There is no timeout when the filter is running in asynchronous // mode. Default is 200 milliseconds. MessageTimeout *durationpb.Duration `protobuf:"bytes,7,opt,name=message_timeout,json=messageTimeout,proto3" json:"message_timeout,omitempty"` // Optional additional prefix to use when emitting statistics. This allows to distinguish // emitted statistics between configured *ext_proc* filters in an HTTP filter chain. StatPrefix string `protobuf:"bytes,8,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"` // Rules that determine what modifications an external processing server may // make to message headers. If not set, all headers may be modified except // for "host", ":authority", ":scheme", ":method", and headers that start // with the header prefix set via // :ref:`header_prefix <envoy_v3_api_field_config.bootstrap.v3.Bootstrap.header_prefix>` // (which is usually "x-envoy"). // Note that changing headers such as "host" or ":authority" may not in itself // change Envoy's routing decision, as routes can be cached. To also force the // route to be recomputed, set the // :ref:`clear_route_cache <envoy_v3_api_field_service.ext_proc.v3.CommonResponse.clear_route_cache>` // field to true in the same response. MutationRules *v31.HeaderMutationRules `protobuf:"bytes,9,opt,name=mutation_rules,json=mutationRules,proto3" json:"mutation_rules,omitempty"` // Specify the upper bound of // :ref:`override_message_timeout <envoy_v3_api_field_service.ext_proc.v3.ProcessingResponse.override_message_timeout>` // If not specified, by default it is 0, which will effectively disable the “override_message_timeout“ API. MaxMessageTimeout *durationpb.Duration `protobuf:"bytes,10,opt,name=max_message_timeout,json=maxMessageTimeout,proto3" json:"max_message_timeout,omitempty"` // Prevents clearing the route-cache when the // :ref:`clear_route_cache <envoy_v3_api_field_service.ext_proc.v3.CommonResponse.clear_route_cache>` // field is set in an external processor response. DisableClearRouteCache bool `` /* 133-byte string literal not displayed */ // contains filtered or unexported fields }
[#next-free-field: 12]
func (*ExternalProcessor) Descriptor
deprecated
func (*ExternalProcessor) Descriptor() ([]byte, []int)
Deprecated: Use ExternalProcessor.ProtoReflect.Descriptor instead.
func (*ExternalProcessor) GetAsyncMode ¶
func (x *ExternalProcessor) GetAsyncMode() bool
func (*ExternalProcessor) GetDisableClearRouteCache ¶
func (x *ExternalProcessor) GetDisableClearRouteCache() bool
func (*ExternalProcessor) GetFailureModeAllow ¶
func (x *ExternalProcessor) GetFailureModeAllow() bool
func (*ExternalProcessor) GetGrpcService ¶
func (x *ExternalProcessor) GetGrpcService() *v3.GrpcService
func (*ExternalProcessor) GetMaxMessageTimeout ¶
func (x *ExternalProcessor) GetMaxMessageTimeout() *durationpb.Duration
func (*ExternalProcessor) GetMessageTimeout ¶
func (x *ExternalProcessor) GetMessageTimeout() *durationpb.Duration
func (*ExternalProcessor) GetMutationRules ¶
func (x *ExternalProcessor) GetMutationRules() *v31.HeaderMutationRules
func (*ExternalProcessor) GetProcessingMode ¶
func (x *ExternalProcessor) GetProcessingMode() *ProcessingMode
func (*ExternalProcessor) GetRequestAttributes ¶
func (x *ExternalProcessor) GetRequestAttributes() []string
func (*ExternalProcessor) GetResponseAttributes ¶
func (x *ExternalProcessor) GetResponseAttributes() []string
func (*ExternalProcessor) GetStatPrefix ¶
func (x *ExternalProcessor) GetStatPrefix() string
func (*ExternalProcessor) ProtoMessage ¶
func (*ExternalProcessor) ProtoMessage()
func (*ExternalProcessor) ProtoReflect ¶
func (x *ExternalProcessor) ProtoReflect() protoreflect.Message
func (*ExternalProcessor) Reset ¶
func (x *ExternalProcessor) Reset()
func (*ExternalProcessor) String ¶
func (x *ExternalProcessor) String() string
type ProcessingMode ¶
type ProcessingMode struct { // How to handle the request header. Default is "SEND". RequestHeaderMode ProcessingMode_HeaderSendMode `` /* 192-byte string literal not displayed */ // How to handle the response header. Default is "SEND". ResponseHeaderMode ProcessingMode_HeaderSendMode `` /* 195-byte string literal not displayed */ // How to handle the request body. Default is "NONE". RequestBodyMode ProcessingMode_BodySendMode `` /* 184-byte string literal not displayed */ // How do handle the response body. Default is "NONE". ResponseBodyMode ProcessingMode_BodySendMode `` /* 187-byte string literal not displayed */ // How to handle the request trailers. Default is "SKIP". RequestTrailerMode ProcessingMode_HeaderSendMode `` /* 195-byte string literal not displayed */ // How to handle the response trailers. Default is "SKIP". ResponseTrailerMode ProcessingMode_HeaderSendMode `` /* 198-byte string literal not displayed */ // contains filtered or unexported fields }
[#next-free-field: 7]
func (*ProcessingMode) Descriptor
deprecated
func (*ProcessingMode) Descriptor() ([]byte, []int)
Deprecated: Use ProcessingMode.ProtoReflect.Descriptor instead.
func (*ProcessingMode) GetRequestBodyMode ¶
func (x *ProcessingMode) GetRequestBodyMode() ProcessingMode_BodySendMode
func (*ProcessingMode) GetRequestHeaderMode ¶
func (x *ProcessingMode) GetRequestHeaderMode() ProcessingMode_HeaderSendMode
func (*ProcessingMode) GetRequestTrailerMode ¶
func (x *ProcessingMode) GetRequestTrailerMode() ProcessingMode_HeaderSendMode
func (*ProcessingMode) GetResponseBodyMode ¶
func (x *ProcessingMode) GetResponseBodyMode() ProcessingMode_BodySendMode
func (*ProcessingMode) GetResponseHeaderMode ¶
func (x *ProcessingMode) GetResponseHeaderMode() ProcessingMode_HeaderSendMode
func (*ProcessingMode) GetResponseTrailerMode ¶
func (x *ProcessingMode) GetResponseTrailerMode() ProcessingMode_HeaderSendMode
func (*ProcessingMode) ProtoMessage ¶
func (*ProcessingMode) ProtoMessage()
func (*ProcessingMode) ProtoReflect ¶
func (x *ProcessingMode) ProtoReflect() protoreflect.Message
func (*ProcessingMode) Reset ¶
func (x *ProcessingMode) Reset()
func (*ProcessingMode) String ¶
func (x *ProcessingMode) String() string
type ProcessingMode_BodySendMode ¶
type ProcessingMode_BodySendMode int32
Control how the request and response bodies are handled
const ( // Do not send the body at all. This is the default. ProcessingMode_NONE ProcessingMode_BodySendMode = 0 // Stream the body to the server in pieces as they arrive at the // proxy. ProcessingMode_STREAMED ProcessingMode_BodySendMode = 1 // Buffer the message body in memory and send the entire body at once. // If the body exceeds the configured buffer limit, then the // downstream system will receive an error. ProcessingMode_BUFFERED ProcessingMode_BodySendMode = 2 // Buffer the message body in memory and send the entire body in one // chunk. If the body exceeds the configured buffer limit, then the body contents // up to the buffer limit will be sent. ProcessingMode_BUFFERED_PARTIAL ProcessingMode_BodySendMode = 3 )
func (ProcessingMode_BodySendMode) Descriptor ¶
func (ProcessingMode_BodySendMode) Descriptor() protoreflect.EnumDescriptor
func (ProcessingMode_BodySendMode) Enum ¶
func (x ProcessingMode_BodySendMode) Enum() *ProcessingMode_BodySendMode
func (ProcessingMode_BodySendMode) EnumDescriptor
deprecated
func (ProcessingMode_BodySendMode) EnumDescriptor() ([]byte, []int)
Deprecated: Use ProcessingMode_BodySendMode.Descriptor instead.
func (ProcessingMode_BodySendMode) Number ¶
func (x ProcessingMode_BodySendMode) Number() protoreflect.EnumNumber
func (ProcessingMode_BodySendMode) String ¶
func (x ProcessingMode_BodySendMode) String() string
func (ProcessingMode_BodySendMode) Type ¶
func (ProcessingMode_BodySendMode) Type() protoreflect.EnumType
type ProcessingMode_HeaderSendMode ¶
type ProcessingMode_HeaderSendMode int32
Control how headers and trailers are handled
const ( // The default HeaderSendMode depends on which part of the message is being // processed. By default, request and response headers are sent, // while trailers are skipped. ProcessingMode_DEFAULT ProcessingMode_HeaderSendMode = 0 // Send the header or trailer. ProcessingMode_SEND ProcessingMode_HeaderSendMode = 1 // Do not send the header or trailer. ProcessingMode_SKIP ProcessingMode_HeaderSendMode = 2 )
func (ProcessingMode_HeaderSendMode) Descriptor ¶
func (ProcessingMode_HeaderSendMode) Descriptor() protoreflect.EnumDescriptor
func (ProcessingMode_HeaderSendMode) Enum ¶
func (x ProcessingMode_HeaderSendMode) Enum() *ProcessingMode_HeaderSendMode
func (ProcessingMode_HeaderSendMode) EnumDescriptor
deprecated
func (ProcessingMode_HeaderSendMode) EnumDescriptor() ([]byte, []int)
Deprecated: Use ProcessingMode_HeaderSendMode.Descriptor instead.
func (ProcessingMode_HeaderSendMode) Number ¶
func (x ProcessingMode_HeaderSendMode) Number() protoreflect.EnumNumber
func (ProcessingMode_HeaderSendMode) String ¶
func (x ProcessingMode_HeaderSendMode) String() string
func (ProcessingMode_HeaderSendMode) Type ¶
func (ProcessingMode_HeaderSendMode) Type() protoreflect.EnumType