Documentation
¶
Index ¶
- Variables
- type DynamicModuleConfigValidator
- func (*DynamicModuleConfigValidator) Descriptor() ([]byte, []int)deprecated
- func (x *DynamicModuleConfigValidator) GetDynamicModuleConfig() *v3.DynamicModuleConfig
- func (x *DynamicModuleConfigValidator) GetExtensionConfig() *anypb.Any
- func (x *DynamicModuleConfigValidator) GetExtensionName() string
- func (x *DynamicModuleConfigValidator) GetTypeUrls() []string
- func (*DynamicModuleConfigValidator) ProtoMessage()
- func (x *DynamicModuleConfigValidator) ProtoReflect() protoreflect.Message
- func (x *DynamicModuleConfigValidator) Reset()
- func (x *DynamicModuleConfigValidator) String() string
- func (m *DynamicModuleConfigValidator) Validate() error
- func (m *DynamicModuleConfigValidator) ValidateAll() error
- type DynamicModuleConfigValidatorMultiError
- type DynamicModuleConfigValidatorValidationError
- func (e DynamicModuleConfigValidatorValidationError) Cause() error
- func (e DynamicModuleConfigValidatorValidationError) Error() string
- func (e DynamicModuleConfigValidatorValidationError) ErrorName() string
- func (e DynamicModuleConfigValidatorValidationError) Field() string
- func (e DynamicModuleConfigValidatorValidationError) Key() bool
- func (e DynamicModuleConfigValidatorValidationError) Reason() string
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_config_validators_dynamic_modules_v3_dynamic_modules_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type DynamicModuleConfigValidator ¶
type DynamicModuleConfigValidator struct {
// Specifies the shared-object level configuration. This field is required.
//
// Only the “name“ and “module.local.filename“ sources are supported. Remote module sources
// are not supported because config validators are created without a factory context.
DynamicModuleConfig *v3.DynamicModuleConfig `protobuf:"bytes,1,opt,name=dynamic_module_config,json=dynamicModuleConfig,proto3" json:"dynamic_module_config,omitempty"`
// The name identifying the config validator implementation within the module. This is passed to
// the module's config validator init function so that a module can host multiple
// implementations. This field is required.
ExtensionName string `protobuf:"bytes,2,opt,name=extension_name,json=extensionName,proto3" json:"extension_name,omitempty"`
// The configuration for the implementation chosen by “extension_name“. If not specified, an
// empty configuration is passed to the module.
//
// “google.protobuf.Struct“ and the “value“ field of “xds.type.v3.TypedStruct“ are
// serialized as JSON before passing them to the module.
// “google.protobuf.BytesValue“ and “google.protobuf.StringValue“ are passed directly without
// the wrapper. Otherwise the serialized bytes of the configured message are passed.
ExtensionConfig *anypb.Any `protobuf:"bytes,3,opt,name=extension_config,json=extensionConfig,proto3" json:"extension_config,omitempty"`
// The xDS resource type URLs handled by this validator. Only updates whose type URL matches one
// of these values invoke the module. Each value must use the canonical
// “type.googleapis.com/<message>“ form. Exactly one type URL is supported today and this
// restriction may be relaxed in the future. This field is required.
TypeUrls []string `protobuf:"bytes,4,rep,name=type_urls,json=typeUrls,proto3" json:"type_urls,omitempty"`
// contains filtered or unexported fields
}
Configuration for an xDS config validator implemented by a dynamic module. For each xDS update the module receives the xDS type URL and the decoded resources, with each resource carrying its name, version, aliases, TTL, and re-serialized protobuf payload. During validation the module can also read current server state, such as the dynamic cluster count, through the validation context. A rejection from the module follows Envoy's normal xDS rejection path, so the xDS client receives a NACK and the last accepted configuration is retained.
func (*DynamicModuleConfigValidator) Descriptor
deprecated
func (*DynamicModuleConfigValidator) Descriptor() ([]byte, []int)
Deprecated: Use DynamicModuleConfigValidator.ProtoReflect.Descriptor instead.
func (*DynamicModuleConfigValidator) GetDynamicModuleConfig ¶
func (x *DynamicModuleConfigValidator) GetDynamicModuleConfig() *v3.DynamicModuleConfig
func (*DynamicModuleConfigValidator) GetExtensionConfig ¶
func (x *DynamicModuleConfigValidator) GetExtensionConfig() *anypb.Any
func (*DynamicModuleConfigValidator) GetExtensionName ¶
func (x *DynamicModuleConfigValidator) GetExtensionName() string
func (*DynamicModuleConfigValidator) GetTypeUrls ¶
func (x *DynamicModuleConfigValidator) GetTypeUrls() []string
func (*DynamicModuleConfigValidator) ProtoMessage ¶
func (*DynamicModuleConfigValidator) ProtoMessage()
func (*DynamicModuleConfigValidator) ProtoReflect ¶
func (x *DynamicModuleConfigValidator) ProtoReflect() protoreflect.Message
func (*DynamicModuleConfigValidator) Reset ¶
func (x *DynamicModuleConfigValidator) Reset()
func (*DynamicModuleConfigValidator) String ¶
func (x *DynamicModuleConfigValidator) String() string
func (*DynamicModuleConfigValidator) Validate ¶
func (m *DynamicModuleConfigValidator) Validate() error
Validate checks the field values on DynamicModuleConfigValidator 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 (*DynamicModuleConfigValidator) ValidateAll ¶
func (m *DynamicModuleConfigValidator) ValidateAll() error
ValidateAll checks the field values on DynamicModuleConfigValidator 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 DynamicModuleConfigValidatorMultiError, or nil if none found.
type DynamicModuleConfigValidatorMultiError ¶
type DynamicModuleConfigValidatorMultiError []error
DynamicModuleConfigValidatorMultiError is an error wrapping multiple validation errors returned by DynamicModuleConfigValidator.ValidateAll() if the designated constraints aren't met.
func (DynamicModuleConfigValidatorMultiError) AllErrors ¶
func (m DynamicModuleConfigValidatorMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (DynamicModuleConfigValidatorMultiError) Error ¶
func (m DynamicModuleConfigValidatorMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type DynamicModuleConfigValidatorValidationError ¶
type DynamicModuleConfigValidatorValidationError struct {
// contains filtered or unexported fields
}
DynamicModuleConfigValidatorValidationError is the validation error returned by DynamicModuleConfigValidator.Validate if the designated constraints aren't met.
func (DynamicModuleConfigValidatorValidationError) Cause ¶
func (e DynamicModuleConfigValidatorValidationError) Cause() error
Cause function returns cause value.
func (DynamicModuleConfigValidatorValidationError) Error ¶
func (e DynamicModuleConfigValidatorValidationError) Error() string
Error satisfies the builtin error interface
func (DynamicModuleConfigValidatorValidationError) ErrorName ¶
func (e DynamicModuleConfigValidatorValidationError) ErrorName() string
ErrorName returns error name.
func (DynamicModuleConfigValidatorValidationError) Field ¶
func (e DynamicModuleConfigValidatorValidationError) Field() string
Field function returns field value.
func (DynamicModuleConfigValidatorValidationError) Key ¶
func (e DynamicModuleConfigValidatorValidationError) Key() bool
Key function returns key value.
func (DynamicModuleConfigValidatorValidationError) Reason ¶
func (e DynamicModuleConfigValidatorValidationError) Reason() string
Reason function returns reason value.