envoy_service_ext_proc_v3alpha

package
v0.9.9 Latest Latest
Warning

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

 Go to latest Published: May 21, 2021 License: Apache-2.0 Imports: 26 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	CommonResponse_ResponseStatus_name = map[int32]string{
		0: "CONTINUE",
		1: "CONTINUE_AND_REPLACE",
	}
	CommonResponse_ResponseStatus_value = map[string]int32{
		"CONTINUE":             0,
		"CONTINUE_AND_REPLACE": 1,
	}
)

Enum value maps for CommonResponse_ResponseStatus.

View Source 
var File_envoy_service_ext_proc_v3alpha_external_processor_proto protoreflect.FileDescriptor

Functions

func RegisterExternalProcessorServer 

func RegisterExternalProcessorServer(s *grpc.Server, srv ExternalProcessorServer)

Types

type BodyMutation 

type BodyMutation struct {

	// Types that are assignable to Mutation:
	//	*BodyMutation_Body
	//	*BodyMutation_ClearBody
	Mutation isBodyMutation_Mutation `protobuf_oneof:"mutation"`
	// contains filtered or unexported fields
}

Replace the entire message body chunk received in the corresponding HttpBody message with this new body, or clear the body.

func (*BodyMutation) Descriptor deprecated 

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

Deprecated: Use BodyMutation.ProtoReflect.Descriptor instead.

func (*BodyMutation) GetBody 

func (x *BodyMutation) GetBody() []byte

func (*BodyMutation) GetClearBody 

func (x *BodyMutation) GetClearBody() bool

func (*BodyMutation) GetMutation 

func (m *BodyMutation) GetMutation() isBodyMutation_Mutation

func (*BodyMutation) ProtoMessage 

func (*BodyMutation) ProtoMessage()

func (*BodyMutation) ProtoReflect 

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

func (*BodyMutation) Reset 

func (x *BodyMutation) Reset()

func (*BodyMutation) String 

func (x *BodyMutation) String() string

func (*BodyMutation) Validate 

func (m *BodyMutation) Validate() error

Validate checks the field values on BodyMutation with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type BodyMutationValidationError 

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

BodyMutationValidationError is the validation error returned by BodyMutation.Validate if the designated constraints aren't met.

func (BodyMutationValidationError) Cause 

func (e BodyMutationValidationError) Cause() error

Cause function returns cause value.

func (BodyMutationValidationError) Error 

func (e BodyMutationValidationError) Error() string

Error satisfies the builtin error interface

func (BodyMutationValidationError) ErrorName 

func (e BodyMutationValidationError) ErrorName() string

ErrorName returns error name.

func (BodyMutationValidationError) Field 

func (e BodyMutationValidationError) Field() string

Field function returns field value.

func (BodyMutationValidationError) Key 

func (e BodyMutationValidationError) Key() bool

Key function returns key value.

func (BodyMutationValidationError) Reason 

func (e BodyMutationValidationError) Reason() string

Reason function returns reason value.

type BodyMutation_Body 

type BodyMutation_Body struct {
	// The entire body to replace
	Body []byte `protobuf:"bytes,1,opt,name=body,proto3,oneof"`
}

type BodyMutation_ClearBody 

type BodyMutation_ClearBody struct {
	// Clear the corresponding body chunk
	ClearBody bool `protobuf:"varint,2,opt,name=clear_body,json=clearBody,proto3,oneof"`
}

type BodyResponse 

type BodyResponse struct {
	Response *CommonResponse `protobuf:"bytes,1,opt,name=response,proto3" json:"response,omitempty"`
	// contains filtered or unexported fields
}

This message must be sent in response to an HttpBody message.

func (*BodyResponse) Descriptor deprecated 

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

Deprecated: Use BodyResponse.ProtoReflect.Descriptor instead.

func (*BodyResponse) GetResponse 

func (x *BodyResponse) GetResponse() *CommonResponse

func (*BodyResponse) ProtoMessage 

func (*BodyResponse) ProtoMessage()

func (*BodyResponse) ProtoReflect 

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

func (*BodyResponse) Reset 

func (x *BodyResponse) Reset()

func (*BodyResponse) String 

func (x *BodyResponse) String() string

func (*BodyResponse) Validate 

func (m *BodyResponse) Validate() error

Validate checks the field values on BodyResponse with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type BodyResponseValidationError 

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

BodyResponseValidationError is the validation error returned by BodyResponse.Validate if the designated constraints aren't met.

func (BodyResponseValidationError) Cause 

func (e BodyResponseValidationError) Cause() error

Cause function returns cause value.

func (BodyResponseValidationError) Error 

func (e BodyResponseValidationError) Error() string

Error satisfies the builtin error interface

func (BodyResponseValidationError) ErrorName 

func (e BodyResponseValidationError) ErrorName() string

ErrorName returns error name.

func (BodyResponseValidationError) Field 

func (e BodyResponseValidationError) Field() string

Field function returns field value.

func (BodyResponseValidationError) Key 

func (e BodyResponseValidationError) Key() bool

Key function returns key value.

func (BodyResponseValidationError) Reason 

func (e BodyResponseValidationError) Reason() string

Reason function returns reason value.

type CommonResponse 

