Documentation ¶
Index ¶
- Variables
- type Config
- func (*Config) Descriptor() ([]byte, []int)deprecated
- func (x *Config) GetLibraryId() string
- func (x *Config) GetLibraryPath() string
- func (x *Config) GetMergePolicy() Config_MergePolicy
- func (x *Config) GetPluginConfig() *any1.Any
- func (x *Config) GetPluginName() string
- func (*Config) ProtoMessage()
- func (x *Config) ProtoReflect() protoreflect.Message
- func (x *Config) Reset()
- func (x *Config) String() string
- func (m *Config) Validate() error
- func (m *Config) ValidateAll() error
- type ConfigMultiError
- type ConfigValidationError
- type Config_MergePolicy
- func (Config_MergePolicy) Descriptor() protoreflect.EnumDescriptor
- func (x Config_MergePolicy) Enum() *Config_MergePolicy
- func (Config_MergePolicy) EnumDescriptor() ([]byte, []int)deprecated
- func (x Config_MergePolicy) Number() protoreflect.EnumNumber
- func (x Config_MergePolicy) String() string
- func (Config_MergePolicy) Type() protoreflect.EnumType
- type ConfigsPerRoute
- func (*ConfigsPerRoute) Descriptor() ([]byte, []int)deprecated
- func (x *ConfigsPerRoute) GetPluginsConfig() map[string]*RouterPlugin
- func (*ConfigsPerRoute) ProtoMessage()
- func (x *ConfigsPerRoute) ProtoReflect() protoreflect.Message
- func (x *ConfigsPerRoute) Reset()
- func (x *ConfigsPerRoute) String() string
- func (m *ConfigsPerRoute) Validate() error
- func (m *ConfigsPerRoute) ValidateAll() error
- type ConfigsPerRouteMultiError
- type ConfigsPerRouteValidationError
- func (e ConfigsPerRouteValidationError) Cause() error
- func (e ConfigsPerRouteValidationError) Error() string
- func (e ConfigsPerRouteValidationError) ErrorName() string
- func (e ConfigsPerRouteValidationError) Field() string
- func (e ConfigsPerRouteValidationError) Key() bool
- func (e ConfigsPerRouteValidationError) Reason() string
- type RouterPlugin
- func (*RouterPlugin) Descriptor() ([]byte, []int)deprecated
- func (x *RouterPlugin) GetConfig() *any1.Any
- func (x *RouterPlugin) GetDisabled() bool
- func (m *RouterPlugin) GetOverride() isRouterPlugin_Override
- func (*RouterPlugin) ProtoMessage()
- func (x *RouterPlugin) ProtoReflect() protoreflect.Message
- func (x *RouterPlugin) Reset()
- func (x *RouterPlugin) String() string
- func (m *RouterPlugin) Validate() error
- func (m *RouterPlugin) ValidateAll() error
- type RouterPluginMultiError
- type RouterPluginValidationError
- func (e RouterPluginValidationError) Cause() error
- func (e RouterPluginValidationError) Error() string
- func (e RouterPluginValidationError) ErrorName() string
- func (e RouterPluginValidationError) Field() string
- func (e RouterPluginValidationError) Key() bool
- func (e RouterPluginValidationError) Reason() string
- type RouterPlugin_Config
- type RouterPlugin_Disabled
Constants ¶
This section is empty.
Variables ¶
var ( Config_MergePolicy_name = map[int32]string{ 0: "MERGE_VIRTUALHOST_ROUTER_FILTER", 1: "MERGE_VIRTUALHOST_ROUTER", 3: "OVERRIDE", } Config_MergePolicy_value = map[string]int32{ "MERGE_VIRTUALHOST_ROUTER_FILTER": 0, "MERGE_VIRTUALHOST_ROUTER": 1, "OVERRIDE": 3, } )
Enum value maps for Config_MergePolicy.
var File_contrib_envoy_extensions_filters_http_golang_v3alpha_golang_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Config ¶
type Config struct { // Globally unique ID for a dynamic library file. LibraryId string `protobuf:"bytes,1,opt,name=library_id,json=libraryId,proto3" json:"library_id,omitempty"` // Path to a dynamic library implementing the // :repo:`StreamFilter API <contrib/golang/common/go/api.StreamFilter>` // interface. // [#comment:TODO(wangfakang): Support for downloading libraries from remote repositories.] LibraryPath string `protobuf:"bytes,2,opt,name=library_path,json=libraryPath,proto3" json:"library_path,omitempty"` // Globally unique name of the Go plugin. // // This name **must** be consistent with the name registered in “http::RegisterHttpFilterConfigFactory“, // and can be used to associate :ref:`route and virtualHost plugin configuration // <envoy_v3_api_field_extensions.filters.http.golang.v3alpha.ConfigsPerRoute.plugins_config>`. // PluginName string `protobuf:"bytes,3,opt,name=plugin_name,json=pluginName,proto3" json:"plugin_name,omitempty"` // Configuration for the Go plugin. // // .. note:: // This configuration is only parsed in the go plugin, and is therefore not validated // by Envoy. // // See the :repo:`StreamFilter API <contrib/golang/common/go/api/filter.go>` // for more information about how the plugin's configuration data can be accessed. // PluginConfig *any1.Any `protobuf:"bytes,4,opt,name=plugin_config,json=pluginConfig,proto3" json:"plugin_config,omitempty"` // Merge policy for plugin configuration. // // The Go plugin configuration supports three dimensions: // // * Virtual host’s :ref:`typed_per_filter_config <envoy_v3_api_field_config.route.v3.VirtualHost.typed_per_filter_config>` // * Route’s :ref:`typed_per_filter_config <envoy_v3_api_field_config.route.v3.Route.typed_per_filter_config>` // * The filter's :ref:`plugin_config <envoy_v3_api_field_extensions.filters.http.golang.v3alpha.Config.plugin_config>` // // [#not-implemented-hide:] MergePolicy Config_MergePolicy `` /* 164-byte string literal not displayed */ // contains filtered or unexported fields }
[#next-free-field: 6]
func (*Config) Descriptor
deprecated
func (*Config) GetLibraryId ¶
func (*Config) GetLibraryPath ¶
func (*Config) GetMergePolicy ¶
func (x *Config) GetMergePolicy() Config_MergePolicy
func (*Config) GetPluginConfig ¶
func (*Config) GetPluginName ¶
func (*Config) ProtoMessage ¶
func (*Config) ProtoMessage()
func (*Config) ProtoReflect ¶
func (x *Config) ProtoReflect() protoreflect.Message
func (*Config) Validate ¶
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 ¶
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 ¶
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 ¶
func (m ConfigMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (ConfigMultiError) Error ¶
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 ¶
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_MergePolicy ¶
type Config_MergePolicy int32
The meanings are as follows:
:“MERGE_VIRTUALHOST_ROUTER_FILTER“: Pass all configuration into Go plugin. :“MERGE_VIRTUALHOST_ROUTER“: Pass merged Virtual host and Router configuration into Go plugin. :“OVERRIDE“: Pass merged Virtual host, Router, and plugin configuration into Go plugin.
[#not-implemented-hide:]
const ( Config_MERGE_VIRTUALHOST_ROUTER_FILTER Config_MergePolicy = 0 Config_MERGE_VIRTUALHOST_ROUTER Config_MergePolicy = 1 Config_OVERRIDE Config_MergePolicy = 3 )
func (Config_MergePolicy) Descriptor ¶
func (Config_MergePolicy) Descriptor() protoreflect.EnumDescriptor
func (Config_MergePolicy) Enum ¶
func (x Config_MergePolicy) Enum() *Config_MergePolicy
func (Config_MergePolicy) EnumDescriptor
deprecated
func (Config_MergePolicy) EnumDescriptor() ([]byte, []int)
Deprecated: Use Config_MergePolicy.Descriptor instead.
func (Config_MergePolicy) Number ¶
func (x Config_MergePolicy) Number() protoreflect.EnumNumber
func (Config_MergePolicy) String ¶
func (x Config_MergePolicy) String() string
func (Config_MergePolicy) Type ¶
func (Config_MergePolicy) Type() protoreflect.EnumType
type ConfigsPerRoute ¶
type ConfigsPerRoute struct { // Configuration of the Go plugin at the per-router or per-virtualhost level, // keyed on the :ref:`plugin_name <envoy_v3_api_field_extensions.filters.http.golang.v3alpha.Config.plugin_name>` // of the Go plugin. // PluginsConfig map[string]*RouterPlugin `` /* 188-byte string literal not displayed */ // contains filtered or unexported fields }
func (*ConfigsPerRoute) Descriptor
deprecated
func (*ConfigsPerRoute) Descriptor() ([]byte, []int)
Deprecated: Use ConfigsPerRoute.ProtoReflect.Descriptor instead.
func (*ConfigsPerRoute) GetPluginsConfig ¶
func (x *ConfigsPerRoute) GetPluginsConfig() map[string]*RouterPlugin
func (*ConfigsPerRoute) ProtoMessage ¶
func (*ConfigsPerRoute) ProtoMessage()
func (*ConfigsPerRoute) ProtoReflect ¶
func (x *ConfigsPerRoute) ProtoReflect() protoreflect.Message
func (*ConfigsPerRoute) Reset ¶
func (x *ConfigsPerRoute) Reset()
func (*ConfigsPerRoute) String ¶
func (x *ConfigsPerRoute) String() string
func (*ConfigsPerRoute) Validate ¶
func (m *ConfigsPerRoute) Validate() error
Validate checks the field values on ConfigsPerRoute 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 (*ConfigsPerRoute) ValidateAll ¶
func (m *ConfigsPerRoute) ValidateAll() error
ValidateAll checks the field values on ConfigsPerRoute 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 ConfigsPerRouteMultiError, or nil if none found.
type ConfigsPerRouteMultiError ¶
type ConfigsPerRouteMultiError []error
ConfigsPerRouteMultiError is an error wrapping multiple validation errors returned by ConfigsPerRoute.ValidateAll() if the designated constraints aren't met.
func (ConfigsPerRouteMultiError) AllErrors ¶
func (m ConfigsPerRouteMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (ConfigsPerRouteMultiError) Error ¶
func (m ConfigsPerRouteMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type ConfigsPerRouteValidationError ¶
type ConfigsPerRouteValidationError struct {
// contains filtered or unexported fields
}
ConfigsPerRouteValidationError is the validation error returned by ConfigsPerRoute.Validate if the designated constraints aren't met.
func (ConfigsPerRouteValidationError) Cause ¶
func (e ConfigsPerRouteValidationError) Cause() error
Cause function returns cause value.
func (ConfigsPerRouteValidationError) Error ¶
func (e ConfigsPerRouteValidationError) Error() string
Error satisfies the builtin error interface
func (ConfigsPerRouteValidationError) ErrorName ¶
func (e ConfigsPerRouteValidationError) ErrorName() string
ErrorName returns error name.
func (ConfigsPerRouteValidationError) Field ¶
func (e ConfigsPerRouteValidationError) Field() string
Field function returns field value.
func (ConfigsPerRouteValidationError) Key ¶
func (e ConfigsPerRouteValidationError) Key() bool
Key function returns key value.
func (ConfigsPerRouteValidationError) Reason ¶
func (e ConfigsPerRouteValidationError) Reason() string
Reason function returns reason value.
type RouterPlugin ¶
type RouterPlugin struct { // Types that are assignable to Override: // *RouterPlugin_Disabled // *RouterPlugin_Config Override isRouterPlugin_Override `protobuf_oneof:"override"` // contains filtered or unexported fields }
func (*RouterPlugin) Descriptor
deprecated
func (*RouterPlugin) Descriptor() ([]byte, []int)
Deprecated: Use RouterPlugin.ProtoReflect.Descriptor instead.
func (*RouterPlugin) GetConfig ¶
func (x *RouterPlugin) GetConfig() *any1.Any
func (*RouterPlugin) GetDisabled ¶
func (x *RouterPlugin) GetDisabled() bool
func (*RouterPlugin) GetOverride ¶
func (m *RouterPlugin) GetOverride() isRouterPlugin_Override
func (*RouterPlugin) ProtoMessage ¶
func (*RouterPlugin) ProtoMessage()
func (*RouterPlugin) ProtoReflect ¶
func (x *RouterPlugin) ProtoReflect() protoreflect.Message
func (*RouterPlugin) Reset ¶
func (x *RouterPlugin) Reset()
func (*RouterPlugin) String ¶
func (x *RouterPlugin) String() string
func (*RouterPlugin) Validate ¶
func (m *RouterPlugin) Validate() error
Validate checks the field values on RouterPlugin 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 (*RouterPlugin) ValidateAll ¶
func (m *RouterPlugin) ValidateAll() error
ValidateAll checks the field values on RouterPlugin 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 RouterPluginMultiError, or nil if none found.
type RouterPluginMultiError ¶
type RouterPluginMultiError []error
RouterPluginMultiError is an error wrapping multiple validation errors returned by RouterPlugin.ValidateAll() if the designated constraints aren't met.
func (RouterPluginMultiError) AllErrors ¶
func (m RouterPluginMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (RouterPluginMultiError) Error ¶
func (m RouterPluginMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type RouterPluginValidationError ¶
type RouterPluginValidationError struct {
// contains filtered or unexported fields
}
RouterPluginValidationError is the validation error returned by RouterPlugin.Validate if the designated constraints aren't met.
func (RouterPluginValidationError) Cause ¶
func (e RouterPluginValidationError) Cause() error
Cause function returns cause value.
func (RouterPluginValidationError) Error ¶
func (e RouterPluginValidationError) Error() string
Error satisfies the builtin error interface
func (RouterPluginValidationError) ErrorName ¶
func (e RouterPluginValidationError) ErrorName() string
ErrorName returns error name.
func (RouterPluginValidationError) Field ¶
func (e RouterPluginValidationError) Field() string
Field function returns field value.
func (RouterPluginValidationError) Key ¶
func (e RouterPluginValidationError) Key() bool
Key function returns key value.
func (RouterPluginValidationError) Reason ¶
func (e RouterPluginValidationError) Reason() string
Reason function returns reason value.
type RouterPlugin_Config ¶
type RouterPlugin_Disabled ¶
type RouterPlugin_Disabled struct { // [#not-implemented-hide:] // Disable the filter for this particular vhost or route. // If disabled is specified in multiple per-filter-configs, the most specific one will be used. Disabled bool `protobuf:"varint,1,opt,name=disabled,proto3,oneof"` }