package internal_upstreamv3

import "github.com/envoyproxy/go-control-plane/envoy/extensions/transport_sockets/internal_upstream/v3"

Index

Variables

var File_envoy_extensions_transport_sockets_internal_upstream_v3_internal_upstream_proto protoreflect.FileDescriptor

Types

type InternalUpstreamTransport

type InternalUpstreamTransport struct {

	// Specifies the metadata namespaces and values to insert into the downstream
	// internal connection dynamic metadata when an internal address is used as a
	// host. If the destination name is repeated across two metadata source
	// locations, and both locations contain the metadata with the given name,
	// then the latter in the list overrides the former.
	PassthroughMetadata []*InternalUpstreamTransport_MetadataValueSource `protobuf:"bytes,1,rep,name=passthrough_metadata,json=passthroughMetadata,proto3" json:"passthrough_metadata,omitempty"`
	// Specifies the list of the filter state object names to insert into the
	// server internal connection from the downstream connection when an internal
	// address is used as a host. The filter state objects must be mutable. These
	// objects participate in the connection hashing decisions if they implement a
	// hashing function.
	PassthroughFilterStateObjects []*InternalUpstreamTransport_FilterStateSource `protobuf:"bytes,2,rep,name=passthrough_filter_state_objects,json=passthroughFilterStateObjects,proto3" json:"passthrough_filter_state_objects,omitempty"`
	// The underlying transport socket being wrapped.
	TransportSocket *v3.TransportSocket `protobuf:"bytes,3,opt,name=transport_socket,json=transportSocket,proto3" json:"transport_socket,omitempty"`
	// contains filtered or unexported fields
}

Configuration for the internal upstream address. An internal address defines a loopback user space socket residing in the same proxy instance. This extension allows passing additional structured state across the user space socket in addition to the regular byte stream. The purpose is to facilitate communication between filters on the downstream and the upstream internal connections.

Because the passthrough state is transferred once per the upstream connection before the bytes payload, every passthrough filter state object is included in the hash key used to select an upstream connection if it implements a hashing interface.

.. note::

Using internal upstream transport affects load balancing decisions if the
passthrough state is derived from the downstream connection attributes. As
an example, using the downstream source IP in the passthrough state will
prevent sharing of an upstream internal connection between different source
IPs.

func (*InternalUpstreamTransport) Descriptor

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

Deprecated: Use InternalUpstreamTransport.ProtoReflect.Descriptor instead.

func (*InternalUpstreamTransport) GetPassthroughFilterStateObjects

func (x *InternalUpstreamTransport) GetPassthroughFilterStateObjects() []*InternalUpstreamTransport_FilterStateSource

func (*InternalUpstreamTransport) GetPassthroughMetadata

func (*InternalUpstreamTransport) GetTransportSocket

func (x *InternalUpstreamTransport) GetTransportSocket() *v3.TransportSocket

func (*InternalUpstreamTransport) ProtoMessage

func (*InternalUpstreamTransport) ProtoMessage()

func (*InternalUpstreamTransport) ProtoReflect

func (*InternalUpstreamTransport) Reset

func (x *InternalUpstreamTransport) Reset()

func (*InternalUpstreamTransport) String

func (x *InternalUpstreamTransport) String() string

func (*InternalUpstreamTransport) Validate

func (m *InternalUpstreamTransport) Validate() error

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

func (m *InternalUpstreamTransport) ValidateAll() error

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

type InternalUpstreamTransportMultiError

type InternalUpstreamTransportMultiError []error

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