type CommonResponse struct {

	// If set, provide additional direction on how the Envoy proxy should
	// handle the rest of the HTTP filter chain.
	Status CommonResponse_ResponseStatus `` /* 132-byte string literal not displayed */
	// Instructions on how to manipulate the headers. When responding to an
	// HttpBody request, header mutations will only take effect if
	// the current processing mode for the body is BUFFERED.
	HeaderMutation *HeaderMutation `protobuf:"bytes,2,opt,name=header_mutation,json=headerMutation,proto3" json:"header_mutation,omitempty"`
	// Replace the body of the last message sent to the remote server on this
	// stream. If responding to an HttpBody request, simply replace or clear
	// the body chunk that was sent with that request. Body mutations only take
	// effect in response to "body" messages and are ignored otherwise.
	BodyMutation *BodyMutation `protobuf:"bytes,3,opt,name=body_mutation,json=bodyMutation,proto3" json:"body_mutation,omitempty"`
	// [#not-implemented-hide:]
	// Add new trailers to the message. This may be used when responding to either a
	// HttpHeaders or HttpBody message, but only if this message is returned
	// along with the CONTINUE_AND_REPLACE status.
	Trailers *v3.HeaderMap `protobuf:"bytes,4,opt,name=trailers,proto3" json:"trailers,omitempty"`
	// Clear the route cache for the current request.
	// This is necessary if the remote server
	// modified headers that are used to calculate the route.
	ClearRouteCache bool `protobuf:"varint,5,opt,name=clear_route_cache,json=clearRouteCache,proto3" json:"clear_route_cache,omitempty"`
	// contains filtered or unexported fields
}

