Documentation ¶
Index ¶
- Variables
- type Composite
- type CompositeMultiError
- type CompositeValidationError
- type DynamicConfig
- func (*DynamicConfig) Descriptor() ([]byte, []int)deprecated
- func (x *DynamicConfig) GetConfigDiscovery() *v3.ExtensionConfigSource
- func (x *DynamicConfig) GetName() string
- func (*DynamicConfig) ProtoMessage()
- func (x *DynamicConfig) ProtoReflect() protoreflect.Message
- func (x *DynamicConfig) Reset()
- func (x *DynamicConfig) String() string
- func (m *DynamicConfig) Validate() error
- func (m *DynamicConfig) ValidateAll() error
- type DynamicConfigMultiError
- type DynamicConfigValidationError
- func (e DynamicConfigValidationError) Cause() error
- func (e DynamicConfigValidationError) Error() string
- func (e DynamicConfigValidationError) ErrorName() string
- func (e DynamicConfigValidationError) Field() string
- func (e DynamicConfigValidationError) Key() bool
- func (e DynamicConfigValidationError) Reason() string
- type ExecuteFilterAction
- func (*ExecuteFilterAction) Descriptor() ([]byte, []int)deprecated
- func (x *ExecuteFilterAction) GetDynamicConfig() *DynamicConfig
- func (x *ExecuteFilterAction) GetTypedConfig() *v3.TypedExtensionConfig
- func (*ExecuteFilterAction) ProtoMessage()
- func (x *ExecuteFilterAction) ProtoReflect() protoreflect.Message
- func (x *ExecuteFilterAction) Reset()
- func (x *ExecuteFilterAction) String() string
- func (m *ExecuteFilterAction) Validate() error
- func (m *ExecuteFilterAction) ValidateAll() error
- type ExecuteFilterActionMultiError
- type ExecuteFilterActionValidationError
- func (e ExecuteFilterActionValidationError) Cause() error
- func (e ExecuteFilterActionValidationError) Error() string
- func (e ExecuteFilterActionValidationError) ErrorName() string
- func (e ExecuteFilterActionValidationError) Field() string
- func (e ExecuteFilterActionValidationError) Key() bool
- func (e ExecuteFilterActionValidationError) Reason() string
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_filters_http_composite_v3_composite_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Composite ¶
type Composite struct {
// contains filtered or unexported fields
}
:ref:`Composite filter <config_http_filters_composite>` config. The composite filter config allows delegating filter handling to another filter as determined by matching on the request headers. This makes it possible to use different filters or filter configurations based on the incoming request.
This is intended to be used with :ref:`ExtensionWithMatcher <envoy_v3_api_msg_extensions.common.matching.v3.ExtensionWithMatcher>` where a match tree is specified that indicates (via :ref:`ExecuteFilterAction <envoy_v3_api_msg_extensions.filters.http.composite.v3.ExecuteFilterAction>`) which filter configuration to create and delegate to.
func (*Composite) Descriptor
deprecated
func (*Composite) ProtoMessage ¶
func (*Composite) ProtoMessage()
func (*Composite) ProtoReflect ¶
func (x *Composite) ProtoReflect() protoreflect.Message
func (*Composite) Validate ¶
Validate checks the field values on Composite 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 (*Composite) ValidateAll ¶ added in v0.10.0
ValidateAll checks the field values on Composite 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 CompositeMultiError, or nil if none found.
type CompositeMultiError ¶ added in v0.10.0
type CompositeMultiError []error
CompositeMultiError is an error wrapping multiple validation errors returned by Composite.ValidateAll() if the designated constraints aren't met.
func (CompositeMultiError) AllErrors ¶ added in v0.10.0
func (m CompositeMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (CompositeMultiError) Error ¶ added in v0.10.0
func (m CompositeMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type CompositeValidationError ¶
type CompositeValidationError struct {
// contains filtered or unexported fields
}
CompositeValidationError is the validation error returned by Composite.Validate if the designated constraints aren't met.
func (CompositeValidationError) Cause ¶
func (e CompositeValidationError) Cause() error
Cause function returns cause value.
func (CompositeValidationError) Error ¶
func (e CompositeValidationError) Error() string
Error satisfies the builtin error interface
func (CompositeValidationError) ErrorName ¶
func (e CompositeValidationError) ErrorName() string
ErrorName returns error name.
func (CompositeValidationError) Field ¶
func (e CompositeValidationError) Field() string
Field function returns field value.
func (CompositeValidationError) Key ¶
func (e CompositeValidationError) Key() bool
Key function returns key value.
func (CompositeValidationError) Reason ¶
func (e CompositeValidationError) Reason() string
Reason function returns reason value.
type DynamicConfig ¶ added in v0.12.0
type DynamicConfig struct { // The name of the extension configuration. It also serves as a resource name in ExtensionConfigDS. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Configuration source specifier for an extension configuration discovery // service. In case of a failure and without the default configuration, // 500(Internal Server Error) will be returned. ConfigDiscovery *v3.ExtensionConfigSource `protobuf:"bytes,2,opt,name=config_discovery,json=configDiscovery,proto3" json:"config_discovery,omitempty"` // contains filtered or unexported fields }
Configuration for an extension configuration discovery service with name.
func (*DynamicConfig) Descriptor
deprecated
added in
v0.12.0
func (*DynamicConfig) Descriptor() ([]byte, []int)
Deprecated: Use DynamicConfig.ProtoReflect.Descriptor instead.
func (*DynamicConfig) GetConfigDiscovery ¶ added in v0.12.0
func (x *DynamicConfig) GetConfigDiscovery() *v3.ExtensionConfigSource
func (*DynamicConfig) GetName ¶ added in v0.12.0
func (x *DynamicConfig) GetName() string
func (*DynamicConfig) ProtoMessage ¶ added in v0.12.0
func (*DynamicConfig) ProtoMessage()
func (*DynamicConfig) ProtoReflect ¶ added in v0.12.0
func (x *DynamicConfig) ProtoReflect() protoreflect.Message
func (*DynamicConfig) Reset ¶ added in v0.12.0
func (x *DynamicConfig) Reset()
func (*DynamicConfig) String ¶ added in v0.12.0
func (x *DynamicConfig) String() string
func (*DynamicConfig) Validate ¶ added in v0.12.0
func (m *DynamicConfig) Validate() error
Validate checks the field values on DynamicConfig 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 (*DynamicConfig) ValidateAll ¶ added in v0.12.0
func (m *DynamicConfig) ValidateAll() error
ValidateAll checks the field values on DynamicConfig 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 DynamicConfigMultiError, or nil if none found.
type DynamicConfigMultiError ¶ added in v0.12.0
type DynamicConfigMultiError []error
DynamicConfigMultiError is an error wrapping multiple validation errors returned by DynamicConfig.ValidateAll() if the designated constraints aren't met.
func (DynamicConfigMultiError) AllErrors ¶ added in v0.12.0
func (m DynamicConfigMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (DynamicConfigMultiError) Error ¶ added in v0.12.0
func (m DynamicConfigMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type DynamicConfigValidationError ¶ added in v0.12.0
type DynamicConfigValidationError struct {
// contains filtered or unexported fields
}
DynamicConfigValidationError is the validation error returned by DynamicConfig.Validate if the designated constraints aren't met.
func (DynamicConfigValidationError) Cause ¶ added in v0.12.0
func (e DynamicConfigValidationError) Cause() error
Cause function returns cause value.
func (DynamicConfigValidationError) Error ¶ added in v0.12.0
func (e DynamicConfigValidationError) Error() string
Error satisfies the builtin error interface
func (DynamicConfigValidationError) ErrorName ¶ added in v0.12.0
func (e DynamicConfigValidationError) ErrorName() string
ErrorName returns error name.
func (DynamicConfigValidationError) Field ¶ added in v0.12.0
func (e DynamicConfigValidationError) Field() string
Field function returns field value.
func (DynamicConfigValidationError) Key ¶ added in v0.12.0
func (e DynamicConfigValidationError) Key() bool
Key function returns key value.
func (DynamicConfigValidationError) Reason ¶ added in v0.12.0
func (e DynamicConfigValidationError) Reason() string
Reason function returns reason value.
type ExecuteFilterAction ¶
type ExecuteFilterAction struct { // Filter specific configuration which depends on the filter being // instantiated. See the supported filters for further documentation. // Only one of “typed_config“ or “dynamic_config“ can be set. // [#extension-category: envoy.filters.http] TypedConfig *v3.TypedExtensionConfig `protobuf:"bytes,1,opt,name=typed_config,json=typedConfig,proto3" json:"typed_config,omitempty"` // Dynamic configuration of filter obtained via extension configuration discovery // service. // Only one of “typed_config“ or “dynamic_config“ can be set. DynamicConfig *DynamicConfig `protobuf:"bytes,2,opt,name=dynamic_config,json=dynamicConfig,proto3" json:"dynamic_config,omitempty"` // contains filtered or unexported fields }
Composite match action (see :ref:`matching docs <arch_overview_matching_api>` for more info on match actions). This specifies the filter configuration of the filter that the composite filter should delegate filter interactions to.
func (*ExecuteFilterAction) Descriptor
deprecated
func (*ExecuteFilterAction) Descriptor() ([]byte, []int)
Deprecated: Use ExecuteFilterAction.ProtoReflect.Descriptor instead.
func (*ExecuteFilterAction) GetDynamicConfig ¶ added in v0.12.0
func (x *ExecuteFilterAction) GetDynamicConfig() *DynamicConfig
func (*ExecuteFilterAction) GetTypedConfig ¶
func (x *ExecuteFilterAction) GetTypedConfig() *v3.TypedExtensionConfig
func (*ExecuteFilterAction) ProtoMessage ¶
func (*ExecuteFilterAction) ProtoMessage()
func (*ExecuteFilterAction) ProtoReflect ¶
func (x *ExecuteFilterAction) ProtoReflect() protoreflect.Message
func (*ExecuteFilterAction) Reset ¶
func (x *ExecuteFilterAction) Reset()
func (*ExecuteFilterAction) String ¶
func (x *ExecuteFilterAction) String() string
func (*ExecuteFilterAction) Validate ¶
func (m *ExecuteFilterAction) Validate() error
Validate checks the field values on ExecuteFilterAction 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 (*ExecuteFilterAction) ValidateAll ¶ added in v0.10.0
func (m *ExecuteFilterAction) ValidateAll() error
ValidateAll checks the field values on ExecuteFilterAction 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 ExecuteFilterActionMultiError, or nil if none found.
type ExecuteFilterActionMultiError ¶ added in v0.10.0
type ExecuteFilterActionMultiError []error
ExecuteFilterActionMultiError is an error wrapping multiple validation errors returned by ExecuteFilterAction.ValidateAll() if the designated constraints aren't met.
func (ExecuteFilterActionMultiError) AllErrors ¶ added in v0.10.0
func (m ExecuteFilterActionMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (ExecuteFilterActionMultiError) Error ¶ added in v0.10.0
func (m ExecuteFilterActionMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type ExecuteFilterActionValidationError ¶
type ExecuteFilterActionValidationError struct {
// contains filtered or unexported fields
}
ExecuteFilterActionValidationError is the validation error returned by ExecuteFilterAction.Validate if the designated constraints aren't met.
func (ExecuteFilterActionValidationError) Cause ¶
func (e ExecuteFilterActionValidationError) Cause() error
Cause function returns cause value.
func (ExecuteFilterActionValidationError) Error ¶
func (e ExecuteFilterActionValidationError) Error() string
Error satisfies the builtin error interface
func (ExecuteFilterActionValidationError) ErrorName ¶
func (e ExecuteFilterActionValidationError) ErrorName() string
ErrorName returns error name.
func (ExecuteFilterActionValidationError) Field ¶
func (e ExecuteFilterActionValidationError) Field() string
Field function returns field value.
func (ExecuteFilterActionValidationError) Key ¶
func (e ExecuteFilterActionValidationError) Key() bool
Key function returns key value.
func (ExecuteFilterActionValidationError) Reason ¶
func (e ExecuteFilterActionValidationError) Reason() string
Reason function returns reason value.