Documentation ¶
Index ¶
- Variables
- type OverloadAction
- func (*OverloadAction) Descriptor() ([]byte, []int)deprecated
- func (x *OverloadAction) GetName() string
- func (x *OverloadAction) GetTriggers() []*Trigger
- func (*OverloadAction) ProtoMessage()
- func (x *OverloadAction) ProtoReflect() protoreflect.Message
- func (x *OverloadAction) Reset()
- func (x *OverloadAction) String() string
- func (m *OverloadAction) Validate() error
- func (m *OverloadAction) ValidateAll() error
- type OverloadActionMultiError
- type OverloadActionValidationError
- func (e OverloadActionValidationError) Cause() error
- func (e OverloadActionValidationError) Error() string
- func (e OverloadActionValidationError) ErrorName() string
- func (e OverloadActionValidationError) Field() string
- func (e OverloadActionValidationError) Key() bool
- func (e OverloadActionValidationError) Reason() string
- type OverloadManager
- func (*OverloadManager) Descriptor() ([]byte, []int)deprecated
- func (x *OverloadManager) GetActions() []*OverloadAction
- func (x *OverloadManager) GetRefreshInterval() *durationpb.Duration
- func (x *OverloadManager) GetResourceMonitors() []*ResourceMonitor
- func (*OverloadManager) ProtoMessage()
- func (x *OverloadManager) ProtoReflect() protoreflect.Message
- func (x *OverloadManager) Reset()
- func (x *OverloadManager) String() string
- func (m *OverloadManager) Validate() error
- func (m *OverloadManager) ValidateAll() error
- type OverloadManagerMultiError
- type OverloadManagerValidationError
- func (e OverloadManagerValidationError) Cause() error
- func (e OverloadManagerValidationError) Error() string
- func (e OverloadManagerValidationError) ErrorName() string
- func (e OverloadManagerValidationError) Field() string
- func (e OverloadManagerValidationError) Key() bool
- func (e OverloadManagerValidationError) Reason() string
- type ResourceMonitor
- func (*ResourceMonitor) Descriptor() ([]byte, []int)deprecated
- func (x *ResourceMonitor) GetConfig() *structpb.Structdeprecated
- func (m *ResourceMonitor) GetConfigType() isResourceMonitor_ConfigType
- func (x *ResourceMonitor) GetName() string
- func (x *ResourceMonitor) GetTypedConfig() *anypb.Any
- func (*ResourceMonitor) ProtoMessage()
- func (x *ResourceMonitor) ProtoReflect() protoreflect.Message
- func (x *ResourceMonitor) Reset()
- func (x *ResourceMonitor) String() string
- func (m *ResourceMonitor) Validate() error
- func (m *ResourceMonitor) ValidateAll() error
- type ResourceMonitorMultiError
- type ResourceMonitorValidationError
- func (e ResourceMonitorValidationError) Cause() error
- func (e ResourceMonitorValidationError) Error() string
- func (e ResourceMonitorValidationError) ErrorName() string
- func (e ResourceMonitorValidationError) Field() string
- func (e ResourceMonitorValidationError) Key() bool
- func (e ResourceMonitorValidationError) Reason() string
- type ResourceMonitor_Config
- type ResourceMonitor_TypedConfig
- type ThresholdTrigger
- func (*ThresholdTrigger) Descriptor() ([]byte, []int)deprecated
- func (x *ThresholdTrigger) GetValue() float64
- func (*ThresholdTrigger) ProtoMessage()
- func (x *ThresholdTrigger) ProtoReflect() protoreflect.Message
- func (x *ThresholdTrigger) Reset()
- func (x *ThresholdTrigger) String() string
- func (m *ThresholdTrigger) Validate() error
- func (m *ThresholdTrigger) ValidateAll() error
- type ThresholdTriggerMultiError
- type ThresholdTriggerValidationError
- func (e ThresholdTriggerValidationError) Cause() error
- func (e ThresholdTriggerValidationError) Error() string
- func (e ThresholdTriggerValidationError) ErrorName() string
- func (e ThresholdTriggerValidationError) Field() string
- func (e ThresholdTriggerValidationError) Key() bool
- func (e ThresholdTriggerValidationError) Reason() string
- type Trigger
- func (*Trigger) Descriptor() ([]byte, []int)deprecated
- func (x *Trigger) GetName() string
- func (x *Trigger) GetThreshold() *ThresholdTrigger
- func (m *Trigger) GetTriggerOneof() isTrigger_TriggerOneof
- func (*Trigger) ProtoMessage()
- func (x *Trigger) ProtoReflect() protoreflect.Message
- func (x *Trigger) Reset()
- func (x *Trigger) String() string
- func (m *Trigger) Validate() error
- func (m *Trigger) ValidateAll() error
- type TriggerMultiError
- type TriggerValidationError
- type Trigger_Threshold
Constants ¶
This section is empty.
Variables ¶
var File_envoy_config_overload_v2alpha_overload_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type OverloadAction ¶
type OverloadAction struct { // The name of the overload action. This is just a well-known string that listeners can // use for registering callbacks. Custom overload actions should be named using reverse // DNS to ensure uniqueness. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // A set of triggers for this action. If any of these triggers fire the overload action // is activated. Listeners are notified when the overload action transitions from // inactivated to activated, or vice versa. Triggers []*Trigger `protobuf:"bytes,2,rep,name=triggers,proto3" json:"triggers,omitempty"` // contains filtered or unexported fields }
func (*OverloadAction) Descriptor
deprecated
func (*OverloadAction) Descriptor() ([]byte, []int)
Deprecated: Use OverloadAction.ProtoReflect.Descriptor instead.
func (*OverloadAction) GetName ¶
func (x *OverloadAction) GetName() string
func (*OverloadAction) GetTriggers ¶
func (x *OverloadAction) GetTriggers() []*Trigger
func (*OverloadAction) ProtoMessage ¶
func (*OverloadAction) ProtoMessage()
func (*OverloadAction) ProtoReflect ¶ added in v0.9.6
func (x *OverloadAction) ProtoReflect() protoreflect.Message
func (*OverloadAction) Reset ¶
func (x *OverloadAction) Reset()
func (*OverloadAction) String ¶
func (x *OverloadAction) String() string
func (*OverloadAction) Validate ¶
func (m *OverloadAction) Validate() error
Validate checks the field values on OverloadAction 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 (*OverloadAction) ValidateAll ¶ added in v0.10.0
func (m *OverloadAction) ValidateAll() error
ValidateAll checks the field values on OverloadAction 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 OverloadActionMultiError, or nil if none found.
type OverloadActionMultiError ¶ added in v0.10.0
type OverloadActionMultiError []error
OverloadActionMultiError is an error wrapping multiple validation errors returned by OverloadAction.ValidateAll() if the designated constraints aren't met.
func (OverloadActionMultiError) AllErrors ¶ added in v0.10.0
func (m OverloadActionMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (OverloadActionMultiError) Error ¶ added in v0.10.0
func (m OverloadActionMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type OverloadActionValidationError ¶
type OverloadActionValidationError struct {
// contains filtered or unexported fields
}
OverloadActionValidationError is the validation error returned by OverloadAction.Validate if the designated constraints aren't met.
func (OverloadActionValidationError) Cause ¶
func (e OverloadActionValidationError) Cause() error
Cause function returns cause value.
func (OverloadActionValidationError) Error ¶
func (e OverloadActionValidationError) Error() string
Error satisfies the builtin error interface
func (OverloadActionValidationError) ErrorName ¶ added in v0.7.0
func (e OverloadActionValidationError) ErrorName() string
ErrorName returns error name.
func (OverloadActionValidationError) Field ¶
func (e OverloadActionValidationError) Field() string
Field function returns field value.
func (OverloadActionValidationError) Key ¶
func (e OverloadActionValidationError) Key() bool
Key function returns key value.
func (OverloadActionValidationError) Reason ¶
func (e OverloadActionValidationError) Reason() string
Reason function returns reason value.
type OverloadManager ¶
type OverloadManager struct { // The interval for refreshing resource usage. RefreshInterval *durationpb.Duration `protobuf:"bytes,1,opt,name=refresh_interval,json=refreshInterval,proto3" json:"refresh_interval,omitempty"` // The set of resources to monitor. ResourceMonitors []*ResourceMonitor `protobuf:"bytes,2,rep,name=resource_monitors,json=resourceMonitors,proto3" json:"resource_monitors,omitempty"` // The set of overload actions. Actions []*OverloadAction `protobuf:"bytes,3,rep,name=actions,proto3" json:"actions,omitempty"` // contains filtered or unexported fields }
func (*OverloadManager) Descriptor
deprecated
func (*OverloadManager) Descriptor() ([]byte, []int)
Deprecated: Use OverloadManager.ProtoReflect.Descriptor instead.
func (*OverloadManager) GetActions ¶
func (x *OverloadManager) GetActions() []*OverloadAction
func (*OverloadManager) GetRefreshInterval ¶
func (x *OverloadManager) GetRefreshInterval() *durationpb.Duration
func (*OverloadManager) GetResourceMonitors ¶
func (x *OverloadManager) GetResourceMonitors() []*ResourceMonitor
func (*OverloadManager) ProtoMessage ¶
func (*OverloadManager) ProtoMessage()
func (*OverloadManager) ProtoReflect ¶ added in v0.9.6
func (x *OverloadManager) ProtoReflect() protoreflect.Message
func (*OverloadManager) Reset ¶
func (x *OverloadManager) Reset()
func (*OverloadManager) String ¶
func (x *OverloadManager) String() string
func (*OverloadManager) Validate ¶
func (m *OverloadManager) Validate() error
Validate checks the field values on OverloadManager 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 (*OverloadManager) ValidateAll ¶ added in v0.10.0
func (m *OverloadManager) ValidateAll() error
ValidateAll checks the field values on OverloadManager 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 OverloadManagerMultiError, or nil if none found.
type OverloadManagerMultiError ¶ added in v0.10.0
type OverloadManagerMultiError []error
OverloadManagerMultiError is an error wrapping multiple validation errors returned by OverloadManager.ValidateAll() if the designated constraints aren't met.
func (OverloadManagerMultiError) AllErrors ¶ added in v0.10.0
func (m OverloadManagerMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (OverloadManagerMultiError) Error ¶ added in v0.10.0
func (m OverloadManagerMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type OverloadManagerValidationError ¶
type OverloadManagerValidationError struct {
// contains filtered or unexported fields
}
OverloadManagerValidationError is the validation error returned by OverloadManager.Validate if the designated constraints aren't met.
func (OverloadManagerValidationError) Cause ¶
func (e OverloadManagerValidationError) Cause() error
Cause function returns cause value.
func (OverloadManagerValidationError) Error ¶
func (e OverloadManagerValidationError) Error() string
Error satisfies the builtin error interface
func (OverloadManagerValidationError) ErrorName ¶ added in v0.7.0
func (e OverloadManagerValidationError) ErrorName() string
ErrorName returns error name.
func (OverloadManagerValidationError) Field ¶
func (e OverloadManagerValidationError) Field() string
Field function returns field value.
func (OverloadManagerValidationError) Key ¶
func (e OverloadManagerValidationError) Key() bool
Key function returns key value.
func (OverloadManagerValidationError) Reason ¶
func (e OverloadManagerValidationError) Reason() string
Reason function returns reason value.
type ResourceMonitor ¶
type ResourceMonitor struct { // The name of the resource monitor to instantiate. Must match a registered // resource monitor type. The built-in resource monitors are: // // - :ref:`envoy.resource_monitors.fixed_heap // <envoy_api_msg_config.resource_monitor.fixed_heap.v2alpha.FixedHeapConfig>` // - :ref:`envoy.resource_monitors.injected_resource // <envoy_api_msg_config.resource_monitor.injected_resource.v2alpha.InjectedResourceConfig>` Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Configuration for the resource monitor being instantiated. // // Types that are assignable to ConfigType: // // *ResourceMonitor_Config // *ResourceMonitor_TypedConfig ConfigType isResourceMonitor_ConfigType `protobuf_oneof:"config_type"` // contains filtered or unexported fields }
func (*ResourceMonitor) Descriptor
deprecated
func (*ResourceMonitor) Descriptor() ([]byte, []int)
Deprecated: Use ResourceMonitor.ProtoReflect.Descriptor instead.
func (*ResourceMonitor) GetConfig
deprecated
func (x *ResourceMonitor) GetConfig() *structpb.Struct
Deprecated: Marked as deprecated in envoy/config/overload/v2alpha/overload.proto.
func (*ResourceMonitor) GetConfigType ¶ added in v0.6.3
func (m *ResourceMonitor) GetConfigType() isResourceMonitor_ConfigType
func (*ResourceMonitor) GetName ¶
func (x *ResourceMonitor) GetName() string
func (*ResourceMonitor) GetTypedConfig ¶ added in v0.6.3
func (x *ResourceMonitor) GetTypedConfig() *anypb.Any
func (*ResourceMonitor) ProtoMessage ¶
func (*ResourceMonitor) ProtoMessage()
func (*ResourceMonitor) ProtoReflect ¶ added in v0.9.6
func (x *ResourceMonitor) ProtoReflect() protoreflect.Message
func (*ResourceMonitor) Reset ¶
func (x *ResourceMonitor) Reset()
func (*ResourceMonitor) String ¶
func (x *ResourceMonitor) String() string
func (*ResourceMonitor) Validate ¶
func (m *ResourceMonitor) Validate() error
Validate checks the field values on ResourceMonitor 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 (*ResourceMonitor) ValidateAll ¶ added in v0.10.0
func (m *ResourceMonitor) ValidateAll() error
ValidateAll checks the field values on ResourceMonitor 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 ResourceMonitorMultiError, or nil if none found.
type ResourceMonitorMultiError ¶ added in v0.10.0
type ResourceMonitorMultiError []error
ResourceMonitorMultiError is an error wrapping multiple validation errors returned by ResourceMonitor.ValidateAll() if the designated constraints aren't met.
func (ResourceMonitorMultiError) AllErrors ¶ added in v0.10.0
func (m ResourceMonitorMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (ResourceMonitorMultiError) Error ¶ added in v0.10.0
func (m ResourceMonitorMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type ResourceMonitorValidationError ¶
type ResourceMonitorValidationError struct {
// contains filtered or unexported fields
}
ResourceMonitorValidationError is the validation error returned by ResourceMonitor.Validate if the designated constraints aren't met.
func (ResourceMonitorValidationError) Cause ¶
func (e ResourceMonitorValidationError) Cause() error
Cause function returns cause value.
func (ResourceMonitorValidationError) Error ¶
func (e ResourceMonitorValidationError) Error() string
Error satisfies the builtin error interface
func (ResourceMonitorValidationError) ErrorName ¶ added in v0.7.0
func (e ResourceMonitorValidationError) ErrorName() string
ErrorName returns error name.
func (ResourceMonitorValidationError) Field ¶
func (e ResourceMonitorValidationError) Field() string
Field function returns field value.
func (ResourceMonitorValidationError) Key ¶
func (e ResourceMonitorValidationError) Key() bool
Key function returns key value.
func (ResourceMonitorValidationError) Reason ¶
func (e ResourceMonitorValidationError) Reason() string
Reason function returns reason value.
type ResourceMonitor_Config ¶ added in v0.6.3
type ResourceMonitor_TypedConfig ¶ added in v0.6.3
type ThresholdTrigger ¶
type ThresholdTrigger struct { // If the resource pressure is greater than or equal to this value, the trigger // will fire. Value float64 `protobuf:"fixed64,1,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
func (*ThresholdTrigger) Descriptor
deprecated
func (*ThresholdTrigger) Descriptor() ([]byte, []int)
Deprecated: Use ThresholdTrigger.ProtoReflect.Descriptor instead.
func (*ThresholdTrigger) GetValue ¶
func (x *ThresholdTrigger) GetValue() float64
func (*ThresholdTrigger) ProtoMessage ¶
func (*ThresholdTrigger) ProtoMessage()
func (*ThresholdTrigger) ProtoReflect ¶ added in v0.9.6
func (x *ThresholdTrigger) ProtoReflect() protoreflect.Message
func (*ThresholdTrigger) Reset ¶
func (x *ThresholdTrigger) Reset()
func (*ThresholdTrigger) String ¶
func (x *ThresholdTrigger) String() string
func (*ThresholdTrigger) Validate ¶
func (m *ThresholdTrigger) Validate() error
Validate checks the field values on ThresholdTrigger 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 (*ThresholdTrigger) ValidateAll ¶ added in v0.10.0
func (m *ThresholdTrigger) ValidateAll() error
ValidateAll checks the field values on ThresholdTrigger 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 ThresholdTriggerMultiError, or nil if none found.
type ThresholdTriggerMultiError ¶ added in v0.10.0
type ThresholdTriggerMultiError []error
ThresholdTriggerMultiError is an error wrapping multiple validation errors returned by ThresholdTrigger.ValidateAll() if the designated constraints aren't met.
func (ThresholdTriggerMultiError) AllErrors ¶ added in v0.10.0
func (m ThresholdTriggerMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (ThresholdTriggerMultiError) Error ¶ added in v0.10.0
func (m ThresholdTriggerMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type ThresholdTriggerValidationError ¶
type ThresholdTriggerValidationError struct {
// contains filtered or unexported fields
}
ThresholdTriggerValidationError is the validation error returned by ThresholdTrigger.Validate if the designated constraints aren't met.
func (ThresholdTriggerValidationError) Cause ¶
func (e ThresholdTriggerValidationError) Cause() error
Cause function returns cause value.
func (ThresholdTriggerValidationError) Error ¶
func (e ThresholdTriggerValidationError) Error() string
Error satisfies the builtin error interface
func (ThresholdTriggerValidationError) ErrorName ¶ added in v0.7.0
func (e ThresholdTriggerValidationError) ErrorName() string
ErrorName returns error name.
func (ThresholdTriggerValidationError) Field ¶
func (e ThresholdTriggerValidationError) Field() string
Field function returns field value.
func (ThresholdTriggerValidationError) Key ¶
func (e ThresholdTriggerValidationError) Key() bool
Key function returns key value.
func (ThresholdTriggerValidationError) Reason ¶
func (e ThresholdTriggerValidationError) Reason() string
Reason function returns reason value.
type Trigger ¶
type Trigger struct { // The name of the resource this is a trigger for. Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Types that are assignable to TriggerOneof: // // *Trigger_Threshold TriggerOneof isTrigger_TriggerOneof `protobuf_oneof:"trigger_oneof"` // contains filtered or unexported fields }
func (*Trigger) Descriptor
deprecated
func (*Trigger) GetThreshold ¶
func (x *Trigger) GetThreshold() *ThresholdTrigger
func (*Trigger) GetTriggerOneof ¶
func (m *Trigger) GetTriggerOneof() isTrigger_TriggerOneof
func (*Trigger) ProtoMessage ¶
func (*Trigger) ProtoMessage()
func (*Trigger) ProtoReflect ¶ added in v0.9.6
func (x *Trigger) ProtoReflect() protoreflect.Message
func (*Trigger) Validate ¶
Validate checks the field values on Trigger 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 (*Trigger) ValidateAll ¶ added in v0.10.0
ValidateAll checks the field values on Trigger 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 TriggerMultiError, or nil if none found.
type TriggerMultiError ¶ added in v0.10.0
type TriggerMultiError []error
TriggerMultiError is an error wrapping multiple validation errors returned by Trigger.ValidateAll() if the designated constraints aren't met.
func (TriggerMultiError) AllErrors ¶ added in v0.10.0
func (m TriggerMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (TriggerMultiError) Error ¶ added in v0.10.0
func (m TriggerMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type TriggerValidationError ¶
type TriggerValidationError struct {
// contains filtered or unexported fields
}
TriggerValidationError is the validation error returned by Trigger.Validate if the designated constraints aren't met.
func (TriggerValidationError) Cause ¶
func (e TriggerValidationError) Cause() error
Cause function returns cause value.
func (TriggerValidationError) Error ¶
func (e TriggerValidationError) Error() string
Error satisfies the builtin error interface
func (TriggerValidationError) ErrorName ¶ added in v0.7.0
func (e TriggerValidationError) ErrorName() string
ErrorName returns error name.
func (TriggerValidationError) Field ¶
func (e TriggerValidationError) Field() string
Field function returns field value.
func (TriggerValidationError) Key ¶
func (e TriggerValidationError) Key() bool
Key function returns key value.
func (TriggerValidationError) Reason ¶
func (e TriggerValidationError) Reason() string
Reason function returns reason value.
type Trigger_Threshold ¶
type Trigger_Threshold struct {
Threshold *ThresholdTrigger `protobuf:"bytes,2,opt,name=threshold,proto3,oneof"`
}