This message contains common fields between header and body responses. [#next-free-field: 6]

func (*CommonResponse) Descriptor deprecated 

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

Deprecated: Use CommonResponse.ProtoReflect.Descriptor instead.

func (*CommonResponse) GetBodyMutation 

func (x *CommonResponse) GetBodyMutation() *BodyMutation

func (*CommonResponse) GetClearRouteCache 

func (x *CommonResponse) GetClearRouteCache() bool

func (*CommonResponse) GetHeaderMutation 

func (x *CommonResponse) GetHeaderMutation() *HeaderMutation

func (*CommonResponse) GetStatus 

func (x *CommonResponse) GetStatus() CommonResponse_ResponseStatus

func (*CommonResponse) GetTrailers 

func (x *CommonResponse) GetTrailers() *v3.HeaderMap

func (*CommonResponse) ProtoMessage 

func (*CommonResponse) ProtoMessage()

func (*CommonResponse) ProtoReflect 

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

func (*CommonResponse) Reset 

func (x *CommonResponse) Reset()

func (*CommonResponse) String 

func (x *CommonResponse) String() string

func (*CommonResponse) Validate 

func (m *CommonResponse) Validate() error

Validate checks the field values on CommonResponse with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type CommonResponseValidationError 

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

CommonResponseValidationError is the validation error returned by CommonResponse.Validate if the designated constraints aren't met.

func (CommonResponseValidationError) Cause 

func (e CommonResponseValidationError) Cause() error

Cause function returns cause value.

func (CommonResponseValidationError) Error 

func (e CommonResponseValidationError) Error() string

Error satisfies the builtin error interface

func (CommonResponseValidationError) ErrorName 

func (e CommonResponseValidationError) ErrorName() string

ErrorName returns error name.

func (CommonResponseValidationError) Field 

func (e CommonResponseValidationError) Field() string

Field function returns field value.

func (CommonResponseValidationError) Key 

func (e CommonResponseValidationError) Key() bool

Key function returns key value.

func (CommonResponseValidationError) Reason 

func (e CommonResponseValidationError) Reason() string

Reason function returns reason value.

type CommonResponse_ResponseStatus 

type CommonResponse_ResponseStatus int32
const (
	// Apply the mutation instructions in this message to the
	// request or response, and then continue processing the filter
	// stream as normal. This is the default.
	CommonResponse_CONTINUE CommonResponse_ResponseStatus = 0
	// Apply the specified header mutation, replace the body with the body
	// specified in the body mutation (if present), and do not send any
	// further messages for this request or response even if the processing
	// mode is configured to do so.
	//
	// When used in response to a request_headers or response_headers message,
	// this status makes it possible to either completely replace the body
	// while discarding the original body, or to add a body to a message that
	// formerly did not have one.
	//
	// In other words, this response makes it possible to turn an HTTP GET
	// into a POST, PUT, or PATCH.
	CommonResponse_CONTINUE_AND_REPLACE CommonResponse_ResponseStatus = 1
)

func (CommonResponse_ResponseStatus) Descriptor 

func (CommonResponse_ResponseStatus) Descriptor() protoreflect.EnumDescriptor

func (CommonResponse_ResponseStatus) Enum 

func (x CommonResponse_ResponseStatus) Enum() *CommonResponse_ResponseStatus

func (CommonResponse_ResponseStatus) EnumDescriptor deprecated 

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

Deprecated: Use CommonResponse_ResponseStatus.Descriptor instead.

func (CommonResponse_ResponseStatus) Number 

func (x CommonResponse_ResponseStatus) Number() protoreflect.EnumNumber

func (CommonResponse_ResponseStatus) String 

func (x CommonResponse_ResponseStatus) String() string

func (CommonResponse_ResponseStatus) Type 

func (CommonResponse_ResponseStatus) Type() protoreflect.EnumType

type ExternalProcessorClient 

type ExternalProcessorClient interface {
	// This begins the bidirectional stream that Envoy will use to
	// give the server control over what the filter does. The actual
	// protocol is described by the ProcessingRequest and ProcessingResponse
	// messages below.
	Process(ctx context.Context, opts ...grpc.CallOption) (ExternalProcessor_ProcessClient, error)
}

ExternalProcessorClient is the client API for ExternalProcessor service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewExternalProcessorClient 

func NewExternalProcessorClient(cc grpc.ClientConnInterface) ExternalProcessorClient

type ExternalProcessorServer 

type ExternalProcessorServer interface {
	// This begins the bidirectional stream that Envoy will use to
	// give the server control over what the filter does. The actual
	// protocol is described by the ProcessingRequest and ProcessingResponse
	// messages below.
	Process(ExternalProcessor_ProcessServer) error
}

ExternalProcessorServer is the server API for ExternalProcessor service.

type ExternalProcessor_ProcessClient 

type ExternalProcessor_ProcessClient interface {
	Send(*ProcessingRequest) error
	Recv() (*ProcessingResponse, error)
	grpc.ClientStream
}

type ExternalProcessor_ProcessServer 

type ExternalProcessor_ProcessServer interface {
	Send(*ProcessingResponse) error
	Recv() (*ProcessingRequest, error)
	grpc.ServerStream
}

type GrpcStatus 

type GrpcStatus struct {

	// The actual gRPC status
	Status uint32 `protobuf:"varint,1,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

This message specifies a gRPC status for an ImmediateResponse message.

func (*GrpcStatus) Descriptor deprecated 

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

Deprecated: Use GrpcStatus.ProtoReflect.Descriptor instead.

func (*GrpcStatus) GetStatus 

func (x *GrpcStatus) GetStatus() uint32

func (*GrpcStatus) ProtoMessage 

func (*GrpcStatus) ProtoMessage()

func (*GrpcStatus) ProtoReflect 

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

func (*GrpcStatus) Reset 

func (x *GrpcStatus) Reset()

func (*GrpcStatus) String 

func (x *GrpcStatus) String() string

func (*GrpcStatus) Validate 

func (m *GrpcStatus) Validate() error

Validate checks the field values on GrpcStatus with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type GrpcStatusValidationError 

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

GrpcStatusValidationError is the validation error returned by GrpcStatus.Validate if the designated constraints aren't met.

func (GrpcStatusValidationError) Cause 

func (e GrpcStatusValidationError) Cause() error

Cause function returns cause value.

func (GrpcStatusValidationError) Error 

func (e GrpcStatusValidationError) Error() string

Error satisfies the builtin error interface

func (GrpcStatusValidationError) ErrorName 

func (e GrpcStatusValidationError) ErrorName() string

ErrorName returns error name.

func (GrpcStatusValidationError) Field 

func (e GrpcStatusValidationError) Field() string

Field function returns field value.

func (GrpcStatusValidationError) Key 

func (e GrpcStatusValidationError) Key() bool

Key function returns key value.

func (GrpcStatusValidationError) Reason 

func (e GrpcStatusValidationError) Reason() string

Reason function returns reason value.

type HeaderMutation 

type HeaderMutation struct {

	// Add or replace HTTP headers. Attempts to set the value of
	// any "x-envoy" header, and attempts to set the ":method",
	// ":authority", ":scheme", or "host" headers will be ignored.
	SetHeaders []*v3.HeaderValueOption `protobuf:"bytes,1,rep,name=set_headers,json=setHeaders,proto3" json:"set_headers,omitempty"`
	// Remove these HTTP headers. Attempts to remove system headers --
	// any header starting with ":", plus "host" -- will be ignored.
	RemoveHeaders []string `protobuf:"bytes,2,rep,name=remove_headers,json=removeHeaders,proto3" json:"remove_headers,omitempty"`
	// contains filtered or unexported fields
}

Change HTTP headers or trailers by appending, replacing, or removing headers.

func (*HeaderMutation) Descriptor deprecated 

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

Deprecated: Use HeaderMutation.ProtoReflect.Descriptor instead.

func (*HeaderMutation) GetRemoveHeaders 

func (x *HeaderMutation) GetRemoveHeaders() []string

func (*HeaderMutation) GetSetHeaders 

func (x *HeaderMutation) GetSetHeaders() []*v3.HeaderValueOption

func (*HeaderMutation) ProtoMessage 

func (*HeaderMutation) ProtoMessage()

func (*HeaderMutation) ProtoReflect 

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

func (*HeaderMutation) Reset 

func (x *HeaderMutation) Reset()

func (*HeaderMutation) String 

func (x *HeaderMutation) String() string

func (*HeaderMutation) Validate 

func (m *HeaderMutation) Validate() error

Validate checks the field values on HeaderMutation with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type HeaderMutationValidationError 

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

HeaderMutationValidationError is the validation error returned by HeaderMutation.Validate if the designated constraints aren't met.

func (HeaderMutationValidationError) Cause 

func (e HeaderMutationValidationError) Cause() error

Cause function returns cause value.

func (HeaderMutationValidationError) Error 

func (e HeaderMutationValidationError) Error() string

Error satisfies the builtin error interface

func (HeaderMutationValidationError) ErrorName 

func (e HeaderMutationValidationError) ErrorName() string

ErrorName returns error name.

func (HeaderMutationValidationError) Field 

func (e HeaderMutationValidationError) Field() string

Field function returns field value.

func (HeaderMutationValidationError) Key 

func (e HeaderMutationValidationError) Key() bool

Key function returns key value.

func (HeaderMutationValidationError) Reason 

func (e HeaderMutationValidationError) Reason() string

Reason function returns reason value.

type HeadersResponse 

type HeadersResponse struct {
	Response *CommonResponse `protobuf:"bytes,1,opt,name=response,proto3" json:"response,omitempty"`
	// contains filtered or unexported fields
}

This message must be sent in response to an HttpHeaders message.

func (*HeadersResponse) Descriptor deprecated 

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

Deprecated: Use HeadersResponse.ProtoReflect.Descriptor instead.

func (*HeadersResponse) GetResponse 

func (x *HeadersResponse) GetResponse() *CommonResponse

func (*HeadersResponse) ProtoMessage 

func (*HeadersResponse) ProtoMessage()

func (*HeadersResponse) ProtoReflect 

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

func (*HeadersResponse) Reset 

func (x *HeadersResponse) Reset()

func (*HeadersResponse) String 

func (x *HeadersResponse) String() string

func (*HeadersResponse) Validate 

func (m *HeadersResponse) Validate() error

Validate checks the field values on HeadersResponse with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type HeadersResponseValidationError 

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

HeadersResponseValidationError is the validation error returned by HeadersResponse.Validate if the designated constraints aren't met.

func (HeadersResponseValidationError) Cause 

func (e HeadersResponseValidationError) Cause() error

Cause function returns cause value.

func (HeadersResponseValidationError) Error 

func (e HeadersResponseValidationError) Error() string

Error satisfies the builtin error interface

func (HeadersResponseValidationError) ErrorName 

func (e HeadersResponseValidationError) ErrorName() string

ErrorName returns error name.

func (HeadersResponseValidationError) Field 

func (e HeadersResponseValidationError) Field() string

Field function returns field value.

func (HeadersResponseValidationError) Key 

func (e HeadersResponseValidationError) Key() bool

Key function returns key value.

func (HeadersResponseValidationError) Reason 

func (e HeadersResponseValidationError) Reason() string

Reason function returns reason value.

type HttpBody 

type HttpBody struct {
	Body        []byte `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	EndOfStream bool   `protobuf:"varint,2,opt,name=end_of_stream,json=endOfStream,proto3" json:"end_of_stream,omitempty"`
	// contains filtered or unexported fields
}

This message contains the message body that Envoy sends to the external server.

func (*HttpBody) Descriptor deprecated 

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

Deprecated: Use HttpBody.ProtoReflect.Descriptor instead.

func (*HttpBody) GetBody 

func (x *HttpBody) GetBody() []byte

func (*HttpBody) GetEndOfStream 

func (x *HttpBody) GetEndOfStream() bool

func (*HttpBody) ProtoMessage 

func (*HttpBody) ProtoMessage()

func (*HttpBody) ProtoReflect 

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

func (*HttpBody) Reset 

func (x *HttpBody) Reset()

func (*HttpBody) String 

func (x *HttpBody) String() string

func (*HttpBody) Validate 

func (m *HttpBody) Validate() error

Validate checks the field values on HttpBody with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type HttpBodyValidationError 

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

HttpBodyValidationError is the validation error returned by HttpBody.Validate if the designated constraints aren't met.

func (HttpBodyValidationError) Cause 

func (e HttpBodyValidationError) Cause() error

Cause function returns cause value.

func (HttpBodyValidationError) Error 

func (e HttpBodyValidationError) Error() string

Error satisfies the builtin error interface

func (HttpBodyValidationError) ErrorName 

func (e HttpBodyValidationError) ErrorName() string

ErrorName returns error name.

func (HttpBodyValidationError) Field 

func (e HttpBodyValidationError) Field() string

Field function returns field value.

func (HttpBodyValidationError) Key 

func (e HttpBodyValidationError) Key() bool

Key function returns key value.

func (HttpBodyValidationError) Reason 

func (e HttpBodyValidationError) Reason() string

Reason function returns reason value.

type HttpHeaders 

type HttpHeaders struct {

	// The HTTP request headers. All header keys will be
	// lower-cased, because HTTP header keys are case-insensitive.
	Headers *v3.HeaderMap `protobuf:"bytes,1,opt,name=headers,proto3" json:"headers,omitempty"`
	// [#not-implemented-hide:]
	// The values of properties selected by the "request_attributes"
	// or "response_attributes" list in the configuration. Each entry
	// in the list is populated
	// from the standard :ref:`attributes <arch_overview_attributes>`
	// supported across Envoy.
	Attributes map[string]*_struct.Struct `` /* 161-byte string literal not displayed */
	// If true, then there is no message body associated with this
	// request or response.
	EndOfStream bool `protobuf:"varint,3,opt,name=end_of_stream,json=endOfStream,proto3" json:"end_of_stream,omitempty"`
	// contains filtered or unexported fields
}

This message is sent to the external server when the HTTP request and responses are first received.

func (*HttpHeaders) Descriptor deprecated 

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

Deprecated: Use HttpHeaders.ProtoReflect.Descriptor instead.

func (*HttpHeaders) GetAttributes 

func (x *HttpHeaders) GetAttributes() map[string]*_struct.Struct

func (*HttpHeaders) GetEndOfStream 

func (x *HttpHeaders) GetEndOfStream() bool

func (*HttpHeaders) GetHeaders 

func (x *HttpHeaders) GetHeaders() *v3.HeaderMap

func (*HttpHeaders) ProtoMessage 

func (*HttpHeaders) ProtoMessage()

func (*HttpHeaders) ProtoReflect 

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

func (*HttpHeaders) Reset 

func (x *HttpHeaders) Reset()

func (*HttpHeaders) String 

func (x *HttpHeaders) String() string

func (*HttpHeaders) Validate 

func (m *HttpHeaders) Validate() error

Validate checks the field values on HttpHeaders with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type HttpHeadersValidationError 

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

HttpHeadersValidationError is the validation error returned by HttpHeaders.Validate if the designated constraints aren't met.

func (HttpHeadersValidationError) Cause 

func (e HttpHeadersValidationError) Cause() error

Cause function returns cause value.

func (HttpHeadersValidationError) Error 

func (e HttpHeadersValidationError) Error() string

Error satisfies the builtin error interface

func (HttpHeadersValidationError) ErrorName 

func (e HttpHeadersValidationError) ErrorName() string

ErrorName returns error name.

func (HttpHeadersValidationError) Field 

func (e HttpHeadersValidationError) Field() string

Field function returns field value.

func (HttpHeadersValidationError) Key 

func (e HttpHeadersValidationError) Key() bool

Key function returns key value.

func (HttpHeadersValidationError) Reason 

func (e HttpHeadersValidationError) Reason() string

Reason function returns reason value.

type HttpTrailers 

type HttpTrailers struct {
	Trailers *v3.HeaderMap `protobuf:"bytes,1,opt,name=trailers,proto3" json:"trailers,omitempty"`
	// contains filtered or unexported fields
}

This message contains the trailers.

func (*HttpTrailers) Descriptor deprecated 

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

Deprecated: Use HttpTrailers.ProtoReflect.Descriptor instead.

func (*HttpTrailers) GetTrailers 

func (x *HttpTrailers) GetTrailers() *v3.HeaderMap

func (*HttpTrailers) ProtoMessage 

func (*HttpTrailers) ProtoMessage()

func (*HttpTrailers) ProtoReflect 

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

func (*HttpTrailers) Reset 

func (x *HttpTrailers) Reset()

func (*HttpTrailers) String 

func (x *HttpTrailers) String() string

func (*HttpTrailers) Validate 

func (m *HttpTrailers) Validate() error

Validate checks the field values on HttpTrailers with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type HttpTrailersValidationError 

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

HttpTrailersValidationError is the validation error returned by HttpTrailers.Validate if the designated constraints aren't met.

func (HttpTrailersValidationError) Cause 

func (e HttpTrailersValidationError) Cause() error

Cause function returns cause value.

func (HttpTrailersValidationError) Error 

func (e HttpTrailersValidationError) Error() string

Error satisfies the builtin error interface

func (HttpTrailersValidationError) ErrorName 

func (e HttpTrailersValidationError) ErrorName() string

ErrorName returns error name.

func (HttpTrailersValidationError) Field 

func (e HttpTrailersValidationError) Field() string

Field function returns field value.

func (HttpTrailersValidationError) Key 

func (e HttpTrailersValidationError) Key() bool

Key function returns key value.

func (HttpTrailersValidationError) Reason 

func (e HttpTrailersValidationError) Reason() string

Reason function returns reason value.

type ImmediateResponse 

type ImmediateResponse struct {

	// The response code to return
	Status *v31.HttpStatus `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// Apply changes to the default headers, which will include content-type.
	Headers *HeaderMutation `protobuf:"bytes,2,opt,name=headers,proto3" json:"headers,omitempty"`
	// The message body to return with the response which is sent using the
	// text/plain content type, or encoded in the grpc-message header.
	Body string `protobuf:"bytes,3,opt,name=body,proto3" json:"body,omitempty"`
	// If set, then include a gRPC status trailer.
	GrpcStatus *GrpcStatus `protobuf:"bytes,4,opt,name=grpc_status,json=grpcStatus,proto3" json:"grpc_status,omitempty"`
	// A string detailing why this local reply was sent, which may be included
	// in log and debug output.
	Details string `protobuf:"bytes,5,opt,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

This message causes the filter to attempt to create a locally generated response, send it downstream, stop processing additional filters, and ignore any additional messages received from the remote server for this request or response. If a response has already started, then this will either ship the reply directly to the downstream codec, or reset the stream. [#next-free-field: 6]

func (*ImmediateResponse) Descriptor deprecated 

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

Deprecated: Use ImmediateResponse.ProtoReflect.Descriptor instead.

func (*ImmediateResponse) GetBody 

func (x *ImmediateResponse) GetBody() string

func (*ImmediateResponse) GetDetails 

func (x *ImmediateResponse) GetDetails() string

func (*ImmediateResponse) GetGrpcStatus 

func (x *ImmediateResponse) GetGrpcStatus() *GrpcStatus

func (*ImmediateResponse) GetHeaders 

func (x *ImmediateResponse) GetHeaders() *HeaderMutation

func (*ImmediateResponse) GetStatus 

func (x *ImmediateResponse) GetStatus() *v31.HttpStatus

func (*ImmediateResponse) ProtoMessage 

func (*ImmediateResponse) ProtoMessage()

func (*ImmediateResponse) ProtoReflect 

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

func (*ImmediateResponse) Reset 

func (x *ImmediateResponse) Reset()

func (*ImmediateResponse) String 

func (x *ImmediateResponse) String() string

func (*ImmediateResponse) Validate 

func (m *ImmediateResponse) Validate() error

Validate checks the field values on ImmediateResponse with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type ImmediateResponseValidationError 

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

ImmediateResponseValidationError is the validation error returned by ImmediateResponse.Validate if the designated constraints aren't met.

func (ImmediateResponseValidationError) Cause 

func (e ImmediateResponseValidationError) Cause() error

Cause function returns cause value.

func (ImmediateResponseValidationError) Error 

func (e ImmediateResponseValidationError) Error() string

Error satisfies the builtin error interface

func (ImmediateResponseValidationError) ErrorName 

func (e ImmediateResponseValidationError) ErrorName() string

ErrorName returns error name.

func (ImmediateResponseValidationError) Field 

func (e ImmediateResponseValidationError) Field() string

Field function returns field value.

func (ImmediateResponseValidationError) Key 

func (e ImmediateResponseValidationError) Key() bool

Key function returns key value.

func (ImmediateResponseValidationError) Reason 

func (e ImmediateResponseValidationError) Reason() string

Reason function returns reason value.

type ProcessingRequest 

type ProcessingRequest struct {

	// Specify whether the filter that sent this request is running in synchronous
	// or asynchronous mode. The choice of synchronous or asynchronous mode
	// can be set in the filter configuration, and defaults to false.
	//
	// * A value of "false" indicates that the server must respond
	//   to this message by either sending back a matching ProcessingResponse message,
	//   or by closing the stream.
	// * A value of "true" indicates that the server must not respond to this
	//   message, although it may still close the stream to indicate that no more messages
	//   are needed.
	//
	AsyncMode bool `protobuf:"varint,1,opt,name=async_mode,json=asyncMode,proto3" json:"async_mode,omitempty"`
	// Each request message will include one of the following sub-messages. Which
	// ones are set for a particular HTTP request/response depend on the
	// processing mode.
	//
	// Types that are assignable to Request:
	//	*ProcessingRequest_RequestHeaders
	//	*ProcessingRequest_ResponseHeaders
	//	*ProcessingRequest_RequestBody
	//	*ProcessingRequest_ResponseBody
	//	*ProcessingRequest_RequestTrailers
	//	*ProcessingRequest_ResponseTrailers
	Request isProcessingRequest_Request `protobuf_oneof:"request"`
	// contains filtered or unexported fields
}

This represents the different types of messages that Envoy can send to an external processing server. [#next-free-field: 8]

func (*ProcessingRequest) Descriptor deprecated 

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

Deprecated: Use ProcessingRequest.ProtoReflect.Descriptor instead.

func (*ProcessingRequest) GetAsyncMode 

func (x *ProcessingRequest) GetAsyncMode() bool

func (*ProcessingRequest) GetRequest 

func (m *ProcessingRequest) GetRequest() isProcessingRequest_Request

func (*ProcessingRequest) GetRequestBody 

func (x *ProcessingRequest) GetRequestBody() *HttpBody

func (*ProcessingRequest) GetRequestHeaders 

func (x *ProcessingRequest) GetRequestHeaders() *HttpHeaders

func (*ProcessingRequest) GetRequestTrailers 

func (x *ProcessingRequest) GetRequestTrailers() *HttpTrailers

func (*ProcessingRequest) GetResponseBody 

func (x *ProcessingRequest) GetResponseBody() *HttpBody

func (*ProcessingRequest) GetResponseHeaders 

func (x *ProcessingRequest) GetResponseHeaders() *HttpHeaders

func (*ProcessingRequest) GetResponseTrailers 

func (x *ProcessingRequest) GetResponseTrailers() *HttpTrailers

func (*ProcessingRequest) ProtoMessage 

func (*ProcessingRequest) ProtoMessage()

func (*ProcessingRequest) ProtoReflect 

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

func (*ProcessingRequest) Reset 

func (x *ProcessingRequest) Reset()

func (*ProcessingRequest) String 

func (x *ProcessingRequest) String() string

func (*ProcessingRequest) Validate 

func (m *ProcessingRequest) Validate() error

Validate checks the field values on ProcessingRequest with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type ProcessingRequestValidationError 

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

ProcessingRequestValidationError is the validation error returned by ProcessingRequest.Validate if the designated constraints aren't met.

func (ProcessingRequestValidationError) Cause 

func (e ProcessingRequestValidationError) Cause() error

Cause function returns cause value.

func (ProcessingRequestValidationError) Error 

func (e ProcessingRequestValidationError) Error() string

Error satisfies the builtin error interface

func (ProcessingRequestValidationError) ErrorName 

func (e ProcessingRequestValidationError) ErrorName() string

ErrorName returns error name.

func (ProcessingRequestValidationError) Field 

func (e ProcessingRequestValidationError) Field() string

Field function returns field value.

func (ProcessingRequestValidationError) Key 

func (e ProcessingRequestValidationError) Key() bool

Key function returns key value.

func (ProcessingRequestValidationError) Reason 

func (e ProcessingRequestValidationError) Reason() string

Reason function returns reason value.

type ProcessingRequest_RequestBody 

type ProcessingRequest_RequestBody struct {
	// A chunk of the HTTP request body. Unless "async_mode" is true, the server must send back
	// a BodyResponse message, an ImmediateResponse message, or close the stream.
	RequestBody *HttpBody `protobuf:"bytes,4,opt,name=request_body,json=requestBody,proto3,oneof"`
}

type ProcessingRequest_RequestHeaders 

type ProcessingRequest_RequestHeaders struct {
	// Information about the HTTP request headers, as well as peer info and additional
	// properties. Unless "async_mode" is true, the server must send back a
	// HeaderResponse message, an ImmediateResponse message, or close the stream.
	RequestHeaders *HttpHeaders `protobuf:"bytes,2,opt,name=request_headers,json=requestHeaders,proto3,oneof"`
}

type ProcessingRequest_RequestTrailers 

type ProcessingRequest_RequestTrailers struct {
	// The HTTP trailers for the request path. Unless "async_mode" is true, the server
	// must send back a TrailerResponse message or close the stream.
	//
	// This message is only sent if the trailers processing mode is set to "SEND".
	// If there are no trailers on the original downstream request, then this message
	// will only be sent (with empty trailers waiting to be populated) if the
	// processing mode is set before the request headers are sent, such as
	// in the filter configuration.
	RequestTrailers *HttpTrailers `protobuf:"bytes,6,opt,name=request_trailers,json=requestTrailers,proto3,oneof"`
}

type ProcessingRequest_ResponseBody 

type ProcessingRequest_ResponseBody struct {
	// A chunk of the HTTP request body. Unless "async_mode" is true, the server must send back
	// a BodyResponse message or close the stream.
	ResponseBody *HttpBody `protobuf:"bytes,5,opt,name=response_body,json=responseBody,proto3,oneof"`
}

type ProcessingRequest_ResponseHeaders 

type ProcessingRequest_ResponseHeaders struct {
	// Information about the HTTP response headers, as well as peer info and additional
	// properties. Unless "async_mode" is true, the server must send back a
	// HeaderResponse message or close the stream.
	ResponseHeaders *HttpHeaders `protobuf:"bytes,3,opt,name=response_headers,json=responseHeaders,proto3,oneof"`
}

type ProcessingRequest_ResponseTrailers 

type ProcessingRequest_ResponseTrailers struct {
	// The HTTP trailers for the response path. Unless "async_mode" is true, the server
	// must send back a TrailerResponse message or close the stream.
	//
	// This message is only sent if the trailers processing mode is set to "SEND".
	// If there are no trailers on the original downstream request, then this message
	// will only be sent (with empty trailers waiting to be populated) if the
	// processing mode is set before the request headers are sent, such as
	// in the filter configuration.
	ResponseTrailers *HttpTrailers `protobuf:"bytes,7,opt,name=response_trailers,json=responseTrailers,proto3,oneof"`
}

type ProcessingResponse 

type ProcessingResponse struct {

	// Types that are assignable to Response:
	//	*ProcessingResponse_RequestHeaders
	//	*ProcessingResponse_ResponseHeaders
	//	*ProcessingResponse_RequestBody
	//	*ProcessingResponse_ResponseBody
	//	*ProcessingResponse_RequestTrailers
	//	*ProcessingResponse_ResponseTrailers
	//	*ProcessingResponse_ImmediateResponse
	Response isProcessingResponse_Response `protobuf_oneof:"response"`
	// [#not-implemented-hide:]
	// Optional metadata that will be emitted as dynamic metadata to be consumed by the next
	// filter. This metadata will be placed in the namespace "envoy.filters.http.ext_proc".
	DynamicMetadata *_struct.Struct `protobuf:"bytes,8,opt,name=dynamic_metadata,json=dynamicMetadata,proto3" json:"dynamic_metadata,omitempty"`
	// Override how parts of the HTTP request and response are processed
	// for the duration of this particular request/response only. Servers
	// may use this to intelligently control how requests are processed
	// based on the headers and other metadata that they see.
	ModeOverride *v3alpha.ProcessingMode `protobuf:"bytes,9,opt,name=mode_override,json=modeOverride,proto3" json:"mode_override,omitempty"`
	// contains filtered or unexported fields
}

For every ProcessingRequest received by the server with the "async_mode" field set to false, the server must send back exactly one ProcessingResponse message. [#next-free-field: 10]

func (*ProcessingResponse) Descriptor deprecated 

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

Deprecated: Use ProcessingResponse.ProtoReflect.Descriptor instead.

func (*ProcessingResponse) GetDynamicMetadata 

func (x *ProcessingResponse) GetDynamicMetadata() *_struct.Struct

func (*ProcessingResponse) GetImmediateResponse 

func (x *ProcessingResponse) GetImmediateResponse() *ImmediateResponse

func (*ProcessingResponse) GetModeOverride 

func (x *ProcessingResponse) GetModeOverride() *v3alpha.ProcessingMode

func (*ProcessingResponse) GetRequestBody 

func (x *ProcessingResponse) GetRequestBody() *BodyResponse

func (*ProcessingResponse) GetRequestHeaders 

func (x *ProcessingResponse) GetRequestHeaders() *HeadersResponse

func (*ProcessingResponse) GetRequestTrailers 

func (x *ProcessingResponse) GetRequestTrailers() *TrailersResponse

func (*ProcessingResponse) GetResponse 

func (m *ProcessingResponse) GetResponse() isProcessingResponse_Response

func (*ProcessingResponse) GetResponseBody 

func (x *ProcessingResponse) GetResponseBody() *BodyResponse

func (*ProcessingResponse) GetResponseHeaders 

func (x *ProcessingResponse) GetResponseHeaders() *HeadersResponse

func (*ProcessingResponse) GetResponseTrailers 

func (x *ProcessingResponse) GetResponseTrailers() *TrailersResponse

func (*ProcessingResponse) ProtoMessage 

func (*ProcessingResponse) ProtoMessage()

func (*ProcessingResponse) ProtoReflect 

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

func (*ProcessingResponse) Reset 

func (x *ProcessingResponse) Reset()

func (*ProcessingResponse) String 

func (x *ProcessingResponse) String() string

func (*ProcessingResponse) Validate 

func (m *ProcessingResponse) Validate() error

Validate checks the field values on ProcessingResponse with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type ProcessingResponseValidationError 

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

ProcessingResponseValidationError is the validation error returned by ProcessingResponse.Validate if the designated constraints aren't met.

func (ProcessingResponseValidationError) Cause 

func (e ProcessingResponseValidationError) Cause() error

Cause function returns cause value.

func (ProcessingResponseValidationError) Error 

func (e ProcessingResponseValidationError) Error() string

Error satisfies the builtin error interface

func (ProcessingResponseValidationError) ErrorName 

func (e ProcessingResponseValidationError) ErrorName() string

ErrorName returns error name.

func (ProcessingResponseValidationError) Field 

func (e ProcessingResponseValidationError) Field() string

Field function returns field value.

func (ProcessingResponseValidationError) Key 

func (e ProcessingResponseValidationError) Key() bool

Key function returns key value.

func (ProcessingResponseValidationError) Reason 

func (e ProcessingResponseValidationError) Reason() string

Reason function returns reason value.

type ProcessingResponse_ImmediateResponse 

type ProcessingResponse_ImmediateResponse struct {
	// If specified, attempt to create a locally generated response, send it
	// downstream, and stop processing additional filters and ignore any
	// additional messages received from the remote server for this request or
	// response. If a response has already started -- for example, if this
	// message is sent response to a "response_body" message -- then
	// this will either ship the reply directly to the downstream codec,
	// or reset the stream.
	ImmediateResponse *ImmediateResponse `protobuf:"bytes,7,opt,name=immediate_response,json=immediateResponse,proto3,oneof"`
}

type ProcessingResponse_RequestBody 

type ProcessingResponse_RequestBody struct {
	// The server must send back this message in response to a message with
	// the "request_body" field set.
	RequestBody *BodyResponse `protobuf:"bytes,3,opt,name=request_body,json=requestBody,proto3,oneof"`
}

type ProcessingResponse_RequestHeaders 

type ProcessingResponse_RequestHeaders struct {
	// The server must send back this message in response to a message with the
	// "request_headers" field set.
	RequestHeaders *HeadersResponse `protobuf:"bytes,1,opt,name=request_headers,json=requestHeaders,proto3,oneof"`
}

type ProcessingResponse_RequestTrailers 

type ProcessingResponse_RequestTrailers struct {
	// The server must send back this message in response to a message with
	// the "request_trailers" field set.
	RequestTrailers *TrailersResponse `protobuf:"bytes,5,opt,name=request_trailers,json=requestTrailers,proto3,oneof"`
}

type ProcessingResponse_ResponseBody 

type ProcessingResponse_ResponseBody struct {
	// The server must send back this message in response to a message with
	// the "response_body" field set.
	ResponseBody *BodyResponse `protobuf:"bytes,4,opt,name=response_body,json=responseBody,proto3,oneof"`
}

type ProcessingResponse_ResponseHeaders 

type ProcessingResponse_ResponseHeaders struct {
	// The server must send back this message in response to a message with the
	// "response_headers" field set.
	ResponseHeaders *HeadersResponse `protobuf:"bytes,2,opt,name=response_headers,json=responseHeaders,proto3,oneof"`
}

type ProcessingResponse_ResponseTrailers 

type ProcessingResponse_ResponseTrailers struct {
	// The server must send back this message in response to a message with
	// the "response_trailers" field set.
	ResponseTrailers *TrailersResponse `protobuf:"bytes,6,opt,name=response_trailers,json=responseTrailers,proto3,oneof"`
}

type TrailersResponse 

type TrailersResponse struct {

	// Instructions on how to manipulate the trailers
	HeaderMutation *HeaderMutation `protobuf:"bytes,1,opt,name=header_mutation,json=headerMutation,proto3" json:"header_mutation,omitempty"`
	// contains filtered or unexported fields
}

This message must be sent in response to an HttpTrailers message.

func (*TrailersResponse) Descriptor deprecated 

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

Deprecated: Use TrailersResponse.ProtoReflect.Descriptor instead.

func (*TrailersResponse) GetHeaderMutation 

func (x *TrailersResponse) GetHeaderMutation() *HeaderMutation

func (*TrailersResponse) ProtoMessage 

func (*TrailersResponse) ProtoMessage()

func (*TrailersResponse) ProtoReflect 

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

func (*TrailersResponse) Reset 

func (x *TrailersResponse) Reset()

func (*TrailersResponse) String 

func (x *TrailersResponse) String() string

func (*TrailersResponse) Validate 

func (m *TrailersResponse) Validate() error

Validate checks the field values on TrailersResponse with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type TrailersResponseValidationError 

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

TrailersResponseValidationError is the validation error returned by TrailersResponse.Validate if the designated constraints aren't met.

func (TrailersResponseValidationError) Cause 

func (e TrailersResponseValidationError) Cause() error

Cause function returns cause value.

func (TrailersResponseValidationError) Error 

func (e TrailersResponseValidationError) Error() string

Error satisfies the builtin error interface

func (TrailersResponseValidationError) ErrorName 

func (e TrailersResponseValidationError) ErrorName() string

ErrorName returns error name.

func (TrailersResponseValidationError) Field 

func (e TrailersResponseValidationError) Field() string

Field function returns field value.

func (TrailersResponseValidationError) Key 

func (e TrailersResponseValidationError) Key() bool

Key function returns key value.

func (TrailersResponseValidationError) Reason 

func (e TrailersResponseValidationError) Reason() string

Reason function returns reason value.

type UnimplementedExternalProcessorServer 

type UnimplementedExternalProcessorServer struct {
}

UnimplementedExternalProcessorServer can be embedded to have forward compatible implementations.

func (*UnimplementedExternalProcessorServer) Process 

func (*UnimplementedExternalProcessorServer) Process(ExternalProcessor_ProcessServer) error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.