envoy_config_filter_http_header_to_metadata_v2

package
Version: 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: 19 Imported by: 4

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 added in v0.9.6

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

func (*Config) Reset

func (x *Config) Reset()

func (*Config) String

func (x *Config) String() string

func (*Config) Validate

func (m *Config) Validate() error

Validate checks the field values on Config 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 (*Config) ValidateAll added in v0.10.0

func (m *Config) ValidateAll() error

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

type ConfigMultiError added in v0.10.0

type ConfigMultiError []error

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

func (ConfigMultiError) AllErrors added in v0.10.0

func (m ConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ConfigMultiError) Error added in v0.10.0

func (m ConfigMultiError) Error() string

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

type ConfigValidationError

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

ConfigValidationError is the validation error returned by Config.Validate if the designated constraints aren't met.

func (ConfigValidationError) Cause

func (e ConfigValidationError) Cause() error

Cause function returns cause value.

func (ConfigValidationError) Error

func (e ConfigValidationError) Error() string

Error satisfies the builtin error interface

func (ConfigValidationError) ErrorName added in v0.7.0

func (e ConfigValidationError) ErrorName() string

ErrorName returns error name.

func (ConfigValidationError) Field

func (e ConfigValidationError) Field() string

Field function returns field value.

func (ConfigValidationError) Key

func (e ConfigValidationError) Key() bool

Key function returns key value.

func (ConfigValidationError) Reason

func (e ConfigValidationError) Reason() string

Reason function returns reason value.

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 added in v0.8.6

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 added in v0.9.6

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

func (*Config_KeyValuePair) Validate

func (m *Config_KeyValuePair) Validate() error

Validate checks the field values on Config_KeyValuePair 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 (*Config_KeyValuePair) ValidateAll added in v0.10.0

func (m *Config_KeyValuePair) ValidateAll() error

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

type Config_KeyValuePairMultiError added in v0.10.0

type Config_KeyValuePairMultiError []error

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

func (Config_KeyValuePairMultiError) AllErrors added in v0.10.0

func (m Config_KeyValuePairMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (Config_KeyValuePairMultiError) Error added in v0.10.0

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

type Config_KeyValuePairValidationError

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

Config_KeyValuePairValidationError is the validation error returned by Config_KeyValuePair.Validate if the designated constraints aren't met.

func (Config_KeyValuePairValidationError) Cause

Cause function returns cause value.

func (Config_KeyValuePairValidationError) Error

Error satisfies the builtin error interface

func (Config_KeyValuePairValidationError) ErrorName added in v0.7.0

ErrorName returns error name.

func (Config_KeyValuePairValidationError) Field

Field function returns field value.

func (Config_KeyValuePairValidationError) Key

Key function returns key value.

func (Config_KeyValuePairValidationError) Reason

Reason function returns reason value.

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 added in v0.9.6

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

func (*Config_Rule) Validate

func (m *Config_Rule) Validate() error

Validate checks the field values on Config_Rule 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 (*Config_Rule) ValidateAll added in v0.10.0

func (m *Config_Rule) ValidateAll() error

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

type Config_RuleMultiError added in v0.10.0

type Config_RuleMultiError []error

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

func (Config_RuleMultiError) AllErrors added in v0.10.0

func (m Config_RuleMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (Config_RuleMultiError) Error added in v0.10.0

func (m Config_RuleMultiError) Error() string

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

type Config_RuleValidationError

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

Config_RuleValidationError is the validation error returned by Config_Rule.Validate if the designated constraints aren't met.

func (Config_RuleValidationError) Cause

Cause function returns cause value.

func (Config_RuleValidationError) Error

Error satisfies the builtin error interface

func (Config_RuleValidationError) ErrorName added in v0.7.0

func (e Config_RuleValidationError) ErrorName() string

ErrorName returns error name.

func (Config_RuleValidationError) Field

Field function returns field value.

func (Config_RuleValidationError) Key

Key function returns key value.

func (Config_RuleValidationError) Reason

Reason function returns reason value.

type Config_ValueEncode added in v0.8.6

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 added in v0.9.6

func (Config_ValueEncode) Enum added in v0.9.6

func (Config_ValueEncode) EnumDescriptor deprecated added in v0.8.6

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

Deprecated: Use Config_ValueEncode.Descriptor instead.

func (Config_ValueEncode) Number added in v0.9.6

func (Config_ValueEncode) String added in v0.8.6

func (x Config_ValueEncode) String() string

func (Config_ValueEncode) Type added in v0.9.6

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 added in v0.9.6

func (Config_ValueType) Enum added in v0.9.6

func (Config_ValueType) EnumDescriptor deprecated

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

Deprecated: Use Config_ValueType.Descriptor instead.

func (Config_ValueType) Number added in v0.9.6

func (Config_ValueType) String

func (x Config_ValueType) String() string

func (Config_ValueType) Type added in v0.9.6

Jump to

Keyboard shortcuts

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