header_to_metadatav2

package
v1.33.0-20240426201503... Latest Latest
Warning

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

Go to latest
Published: unknown License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	Config_ValueType_name = map[int32]string{
		0: "STRING",
		1: "NUMBER",
		2: "PROTOBUF_VALUE",
	}
	Config_ValueType_value = map[string]int32{
		"STRING":         0,
		"NUMBER":         1,
		"PROTOBUF_VALUE": 2,
	}
)

Enum value maps for Config_ValueType.

View Source
var (
	Config_ValueEncode_name = map[int32]string{
		0: "NONE",
		1: "BASE64",
	}
	Config_ValueEncode_value = map[string]int32{
		"NONE":   0,
		"BASE64": 1,
	}
)

Enum value maps for Config_ValueEncode.

View Source
var File_envoy_config_filter_http_header_to_metadata_v2_header_to_metadata_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type Config

type Config struct {

	// The list of rules to apply to requests.
	RequestRules []*Config_Rule `protobuf:"bytes,1,rep,name=request_rules,json=requestRules,proto3" json:"request_rules,omitempty"`
	// The list of rules to apply to responses.
	ResponseRules []*Config_Rule `protobuf:"bytes,2,rep,name=response_rules,json=responseRules,proto3" json:"response_rules,omitempty"`
	// contains filtered or unexported fields
}

func (*Config) Descriptor deprecated

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

Deprecated: Use Config.ProtoReflect.Descriptor instead.

func (*Config) GetRequestRules

func (x *Config) GetRequestRules() []*Config_Rule

func (*Config) GetResponseRules

func (x *Config) GetResponseRules() []*Config_Rule

func (*Config) ProtoMessage

func (*Config) ProtoMessage()

func (*Config) ProtoReflect

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

func (*Config) Reset

func (x *Config) Reset()

func (*Config) String

func (x *Config) String() string

type Config_KeyValuePair

type Config_KeyValuePair struct {

	// The namespace — if this is empty, the filter's namespace will be used.
	MetadataNamespace string `protobuf:"bytes,1,opt,name=metadata_namespace,json=metadataNamespace,proto3" json:"metadata_namespace,omitempty"`
	// The key to use within the namespace.
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// The value to pair with the given key.
	//
	// When used for a `on_header_present` case, if value is non-empty it'll be used
	// instead of the header value. If both are empty, no metadata is added.
	//
	// When used for a `on_header_missing` case, a non-empty value must be provided
	// otherwise no metadata is added.
	Value string `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// The value's type — defaults to string.
	Type Config_ValueType `` /* 131-byte string literal not displayed */
	// How is the value encoded, default is NONE (not encoded).
	// The value will be decoded accordingly before storing to metadata.
	Encode Config_ValueEncode `` /* 137-byte string literal not displayed */
	// contains filtered or unexported fields
}

[#next-free-field: 6]

func (*Config_KeyValuePair) Descriptor deprecated

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

Deprecated: Use Config_KeyValuePair.ProtoReflect.Descriptor instead.

func (*Config_KeyValuePair) GetEncode

func (x *Config_KeyValuePair) GetEncode() Config_ValueEncode

func (*Config_KeyValuePair) GetKey

func (x *Config_KeyValuePair) GetKey() string

func (*Config_KeyValuePair) GetMetadataNamespace

func (x *Config_KeyValuePair) GetMetadataNamespace() string

func (*Config_KeyValuePair) GetType

func (*Config_KeyValuePair) GetValue

func (x *Config_KeyValuePair) GetValue() string

func (*Config_KeyValuePair) ProtoMessage

func (*Config_KeyValuePair) ProtoMessage()

func (*Config_KeyValuePair) ProtoReflect

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

func (*Config_KeyValuePair) Reset

func (x *Config_KeyValuePair) Reset()

func (*Config_KeyValuePair) String

func (x *Config_KeyValuePair) String() string

type Config_Rule

type Config_Rule struct {

	// The header that triggers this rule — required.
	Header string `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
	// If the header is present, apply this metadata KeyValuePair.
	//
	// If the value in the KeyValuePair is non-empty, it'll be used instead
	// of the header value.
	OnHeaderPresent *Config_KeyValuePair `protobuf:"bytes,2,opt,name=on_header_present,json=onHeaderPresent,proto3" json:"on_header_present,omitempty"`
	// If the header is not present, apply this metadata KeyValuePair.
	//
	// The value in the KeyValuePair must be set, since it'll be used in lieu
	// of the missing header value.
	OnHeaderMissing *Config_KeyValuePair `protobuf:"bytes,3,opt,name=on_header_missing,json=onHeaderMissing,proto3" json:"on_header_missing,omitempty"`
	// Whether or not to remove the header after a rule is applied.
	//
	// This prevents headers from leaking.
	Remove bool `protobuf:"varint,4,opt,name=remove,proto3" json:"remove,omitempty"`
	// contains filtered or unexported fields
}

A Rule defines what metadata to apply when a header is present or missing.

func (*Config_Rule) Descriptor deprecated

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

Deprecated: Use Config_Rule.ProtoReflect.Descriptor instead.

func (*Config_Rule) GetHeader

func (x *Config_Rule) GetHeader() string

func (*Config_Rule) GetOnHeaderMissing

func (x *Config_Rule) GetOnHeaderMissing() *Config_KeyValuePair

func (*Config_Rule) GetOnHeaderPresent

func (x *Config_Rule) GetOnHeaderPresent() *Config_KeyValuePair

func (*Config_Rule) GetRemove

func (x *Config_Rule) GetRemove() bool

func (*Config_Rule) ProtoMessage

func (*Config_Rule) ProtoMessage()

func (*Config_Rule) ProtoReflect

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

func (*Config_Rule) Reset

func (x *Config_Rule) Reset()

func (*Config_Rule) String

func (x *Config_Rule) String() string

type Config_ValueEncode

type Config_ValueEncode int32

ValueEncode defines the encoding algorithm.

const (
	// The value is not encoded.
	Config_NONE Config_ValueEncode = 0
	// The value is encoded in `Base64 <https://tools.ietf.org/html/rfc4648#section-4>`_.
	// Note: this is mostly used for STRING and PROTOBUF_VALUE to escape the
	// non-ASCII characters in the header.
	Config_BASE64 Config_ValueEncode = 1
)

func (Config_ValueEncode) Descriptor

func (Config_ValueEncode) Enum

func (Config_ValueEncode) EnumDescriptor deprecated

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

Deprecated: Use Config_ValueEncode.Descriptor instead.

func (Config_ValueEncode) Number

func (Config_ValueEncode) String

func (x Config_ValueEncode) String() string

func (Config_ValueEncode) Type

type Config_ValueType

type Config_ValueType int32
const (
	Config_STRING Config_ValueType = 0
	Config_NUMBER Config_ValueType = 1
	// The value is a serialized `protobuf.Value
	// <https://github.com/protocolbuffers/protobuf/blob/master/src/google/protobuf/struct.proto#L62>`_.
	Config_PROTOBUF_VALUE Config_ValueType = 2
)

func (Config_ValueType) Descriptor

func (Config_ValueType) Enum

func (Config_ValueType) EnumDescriptor deprecated

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

Deprecated: Use Config_ValueType.Descriptor instead.

func (Config_ValueType) Number

func (Config_ValueType) String

func (x Config_ValueType) String() string

func (Config_ValueType) Type

Jump to

Keyboard shortcuts

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