func (InternalUpstreamTransportMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (InternalUpstreamTransportMultiError) Error

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

type InternalUpstreamTransportValidationError

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

InternalUpstreamTransportValidationError is the validation error returned by InternalUpstreamTransport.Validate if the designated constraints aren't met.

func (InternalUpstreamTransportValidationError) Cause

Cause function returns cause value.

func (InternalUpstreamTransportValidationError) Error

Error satisfies the builtin error interface

func (InternalUpstreamTransportValidationError) ErrorName

ErrorName returns error name.

func (InternalUpstreamTransportValidationError) Field

Field function returns field value.

func (InternalUpstreamTransportValidationError) Key

Key function returns key value.

func (InternalUpstreamTransportValidationError) Reason

Reason function returns reason value.

type InternalUpstreamTransport_FilterStateSource

type InternalUpstreamTransport_FilterStateSource struct {

	// Name is the imported filter state object name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Describes the location of the imported filter state object from the downstream connection.

func (*InternalUpstreamTransport_FilterStateSource) Descriptor

Deprecated: Use InternalUpstreamTransport_FilterStateSource.ProtoReflect.Descriptor instead.

func (*InternalUpstreamTransport_FilterStateSource) GetName

func (*InternalUpstreamTransport_FilterStateSource) ProtoMessage

func (*InternalUpstreamTransport_FilterStateSource) ProtoReflect

func (*InternalUpstreamTransport_FilterStateSource) Reset

func (*InternalUpstreamTransport_FilterStateSource) String

func (*InternalUpstreamTransport_FilterStateSource) Validate

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

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

type InternalUpstreamTransport_FilterStateSourceMultiError

type InternalUpstreamTransport_FilterStateSourceMultiError []error

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

func (InternalUpstreamTransport_FilterStateSourceMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (InternalUpstreamTransport_FilterStateSourceMultiError) Error

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

type InternalUpstreamTransport_FilterStateSourceValidationError

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

InternalUpstreamTransport_FilterStateSourceValidationError is the validation error returned by InternalUpstreamTransport_FilterStateSource.Validate if the designated constraints aren't met.

func (InternalUpstreamTransport_FilterStateSourceValidationError) Cause

Cause function returns cause value.

func (InternalUpstreamTransport_FilterStateSourceValidationError) Error

Error satisfies the builtin error interface

func (InternalUpstreamTransport_FilterStateSourceValidationError) ErrorName

ErrorName returns error name.

func (InternalUpstreamTransport_FilterStateSourceValidationError) Field

Field function returns field value.

func (InternalUpstreamTransport_FilterStateSourceValidationError) Key

Key function returns key value.

func (InternalUpstreamTransport_FilterStateSourceValidationError) Reason

Reason function returns reason value.

type InternalUpstreamTransport_MetadataValueSource

type InternalUpstreamTransport_MetadataValueSource struct {

	// Specifies what kind of metadata.
	Kind *v31.MetadataKind `protobuf:"bytes,1,opt,name=kind,proto3" json:"kind,omitempty"`
	// Name is the filter namespace used in the dynamic metadata.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Describes the location of the imported metadata value. If the metadata with the given name is not present at the source location, then no metadata is passed through for this particular instance.

func (*InternalUpstreamTransport_MetadataValueSource) Descriptor

Deprecated: Use InternalUpstreamTransport_MetadataValueSource.ProtoReflect.Descriptor instead.

func (*InternalUpstreamTransport_MetadataValueSource) GetKind

func (*InternalUpstreamTransport_MetadataValueSource) GetName

func (*InternalUpstreamTransport_MetadataValueSource) ProtoMessage

func (*InternalUpstreamTransport_MetadataValueSource) ProtoReflect

func (*InternalUpstreamTransport_MetadataValueSource) Reset

func (*InternalUpstreamTransport_MetadataValueSource) String

func (*InternalUpstreamTransport_MetadataValueSource) Validate

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

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

type InternalUpstreamTransport_MetadataValueSourceMultiError

type InternalUpstreamTransport_MetadataValueSourceMultiError []error

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

func (InternalUpstreamTransport_MetadataValueSourceMultiError) AllErrors

AllErrors returns a list of validation violation errors.

func (InternalUpstreamTransport_MetadataValueSourceMultiError) Error

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

type InternalUpstreamTransport_MetadataValueSourceValidationError

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

InternalUpstreamTransport_MetadataValueSourceValidationError is the validation error returned by InternalUpstreamTransport_MetadataValueSource.Validate if the designated constraints aren't met.

func (InternalUpstreamTransport_MetadataValueSourceValidationError) Cause

Cause function returns cause value.

func (InternalUpstreamTransport_MetadataValueSourceValidationError) Error

Error satisfies the builtin error interface

func (InternalUpstreamTransport_MetadataValueSourceValidationError) ErrorName

ErrorName returns error name.

func (InternalUpstreamTransport_MetadataValueSourceValidationError) Field

Field function returns field value.

func (InternalUpstreamTransport_MetadataValueSourceValidationError) Key

Key function returns key value.

func (InternalUpstreamTransport_MetadataValueSourceValidationError) Reason

Reason function returns reason value.

Source Files

internal_upstream.pb.go internal_upstream.pb.validate.go

Version
v0.10.3
Published
Jun 28, 2022
Platform
linux/amd64
Imports
20 packages
Last checked
5 minutes ago

Tools for package owners.