Documentation
¶
Index ¶
- Variables
- type ClusterConfig
- func (*ClusterConfig) Descriptor() ([]byte, []int)deprecated
- func (x *ClusterConfig) GetClusterConfig() *anypb.Any
- func (x *ClusterConfig) GetClusterName() string
- func (x *ClusterConfig) GetDynamicModuleConfig() *v3.DynamicModuleConfig
- func (*ClusterConfig) ProtoMessage()
- func (x *ClusterConfig) ProtoReflect() protoreflect.Message
- func (x *ClusterConfig) Reset()
- func (x *ClusterConfig) String() string
- func (m *ClusterConfig) Validate() error
- func (m *ClusterConfig) ValidateAll() error
- type ClusterConfigMultiError
- type ClusterConfigValidationError
- func (e ClusterConfigValidationError) Cause() error
- func (e ClusterConfigValidationError) Error() string
- func (e ClusterConfigValidationError) ErrorName() string
- func (e ClusterConfigValidationError) Field() string
- func (e ClusterConfigValidationError) Key() bool
- func (e ClusterConfigValidationError) Reason() string
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_clusters_dynamic_modules_v3_cluster_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type ClusterConfig ¶
type ClusterConfig struct {
// The dynamic module configuration for the cluster.
DynamicModuleConfig *v3.DynamicModuleConfig `protobuf:"bytes,1,opt,name=dynamic_module_config,json=dynamicModuleConfig,proto3" json:"dynamic_module_config,omitempty"`
// The name to identify the cluster implementation within the module.
// This is passed to the module's “envoy_dynamic_module_on_cluster_config_new“ function.
ClusterName string `protobuf:"bytes,2,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"`
// The configuration for the module's cluster implementation.
// This is passed to the module's “envoy_dynamic_module_on_cluster_config_new“ function.
// The configuration can be any protobuf message. However, it is recommended to use
// “google.protobuf.Struct“, “google.protobuf.StringValue“, or “google.protobuf.BytesValue“.
// These types are passed directly as bytes to the module, so the module does not need to have
// knowledge of protobuf encoding. Otherwise, the serialized bytes of the type are passed.
// If not specified, an empty configuration is passed.
ClusterConfig *anypb.Any `protobuf:"bytes,3,opt,name=cluster_config,json=clusterConfig,proto3" json:"cluster_config,omitempty"`
// contains filtered or unexported fields
}
Configuration for the dynamic modules cluster.
This cluster type delegates host discovery and load balancing to a dynamic module. The module manages hosts via callbacks such as “envoy_dynamic_module_callback_cluster_add_host“ and “envoy_dynamic_module_callback_cluster_remove_host“. The cluster must use “lb_policy: CLUSTER_PROVIDED“ since the module provides its own load balancer.
[#extension: envoy.clusters.dynamic_modules]
func (*ClusterConfig) Descriptor
deprecated
func (*ClusterConfig) Descriptor() ([]byte, []int)
Deprecated: Use ClusterConfig.ProtoReflect.Descriptor instead.
func (*ClusterConfig) GetClusterConfig ¶
func (x *ClusterConfig) GetClusterConfig() *anypb.Any
func (*ClusterConfig) GetClusterName ¶
func (x *ClusterConfig) GetClusterName() string
func (*ClusterConfig) GetDynamicModuleConfig ¶
func (x *ClusterConfig) GetDynamicModuleConfig() *v3.DynamicModuleConfig
func (*ClusterConfig) ProtoMessage ¶
func (*ClusterConfig) ProtoMessage()
func (*ClusterConfig) ProtoReflect ¶
func (x *ClusterConfig) ProtoReflect() protoreflect.Message
func (*ClusterConfig) Reset ¶
func (x *ClusterConfig) Reset()
func (*ClusterConfig) String ¶
func (x *ClusterConfig) String() string
func (*ClusterConfig) Validate ¶
func (m *ClusterConfig) Validate() error
Validate checks the field values on ClusterConfig 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 (*ClusterConfig) ValidateAll ¶
func (m *ClusterConfig) ValidateAll() error
ValidateAll checks the field values on ClusterConfig 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 ClusterConfigMultiError, or nil if none found.
type ClusterConfigMultiError ¶
type ClusterConfigMultiError []error
ClusterConfigMultiError is an error wrapping multiple validation errors returned by ClusterConfig.ValidateAll() if the designated constraints aren't met.
func (ClusterConfigMultiError) AllErrors ¶
func (m ClusterConfigMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (ClusterConfigMultiError) Error ¶
func (m ClusterConfigMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type ClusterConfigValidationError ¶
type ClusterConfigValidationError struct {
// contains filtered or unexported fields
}
ClusterConfigValidationError is the validation error returned by ClusterConfig.Validate if the designated constraints aren't met.
func (ClusterConfigValidationError) Cause ¶
func (e ClusterConfigValidationError) Cause() error
Cause function returns cause value.
func (ClusterConfigValidationError) Error ¶
func (e ClusterConfigValidationError) Error() string
Error satisfies the builtin error interface
func (ClusterConfigValidationError) ErrorName ¶
func (e ClusterConfigValidationError) ErrorName() string
ErrorName returns error name.
func (ClusterConfigValidationError) Field ¶
func (e ClusterConfigValidationError) Field() string
Field function returns field value.
func (ClusterConfigValidationError) Key ¶
func (e ClusterConfigValidationError) Key() bool
Key function returns key value.
func (ClusterConfigValidationError) Reason ¶
func (e ClusterConfigValidationError) Reason() string
Reason function returns reason value.
Source Files