import "github.com/envoyproxy/go-control-plane/envoy/config/overload/v3"
overload.pb.go overload.pb.validate.go
var (
ScaleTimersOverloadActionConfig_TimerType_name = map[int32]string{
0: "UNSPECIFIED",
1: "HTTP_DOWNSTREAM_CONNECTION_IDLE",
2: "HTTP_DOWNSTREAM_STREAM_IDLE",
}
ScaleTimersOverloadActionConfig_TimerType_value = map[string]int32{
"UNSPECIFIED": 0,
"HTTP_DOWNSTREAM_CONNECTION_IDLE": 1,
"HTTP_DOWNSTREAM_STREAM_IDLE": 2,
}
)Enum value maps for ScaleTimersOverloadActionConfig_TimerType.
var File_envoy_config_overload_v3_overload_proto protoreflect.FileDescriptor
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. The state of the action is the maximum
// state of all triggers, which can be scaling between 0 and 1 or saturated. Listeners
// are notified when the overload action changes state.
Triggers []*Trigger `protobuf:"bytes,2,rep,name=triggers,proto3" json:"triggers,omitempty"`
// Configuration for the action being instantiated.
TypedConfig *any.Any `protobuf:"bytes,3,opt,name=typed_config,json=typedConfig,proto3" json:"typed_config,omitempty"`
// contains filtered or unexported fields
}func (*OverloadAction) Descriptor() ([]byte, []int)
Deprecated: Use OverloadAction.ProtoReflect.Descriptor instead.
func (x *OverloadAction) GetName() string
func (x *OverloadAction) GetTriggers() []*Trigger
func (x *OverloadAction) GetTypedConfig() *any.Any
func (*OverloadAction) ProtoMessage()
func (x *OverloadAction) ProtoReflect() protoreflect.Message
func (x *OverloadAction) Reset()
func (x *OverloadAction) String() string
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, an error is returned.
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 (e OverloadActionValidationError) Cause() error
Cause function returns cause value.
func (e OverloadActionValidationError) Error() string
Error satisfies the builtin error interface
func (e OverloadActionValidationError) ErrorName() string
ErrorName returns error name.
func (e OverloadActionValidationError) Field() string
Field function returns field value.
func (e OverloadActionValidationError) Key() bool
Key function returns key value.
func (e OverloadActionValidationError) Reason() string
Reason function returns reason value.
type OverloadManager struct {
// The interval for refreshing resource usage.
RefreshInterval *duration.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() ([]byte, []int)
Deprecated: Use OverloadManager.ProtoReflect.Descriptor instead.
func (x *OverloadManager) GetActions() []*OverloadAction
func (x *OverloadManager) GetRefreshInterval() *duration.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
Validate checks the field values on OverloadManager with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
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 (e OverloadManagerValidationError) Cause() error
Cause function returns cause value.
func (e OverloadManagerValidationError) Error() string
Error satisfies the builtin error interface
func (e OverloadManagerValidationError) ErrorName() string
ErrorName returns error name.
func (e OverloadManagerValidationError) Field() string
Field function returns field value.
func (e OverloadManagerValidationError) Key() bool
Key function returns key value.
func (e OverloadManagerValidationError) Reason() string
Reason function returns reason value.
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_TypedConfig
// *ResourceMonitor_HiddenEnvoyDeprecatedConfig
ConfigType isResourceMonitor_ConfigType `protobuf_oneof:"config_type"`
// contains filtered or unexported fields
}func (*ResourceMonitor) Descriptor() ([]byte, []int)
Deprecated: Use ResourceMonitor.ProtoReflect.Descriptor instead.
func (m *ResourceMonitor) GetConfigType() isResourceMonitor_ConfigType
func (x *ResourceMonitor) GetHiddenEnvoyDeprecatedConfig() *_struct.Struct
Deprecated: Do not use.
func (x *ResourceMonitor) GetName() string
func (x *ResourceMonitor) GetTypedConfig() *any.Any
func (*ResourceMonitor) ProtoMessage()
func (x *ResourceMonitor) ProtoReflect() protoreflect.Message
func (x *ResourceMonitor) Reset()
func (x *ResourceMonitor) String() string
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, an error is returned.
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 (e ResourceMonitorValidationError) Cause() error
Cause function returns cause value.
func (e ResourceMonitorValidationError) Error() string
Error satisfies the builtin error interface
func (e ResourceMonitorValidationError) ErrorName() string
ErrorName returns error name.
func (e ResourceMonitorValidationError) Field() string
Field function returns field value.
func (e ResourceMonitorValidationError) Key() bool
Key function returns key value.
func (e ResourceMonitorValidationError) Reason() string
Reason function returns reason value.
type ResourceMonitor_HiddenEnvoyDeprecatedConfig struct {
// Deprecated: Do not use.
HiddenEnvoyDeprecatedConfig *_struct.Struct `protobuf:"bytes,2,opt,name=hidden_envoy_deprecated_config,json=hiddenEnvoyDeprecatedConfig,proto3,oneof"`
}type ResourceMonitor_TypedConfig struct {
TypedConfig *any.Any `protobuf:"bytes,3,opt,name=typed_config,json=typedConfig,proto3,oneof"`
}type ScaleTimersOverloadActionConfig struct {
// A set of timer scaling rules to be applied.
TimerScaleFactors []*ScaleTimersOverloadActionConfig_ScaleTimer `protobuf:"bytes,1,rep,name=timer_scale_factors,json=timerScaleFactors,proto3" json:"timer_scale_factors,omitempty"`
// contains filtered or unexported fields
}Typed configuration for the "envoy.overload_actions.reduce_timeouts" action. See :ref:`the docs <config_overload_manager_reducing_timeouts>` for an example of how to configure the action with different timeouts and minimum values.
func (*ScaleTimersOverloadActionConfig) Descriptor() ([]byte, []int)
Deprecated: Use ScaleTimersOverloadActionConfig.ProtoReflect.Descriptor instead.
func (x *ScaleTimersOverloadActionConfig) GetTimerScaleFactors() []*ScaleTimersOverloadActionConfig_ScaleTimer
func (*ScaleTimersOverloadActionConfig) ProtoMessage()
func (x *ScaleTimersOverloadActionConfig) ProtoReflect() protoreflect.Message
func (x *ScaleTimersOverloadActionConfig) Reset()
func (x *ScaleTimersOverloadActionConfig) String() string
func (m *ScaleTimersOverloadActionConfig) Validate() error
Validate checks the field values on ScaleTimersOverloadActionConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type ScaleTimersOverloadActionConfigValidationError struct {
// contains filtered or unexported fields
}ScaleTimersOverloadActionConfigValidationError is the validation error returned by ScaleTimersOverloadActionConfig.Validate if the designated constraints aren't met.
func (e ScaleTimersOverloadActionConfigValidationError) Cause() error
Cause function returns cause value.
func (e ScaleTimersOverloadActionConfigValidationError) Error() string
Error satisfies the builtin error interface
func (e ScaleTimersOverloadActionConfigValidationError) ErrorName() string
ErrorName returns error name.
func (e ScaleTimersOverloadActionConfigValidationError) Field() string
Field function returns field value.
func (e ScaleTimersOverloadActionConfigValidationError) Key() bool
Key function returns key value.
func (e ScaleTimersOverloadActionConfigValidationError) Reason() string
Reason function returns reason value.
type ScaleTimersOverloadActionConfig_ScaleTimer struct {
// The type of timer this minimum applies to.
Timer ScaleTimersOverloadActionConfig_TimerType `protobuf:"varint,1,opt,name=timer,proto3,enum=envoy.config.overload.v3.ScaleTimersOverloadActionConfig_TimerType" json:"timer,omitempty"`
// Types that are assignable to OverloadAdjust:
// *ScaleTimersOverloadActionConfig_ScaleTimer_MinTimeout
// *ScaleTimersOverloadActionConfig_ScaleTimer_MinScale
OverloadAdjust isScaleTimersOverloadActionConfig_ScaleTimer_OverloadAdjust `protobuf_oneof:"overload_adjust"`
// contains filtered or unexported fields
}func (*ScaleTimersOverloadActionConfig_ScaleTimer) Descriptor() ([]byte, []int)
Deprecated: Use ScaleTimersOverloadActionConfig_ScaleTimer.ProtoReflect.Descriptor instead.
func (x *ScaleTimersOverloadActionConfig_ScaleTimer) GetMinScale() *v3.Percent
func (x *ScaleTimersOverloadActionConfig_ScaleTimer) GetMinTimeout() *duration.Duration
func (m *ScaleTimersOverloadActionConfig_ScaleTimer) GetOverloadAdjust() isScaleTimersOverloadActionConfig_ScaleTimer_OverloadAdjust
func (x *ScaleTimersOverloadActionConfig_ScaleTimer) GetTimer() ScaleTimersOverloadActionConfig_TimerType
func (*ScaleTimersOverloadActionConfig_ScaleTimer) ProtoMessage()
func (x *ScaleTimersOverloadActionConfig_ScaleTimer) ProtoReflect() protoreflect.Message
func (x *ScaleTimersOverloadActionConfig_ScaleTimer) Reset()
func (x *ScaleTimersOverloadActionConfig_ScaleTimer) String() string
func (m *ScaleTimersOverloadActionConfig_ScaleTimer) Validate() error
Validate checks the field values on ScaleTimersOverloadActionConfig_ScaleTimer with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type ScaleTimersOverloadActionConfig_ScaleTimerValidationError struct {
// contains filtered or unexported fields
}ScaleTimersOverloadActionConfig_ScaleTimerValidationError is the validation error returned by ScaleTimersOverloadActionConfig_ScaleTimer.Validate if the designated constraints aren't met.
func (e ScaleTimersOverloadActionConfig_ScaleTimerValidationError) Cause() error
Cause function returns cause value.
func (e ScaleTimersOverloadActionConfig_ScaleTimerValidationError) Error() string
Error satisfies the builtin error interface
func (e ScaleTimersOverloadActionConfig_ScaleTimerValidationError) ErrorName() string
ErrorName returns error name.
func (e ScaleTimersOverloadActionConfig_ScaleTimerValidationError) Field() string
Field function returns field value.
func (e ScaleTimersOverloadActionConfig_ScaleTimerValidationError) Key() bool
Key function returns key value.
func (e ScaleTimersOverloadActionConfig_ScaleTimerValidationError) Reason() string
Reason function returns reason value.
type ScaleTimersOverloadActionConfig_ScaleTimer_MinScale struct {
// Sets the minimum duration as a percentage of the maximum value.
MinScale *v3.Percent `protobuf:"bytes,3,opt,name=min_scale,json=minScale,proto3,oneof"`
}type ScaleTimersOverloadActionConfig_ScaleTimer_MinTimeout struct {
// Sets the minimum duration as an absolute value.
MinTimeout *duration.Duration `protobuf:"bytes,2,opt,name=min_timeout,json=minTimeout,proto3,oneof"`
}const (
// Unsupported value; users must explicitly specify the timer they want scaled.
ScaleTimersOverloadActionConfig_UNSPECIFIED ScaleTimersOverloadActionConfig_TimerType = 0
// Adjusts the idle timer for downstream HTTP connections that takes effect when there are no active streams.
// This affects the value of :ref:`HttpConnectionManager.common_http_protocol_options.idle_timeout
// <envoy_v3_api_field_config.core.v3.HttpProtocolOptions.idle_timeout>`
ScaleTimersOverloadActionConfig_HTTP_DOWNSTREAM_CONNECTION_IDLE ScaleTimersOverloadActionConfig_TimerType = 1
// Adjusts the idle timer for HTTP streams initiated by downstream clients.
// This affects the value of :ref:`RouteAction.idle_timeout <envoy_v3_api_field_config.route.v3.RouteAction.idle_timeout>` and
// :ref:`HttpConnectionManager.stream_idle_timeout
// <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.stream_idle_timeout>`
ScaleTimersOverloadActionConfig_HTTP_DOWNSTREAM_STREAM_IDLE ScaleTimersOverloadActionConfig_TimerType = 2
)func (ScaleTimersOverloadActionConfig_TimerType) Descriptor() protoreflect.EnumDescriptor
func (x ScaleTimersOverloadActionConfig_TimerType) Enum() *ScaleTimersOverloadActionConfig_TimerType
func (ScaleTimersOverloadActionConfig_TimerType) EnumDescriptor() ([]byte, []int)
Deprecated: Use ScaleTimersOverloadActionConfig_TimerType.Descriptor instead.
func (x ScaleTimersOverloadActionConfig_TimerType) Number() protoreflect.EnumNumber
func (x ScaleTimersOverloadActionConfig_TimerType) String() string
func (ScaleTimersOverloadActionConfig_TimerType) Type() protoreflect.EnumType
type ScaledTrigger struct {
// If the resource pressure is greater than this value, the trigger will be in the
// :ref:`scaling <arch_overview_overload_manager-triggers-state>` state with value
// `(pressure - scaling_threshold) / (saturation_threshold - scaling_threshold)`.
ScalingThreshold float64 `protobuf:"fixed64,1,opt,name=scaling_threshold,json=scalingThreshold,proto3" json:"scaling_threshold,omitempty"`
// If the resource pressure is greater than this value, the trigger will enter saturation.
SaturationThreshold float64 `protobuf:"fixed64,2,opt,name=saturation_threshold,json=saturationThreshold,proto3" json:"saturation_threshold,omitempty"`
// contains filtered or unexported fields
}func (*ScaledTrigger) Descriptor() ([]byte, []int)
Deprecated: Use ScaledTrigger.ProtoReflect.Descriptor instead.
func (x *ScaledTrigger) GetSaturationThreshold() float64
func (x *ScaledTrigger) GetScalingThreshold() float64
func (*ScaledTrigger) ProtoMessage()
func (x *ScaledTrigger) ProtoReflect() protoreflect.Message
func (x *ScaledTrigger) Reset()
func (x *ScaledTrigger) String() string
func (m *ScaledTrigger) Validate() error
Validate checks the field values on ScaledTrigger with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type ScaledTriggerValidationError struct {
// contains filtered or unexported fields
}ScaledTriggerValidationError is the validation error returned by ScaledTrigger.Validate if the designated constraints aren't met.
func (e ScaledTriggerValidationError) Cause() error
Cause function returns cause value.
func (e ScaledTriggerValidationError) Error() string
Error satisfies the builtin error interface
func (e ScaledTriggerValidationError) ErrorName() string
ErrorName returns error name.
func (e ScaledTriggerValidationError) Field() string
Field function returns field value.
func (e ScaledTriggerValidationError) Key() bool
Key function returns key value.
func (e ScaledTriggerValidationError) Reason() string
Reason function returns reason value.
type ThresholdTrigger struct {
// If the resource pressure is greater than or equal to this value, the trigger
// will enter saturation.
Value float64 `protobuf:"fixed64,1,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}func (*ThresholdTrigger) Descriptor() ([]byte, []int)
Deprecated: Use ThresholdTrigger.ProtoReflect.Descriptor instead.
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
Validate checks the field values on ThresholdTrigger with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
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 (e ThresholdTriggerValidationError) Cause() error
Cause function returns cause value.
func (e ThresholdTriggerValidationError) Error() string
Error satisfies the builtin error interface
func (e ThresholdTriggerValidationError) ErrorName() string
ErrorName returns error name.
func (e ThresholdTriggerValidationError) Field() string
Field function returns field value.
func (e ThresholdTriggerValidationError) Key() bool
Key function returns key value.
func (e ThresholdTriggerValidationError) Reason() string
Reason function returns reason value.
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
// *Trigger_Scaled
TriggerOneof isTrigger_TriggerOneof `protobuf_oneof:"trigger_oneof"`
// contains filtered or unexported fields
}Deprecated: Use Trigger.ProtoReflect.Descriptor instead.
func (x *Trigger) GetScaled() *ScaledTrigger
func (x *Trigger) GetThreshold() *ThresholdTrigger
func (x *Trigger) ProtoReflect() protoreflect.Message
Validate checks the field values on Trigger with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
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 (e TriggerValidationError) Cause() error
Cause function returns cause value.
func (e TriggerValidationError) Error() string
Error satisfies the builtin error interface
func (e TriggerValidationError) ErrorName() string
ErrorName returns error name.
func (e TriggerValidationError) Field() string
Field function returns field value.
func (e TriggerValidationError) Key() bool
Key function returns key value.
func (e TriggerValidationError) Reason() string
Reason function returns reason value.
type Trigger_Scaled struct {
Scaled *ScaledTrigger `protobuf:"bytes,3,opt,name=scaled,proto3,oneof"`
}type Trigger_Threshold struct {
Threshold *ThresholdTrigger `protobuf:"bytes,2,opt,name=threshold,proto3,oneof"`
}Package envoy_config_overload_v3 imports 22 packages (graph) and is imported by 9 packages. Updated 2021-01-08. Refresh now. Tools for package owners.