golangv3alpha

package

v1.33.0-20240418202234... Latest Latest Go to latest Published: unknown License: Apache-2.0 Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

Repository URL not available.

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

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.

View Source

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 *anypb.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) Descriptor() ([]byte, []int)

Deprecated: Use Config.ProtoReflect.Descriptor instead.

func (*Config) GetLibraryId ¶

func (x *Config) GetLibraryId() string

func (*Config) GetLibraryPath ¶

func (x *Config) GetLibraryPath() string

func (*Config) GetMergePolicy ¶

func (x *Config) GetMergePolicy() Config_MergePolicy

func (*Config) GetPluginConfig ¶

func (x *Config) GetPluginConfig() *anypb.Any

func (*Config) GetPluginName ¶

func (x *Config) GetPluginName() string

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_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

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() *anypb.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

type RouterPlugin_Config ¶

type RouterPlugin_Config struct {
	// The config field is used for setting per-route and per-virtualhost plugin config.
	Config *anypb.Any `protobuf:"bytes,2,opt,name=config,proto3,oneof"`
}

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"`
}

Source Files ¶

View all Source files

golang.pb.go

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