envoy_extensions_filters_http_ext_proc_v3

package
v0.10.1 Latest Latest
Warning

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

Go to latest
Published: Nov 15, 2021 License: Apache-2.0 Imports: 22 Imported by: 20

Documentation

Index

Constants

This section is empty.

Variables

View Source
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.

View Source
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.

View Source
var File_envoy_extensions_filters_http_ext_proc_v3_ext_proc_proto protoreflect.FileDescriptor
View Source
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 properties than the default.
	RequestProperties []string `protobuf:"bytes,3,rep,name=request_properties,json=requestProperties,proto3" json:"request_properties,omitempty"`
	// [#not-implemented-hide:]
	// Set different optional properties than the default.
	ResponseProperties []string `protobuf:"bytes,4,rep,name=response_properties,json=responseProperties,proto3" json:"response_properties,omitempty"`
	// contains filtered or unexported fields
}

Overrides that may be set on a per-route basis

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) GetProcessingMode

func (x *ExtProcOverrides) GetProcessingMode() *ProcessingMode

func (*ExtProcOverrides) GetRequestProperties

func (x *ExtProcOverrides) GetRequestProperties() []string

func (*ExtProcOverrides) GetResponseProperties

func (x *ExtProcOverrides) GetResponseProperties() []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

func (*ExtProcOverrides) Validate

func (m *ExtProcOverrides) Validate() error

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

func (m *ExtProcOverrides) ValidateAll() error

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

type ExtProcOverridesMultiError

type ExtProcOverridesMultiError []error

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

func (ExtProcOverridesMultiError) AllErrors

func (m ExtProcOverridesMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ExtProcOverridesMultiError) Error

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

type ExtProcOverridesValidationError

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

ExtProcOverridesValidationError is the validation error returned by ExtProcOverrides.Validate if the designated constraints aren't met.

func (ExtProcOverridesValidationError) Cause

Cause function returns cause value.

func (ExtProcOverridesValidationError) Error

Error satisfies the builtin error interface

func (ExtProcOverridesValidationError) ErrorName

ErrorName returns error name.

func (ExtProcOverridesValidationError) Field

Field function returns field value.

func (ExtProcOverridesValidationError) Key

Key function returns key value.

func (ExtProcOverridesValidationError) Reason

Reason function returns reason value.

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

func (*ExtProcPerRoute) Validate

func (m *ExtProcPerRoute) Validate() error

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

func (m *ExtProcPerRoute) ValidateAll() error

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

type ExtProcPerRouteMultiError

type ExtProcPerRouteMultiError []error

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

func (ExtProcPerRouteMultiError) AllErrors

func (m ExtProcPerRouteMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ExtProcPerRouteMultiError) Error

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

type ExtProcPerRouteValidationError

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

ExtProcPerRouteValidationError is the validation error returned by ExtProcPerRoute.Validate if the designated constraints aren't met.

func (ExtProcPerRouteValidationError) Cause

Cause function returns cause value.

func (ExtProcPerRouteValidationError) Error

Error satisfies the builtin error interface

func (ExtProcPerRouteValidationError) ErrorName

func (e ExtProcPerRouteValidationError) ErrorName() string

ErrorName returns error name.

func (ExtProcPerRouteValidationError) Field

Field function returns field value.

func (ExtProcPerRouteValidationError) Key

Key function returns key value.

func (ExtProcPerRouteValidationError) Reason

Reason function returns reason value.

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 *duration.Duration `protobuf:"bytes,7,opt,name=message_timeout,json=messageTimeout,proto3" json:"message_timeout,omitempty"`
	// [#not-implemented-hide:]
	// 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"`
	// contains filtered or unexported fields
}

[#next-free-field: 9]

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) GetFailureModeAllow

func (x *ExternalProcessor) GetFailureModeAllow() bool

func (*ExternalProcessor) GetGrpcService

func (x *ExternalProcessor) GetGrpcService() *v3.GrpcService

func (*ExternalProcessor) GetMessageTimeout

func (x *ExternalProcessor) GetMessageTimeout() *duration.Duration

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

func (*ExternalProcessor) Validate

func (m *ExternalProcessor) Validate() error

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

func (m *ExternalProcessor) ValidateAll() error

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

type ExternalProcessorMultiError

type ExternalProcessorMultiError []error

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

func (ExternalProcessorMultiError) AllErrors

func (m ExternalProcessorMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ExternalProcessorMultiError) Error

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

type ExternalProcessorValidationError

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

ExternalProcessorValidationError is the validation error returned by ExternalProcessor.Validate if the designated constraints aren't met.

func (ExternalProcessorValidationError) Cause

Cause function returns cause value.

func (ExternalProcessorValidationError) Error

Error satisfies the builtin error interface

func (ExternalProcessorValidationError) ErrorName

ErrorName returns error name.

func (ExternalProcessorValidationError) Field

Field function returns field value.

func (ExternalProcessorValidationError) Key

Key function returns key value.

func (ExternalProcessorValidationError) Reason

Reason function returns reason value.

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

func (*ProcessingMode) Validate

func (m *ProcessingMode) Validate() error

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

func (m *ProcessingMode) ValidateAll() error

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

type ProcessingModeMultiError

type ProcessingModeMultiError []error

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

func (ProcessingModeMultiError) AllErrors

func (m ProcessingModeMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ProcessingModeMultiError) Error

func (m ProcessingModeMultiError) Error() string

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

type ProcessingModeValidationError

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

ProcessingModeValidationError is the validation error returned by ProcessingMode.Validate if the designated constraints aren't met.

func (ProcessingModeValidationError) Cause

Cause function returns cause value.

func (ProcessingModeValidationError) Error

Error satisfies the builtin error interface

func (ProcessingModeValidationError) ErrorName

func (e ProcessingModeValidationError) ErrorName() string

ErrorName returns error name.

func (ProcessingModeValidationError) Field

Field function returns field value.

func (ProcessingModeValidationError) Key

Key function returns key value.

func (ProcessingModeValidationError) Reason

Reason function returns reason value.

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) Enum

func (ProcessingMode_BodySendMode) EnumDescriptor deprecated

func (ProcessingMode_BodySendMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use ProcessingMode_BodySendMode.Descriptor instead.

func (ProcessingMode_BodySendMode) Number

func (ProcessingMode_BodySendMode) String

func (ProcessingMode_BodySendMode) Type

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) Enum

func (ProcessingMode_HeaderSendMode) EnumDescriptor deprecated

func (ProcessingMode_HeaderSendMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use ProcessingMode_HeaderSendMode.Descriptor instead.

func (ProcessingMode_HeaderSendMode) Number

func (ProcessingMode_HeaderSendMode) String

func (ProcessingMode_HeaderSendMode) Type

Jump to

Keyboard shortcuts

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