Documentation
¶
Index ¶
- Variables
- type HealthCheck
- func (*HealthCheck) Descriptor() ([]byte, []int)deprecated
- func (x *HealthCheck) GetCacheTime() *duration.Duration
- func (x *HealthCheck) GetClusterMinHealthyPercentages() map[string]*v3.Percent
- func (x *HealthCheck) GetHeaders() []*v31.HeaderMatcher
- func (x *HealthCheck) GetPassThroughMode() *wrappers.BoolValue
- func (*HealthCheck) ProtoMessage()
- func (x *HealthCheck) ProtoReflect() protoreflect.Message
- func (x *HealthCheck) Reset()
- func (x *HealthCheck) String() string
- func (m *HealthCheck) Validate() error
- func (m *HealthCheck) ValidateAll() error
- type HealthCheckMultiError
- type HealthCheckValidationError
- func (e HealthCheckValidationError) Cause() error
- func (e HealthCheckValidationError) Error() string
- func (e HealthCheckValidationError) ErrorName() string
- func (e HealthCheckValidationError) Field() string
- func (e HealthCheckValidationError) Key() bool
- func (e HealthCheckValidationError) Reason() string
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_filters_http_health_check_v3_health_check_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type HealthCheck ¶
type HealthCheck struct {
// Specifies whether the filter operates in pass through mode or not.
PassThroughMode *wrappers.BoolValue `protobuf:"bytes,1,opt,name=pass_through_mode,json=passThroughMode,proto3" json:"pass_through_mode,omitempty"`
// If operating in pass through mode, the amount of time in milliseconds
// that the filter should cache the upstream response.
CacheTime *duration.Duration `protobuf:"bytes,3,opt,name=cache_time,json=cacheTime,proto3" json:"cache_time,omitempty"`
// If operating in non-pass-through mode, specifies a set of upstream cluster
// names and the minimum percentage of servers in each of those clusters that
// must be healthy or degraded in order for the filter to return a 200.
//
// .. note::
//
// This value is interpreted as an integer by truncating, so 12.50% will be calculated
// as if it were 12%.
ClusterMinHealthyPercentages map[string]*v3.Percent `` /* 237-byte string literal not displayed */
// Specifies a set of health check request headers to match on. The health check filter will
// check a request’s headers against all the specified headers. To specify the health check
// endpoint, set the “:path“ header to match on.
Headers []*v31.HeaderMatcher `protobuf:"bytes,5,rep,name=headers,proto3" json:"headers,omitempty"`
// contains filtered or unexported fields
}
[#next-free-field: 6]
func (*HealthCheck) Descriptor
deprecated
func (*HealthCheck) Descriptor() ([]byte, []int)
Deprecated: Use HealthCheck.ProtoReflect.Descriptor instead.
func (*HealthCheck) GetCacheTime ¶
func (x *HealthCheck) GetCacheTime() *duration.Duration
func (*HealthCheck) GetClusterMinHealthyPercentages ¶
func (x *HealthCheck) GetClusterMinHealthyPercentages() map[string]*v3.Percent
func (*HealthCheck) GetHeaders ¶
func (x *HealthCheck) GetHeaders() []*v31.HeaderMatcher
func (*HealthCheck) GetPassThroughMode ¶
func (x *HealthCheck) GetPassThroughMode() *wrappers.BoolValue
func (*HealthCheck) ProtoMessage ¶
func (*HealthCheck) ProtoMessage()
func (*HealthCheck) ProtoReflect ¶ added in v0.9.6
func (x *HealthCheck) ProtoReflect() protoreflect.Message
func (*HealthCheck) Reset ¶
func (x *HealthCheck) Reset()
func (*HealthCheck) String ¶
func (x *HealthCheck) String() string
func (*HealthCheck) Validate ¶
func (m *HealthCheck) Validate() error
Validate checks the field values on HealthCheck 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 (*HealthCheck) ValidateAll ¶ added in v0.10.0
func (m *HealthCheck) ValidateAll() error
ValidateAll checks the field values on HealthCheck 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 HealthCheckMultiError, or nil if none found.
type HealthCheckMultiError ¶ added in v0.10.0
type HealthCheckMultiError []error
HealthCheckMultiError is an error wrapping multiple validation errors returned by HealthCheck.ValidateAll() if the designated constraints aren't met.
func (HealthCheckMultiError) AllErrors ¶ added in v0.10.0
func (m HealthCheckMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (HealthCheckMultiError) Error ¶ added in v0.10.0
func (m HealthCheckMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type HealthCheckValidationError ¶
type HealthCheckValidationError struct {
// contains filtered or unexported fields
}
HealthCheckValidationError is the validation error returned by HealthCheck.Validate if the designated constraints aren't met.
func (HealthCheckValidationError) Cause ¶
func (e HealthCheckValidationError) Cause() error
Cause function returns cause value.
func (HealthCheckValidationError) Error ¶
func (e HealthCheckValidationError) Error() string
Error satisfies the builtin error interface
func (HealthCheckValidationError) ErrorName ¶
func (e HealthCheckValidationError) ErrorName() string
ErrorName returns error name.
func (HealthCheckValidationError) Field ¶
func (e HealthCheckValidationError) Field() string
Field function returns field value.
func (HealthCheckValidationError) Key ¶
func (e HealthCheckValidationError) Key() bool
Key function returns key value.
func (HealthCheckValidationError) Reason ¶
func (e HealthCheckValidationError) Reason() string
Reason function returns reason value.
Source Files