hcconf

package
v0.9.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 14, 2024 License: Apache-2.0 Imports: 22 Imported by: 3

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	RequestMethod_name = map[int32]string{
		0: "METHOD_UNSPECIFIED",
		1: "GET",
		2: "HEAD",
		3: "POST",
		4: "PUT",
		5: "DELETE",
		6: "CONNECT",
		7: "OPTIONS",
		8: "TRACE",
		9: "PATCH",
	}
	RequestMethod_value = map[string]int32{
		"METHOD_UNSPECIFIED": 0,
		"GET":                1,
		"HEAD":               2,
		"POST":               3,
		"PUT":                4,
		"DELETE":             5,
		"CONNECT":            6,
		"OPTIONS":            7,
		"TRACE":              8,
		"PATCH":              9,
	}
)

Enum value maps for RequestMethod.

View Source 
var File_gsloc_api_config_healthchecks_v1_healthcheck_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type GrpcHealthCheck 

type GrpcHealthCheck struct {

	// An optional service name parameter which will be sent to gRPC service in
	// `grpc.health.v1.HealthCheckRequest
	// <https://github.com/grpc/grpc/blob/master/src/proto/grpc/health/v1/health.proto#L20>`_.
	// message. See `gRPC health-checking overview
	// <https://github.com/grpc/grpc/blob/master/doc/health-checking.md>`_ for more information.
	ServiceName string `protobuf:"bytes,1,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
	// The value of the :authority header in the gRPC health check request. If
	// left empty (default value), the name of the cluster this health check is associated
	// with will be used. The authority header can be customized for a specific endpoint by setting
	// the HealthCheckConfig.hostname field.
	Authority string `protobuf:"bytes,2,opt,name=authority,proto3" json:"authority,omitempty"`
	// contains filtered or unexported fields
}

`grpc.health.v1.Health <https://github.com/grpc/grpc/blob/master/src/proto/grpc/health/v1/health.proto>`_-based healthcheck. See `gRPC doc <https://github.com/grpc/grpc/blob/master/doc/health-checking.md>`_ for details.

func (*GrpcHealthCheck) Descriptor deprecated 

func (*GrpcHealthCheck) Descriptor() ([]byte, []int)

Deprecated: Use GrpcHealthCheck.ProtoReflect.Descriptor instead.

func (*GrpcHealthCheck) GetAuthority 

func (x *GrpcHealthCheck) GetAuthority() string

func (*GrpcHealthCheck) GetServiceName 

func (x *GrpcHealthCheck) GetServiceName() string

func (*GrpcHealthCheck) ProtoMessage 

func (*GrpcHealthCheck) ProtoMessage()

func (*GrpcHealthCheck) ProtoReflect 

func (x *GrpcHealthCheck) ProtoReflect() protoreflect.Message

func (*GrpcHealthCheck) Reset 

func (x *GrpcHealthCheck) Reset()

func (*GrpcHealthCheck) String 

func (x *GrpcHealthCheck) String() string

func (*GrpcHealthCheck) Validate 

func (m *GrpcHealthCheck) Validate() error

Validate checks the field values on GrpcHealthCheck 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 (*GrpcHealthCheck) ValidateAll 

func (m *GrpcHealthCheck) ValidateAll() error

ValidateAll checks the field values on GrpcHealthCheck 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 GrpcHealthCheckMultiError, or nil if none found.

type GrpcHealthCheckMultiError 

type GrpcHealthCheckMultiError []error

GrpcHealthCheckMultiError is an error wrapping multiple validation errors returned by GrpcHealthCheck.ValidateAll() if the designated constraints aren't met.

func (GrpcHealthCheckMultiError) AllErrors 

func (m GrpcHealthCheckMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (GrpcHealthCheckMultiError) Error 

func (m GrpcHealthCheckMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type GrpcHealthCheckValidationError 

type GrpcHealthCheckValidationError struct {
	// contains filtered or unexported fields
}

GrpcHealthCheckValidationError is the validation error returned by GrpcHealthCheck.Validate if the designated constraints aren't met.

func (GrpcHealthCheckValidationError) Cause 

func (e GrpcHealthCheckValidationError) Cause() error

Cause function returns cause value.

func (GrpcHealthCheckValidationError) Error 

func (e GrpcHealthCheckValidationError) Error() string

Error satisfies the builtin error interface

func (GrpcHealthCheckValidationError) ErrorName 

func (e GrpcHealthCheckValidationError) ErrorName() string

ErrorName returns error name.

func (GrpcHealthCheckValidationError) Field 

func (e GrpcHealthCheckValidationError) Field() string

Field function returns field value.

func (GrpcHealthCheckValidationError) Key 

func (e GrpcHealthCheckValidationError) Key() bool

Key function returns key value.

func (GrpcHealthCheckValidationError) Reason 

func (e GrpcHealthCheckValidationError) Reason() string

Reason function returns reason value.

type HealthCheck 

type HealthCheck struct {

	// The time to wait for a health check response. If the timeout is reached the
	// health check attempt will be considered a failure.
	Timeout *durationpb.Duration `protobuf:"bytes,1,opt,name=timeout,proto3" json:"timeout,omitempty"`
	// The interval between health checks.
	Interval *durationpb.Duration `protobuf:"bytes,2,opt,name=interval,proto3" json:"interval,omitempty"`
	// port specifies the port to use when performing health checks.
	Port uint32 `protobuf:"varint,3,opt,name=port,proto3" json:"port,omitempty"`
	// Types that are assignable to HealthChecker:
	//
	//	*HealthCheck_HttpHealthCheck
	//	*HealthCheck_TcpHealthCheck
	//	*HealthCheck_GrpcHealthCheck
	//	*HealthCheck_NoHealthCheck
	//	*HealthCheck_PluginHealthCheck
	//	*HealthCheck_IcmpHealthCheck
	//	*HealthCheck_UdpHealthCheck
	HealthChecker isHealthCheck_HealthChecker `protobuf_oneof:"health_checker"`
	// set tls configuration for healthcheck
	TlsConfig *TlsConfig `protobuf:"bytes,8,opt,name=tls_config,json=tlsConfig,proto3" json:"tls_config,omitempty"`
	// contains filtered or unexported fields
}

Health check configuration.

func (*HealthCheck) Descriptor deprecated 

func (*HealthCheck) Descriptor() ([]byte, []int)

Deprecated: Use HealthCheck.ProtoReflect.Descriptor instead.

func (*HealthCheck) GetGrpcHealthCheck 

func (x *HealthCheck) GetGrpcHealthCheck() *GrpcHealthCheck

func (*HealthCheck) GetHealthChecker 

func (m *HealthCheck) GetHealthChecker() isHealthCheck_HealthChecker

func (*HealthCheck) GetHttpHealthCheck 

func (x *HealthCheck) GetHttpHealthCheck() *HttpHealthCheck

func (*HealthCheck) GetIcmpHealthCheck added in v0.6.0 

func (x *HealthCheck) GetIcmpHealthCheck() *IcmpHealthCheck

func (*HealthCheck) GetInterval 

func (x *HealthCheck) GetInterval() *durationpb.Duration

func (*HealthCheck) GetNoHealthCheck 

func (x *HealthCheck) GetNoHealthCheck() *NoHealthCheck

func (*HealthCheck) GetPluginHealthCheck added in v0.6.0 

func (x *HealthCheck) GetPluginHealthCheck() *PluginHealthCheck

func (*HealthCheck) GetPort 

func (x *HealthCheck) GetPort() uint32

func (*HealthCheck) GetTcpHealthCheck 

func (x *HealthCheck) GetTcpHealthCheck() *TcpHealthCheck

func (*HealthCheck) GetTimeout 

func (x *HealthCheck) GetTimeout() *durationpb.Duration

func (*HealthCheck) GetTlsConfig added in v0.3.0 

func (x *HealthCheck) GetTlsConfig() *TlsConfig

func (*HealthCheck) GetUdpHealthCheck added in v0.6.0 

func (x *HealthCheck) GetUdpHealthCheck() *UdpHealthCheck

func (*HealthCheck) ProtoMessage 

func (*HealthCheck) ProtoMessage()

func (*HealthCheck) ProtoReflect 

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 

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 

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 

func (m HealthCheckMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HealthCheckMultiError) Error 

func (m HealthCheckMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type HealthCheckPayload 

type HealthCheckPayload struct {

	// Types that are assignable to Payload:
	//
	//	*HealthCheckPayload_Text
	//	*HealthCheckPayload_Binary
	Payload isHealthCheckPayload_Payload `protobuf_oneof:"payload"`
	// contains filtered or unexported fields
}

Describes the encoding of the payload bytes in the payload.

func (*HealthCheckPayload) Descriptor deprecated 

func (*HealthCheckPayload) Descriptor() ([]byte, []int)

Deprecated: Use HealthCheckPayload.ProtoReflect.Descriptor instead.

func (*HealthCheckPayload) GetBinary 

func (x *HealthCheckPayload) GetBinary() []byte

func (*HealthCheckPayload) GetData 

func (x *HealthCheckPayload) GetData() []byte

func (*HealthCheckPayload) GetPayload 

func (m *HealthCheckPayload) GetPayload() isHealthCheckPayload_Payload

func (*HealthCheckPayload) GetText 

func (x *HealthCheckPayload) GetText() string

func (*HealthCheckPayload) ProtoMessage 

func (*HealthCheckPayload) ProtoMessage()

func (*HealthCheckPayload) ProtoReflect 

func (x *HealthCheckPayload) ProtoReflect() protoreflect.Message

func (*HealthCheckPayload) Reset 

func (x *HealthCheckPayload) Reset()

func (*HealthCheckPayload) String 

func (x *HealthCheckPayload) String() string

func (*HealthCheckPayload) Validate 

func (m *HealthCheckPayload) Validate() error

Validate checks the field values on HealthCheckPayload 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 (*HealthCheckPayload) ValidateAll 

func (m *HealthCheckPayload) ValidateAll() error

ValidateAll checks the field values on HealthCheckPayload 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 HealthCheckPayloadMultiError, or nil if none found.

type HealthCheckPayloadMultiError 

type HealthCheckPayloadMultiError []error

HealthCheckPayloadMultiError is an error wrapping multiple validation errors returned by HealthCheckPayload.ValidateAll() if the designated constraints aren't met.

func (HealthCheckPayloadMultiError) AllErrors 

func (m HealthCheckPayloadMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HealthCheckPayloadMultiError) Error 

func (m HealthCheckPayloadMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type HealthCheckPayloadValidationError 

type HealthCheckPayloadValidationError struct {
	// contains filtered or unexported fields
}

HealthCheckPayloadValidationError is the validation error returned by HealthCheckPayload.Validate if the designated constraints aren't met.

func (HealthCheckPayloadValidationError) Cause 

func (e HealthCheckPayloadValidationError) Cause() error

Cause function returns cause value.

func (HealthCheckPayloadValidationError) Error 

func (e HealthCheckPayloadValidationError) Error() string

Error satisfies the builtin error interface

func (HealthCheckPayloadValidationError) ErrorName 

func (e HealthCheckPayloadValidationError) ErrorName() string

ErrorName returns error name.

func (HealthCheckPayloadValidationError) Field 

func (e HealthCheckPayloadValidationError) Field() string

Field function returns field value.

func (HealthCheckPayloadValidationError) Key 

func (e HealthCheckPayloadValidationError) Key() bool

Key function returns key value.

func (HealthCheckPayloadValidationError) Reason 

func (e HealthCheckPayloadValidationError) Reason() string

Reason function returns reason value.

type HealthCheckPayload_Binary 

type HealthCheckPayload_Binary struct {
	// Binary payload.
	Binary []byte `protobuf:"bytes,2,opt,name=binary,proto3,oneof"`
}

type HealthCheckPayload_Text 

type HealthCheckPayload_Text struct {
	// Hex encoded payload. E.g., "000000FF".
	Text string `protobuf:"bytes,1,opt,name=text,proto3,oneof"`
}

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.

type HealthCheck_GrpcHealthCheck 

type HealthCheck_GrpcHealthCheck struct {
	// gRPC health check.
	GrpcHealthCheck *GrpcHealthCheck `protobuf:"bytes,6,opt,name=grpc_health_check,json=grpcHealthCheck,proto3,oneof"`
}

type HealthCheck_HttpHealthCheck 

type HealthCheck_HttpHealthCheck struct {
	// HTTP health check.
	HttpHealthCheck *HttpHealthCheck `protobuf:"bytes,4,opt,name=http_health_check,json=httpHealthCheck,proto3,oneof"`
}

type HealthCheck_IcmpHealthCheck added in v0.6.0 

type HealthCheck_IcmpHealthCheck struct {
	// ICMP health check.
	IcmpHealthCheck *IcmpHealthCheck `protobuf:"bytes,10,opt,name=icmp_health_check,json=icmpHealthCheck,proto3,oneof"`
}

type HealthCheck_NoHealthCheck 

type HealthCheck_NoHealthCheck struct {
	// No health check.
	NoHealthCheck *NoHealthCheck `protobuf:"bytes,7,opt,name=no_health_check,json=noHealthCheck,proto3,oneof"`
}

type HealthCheck_PluginHealthCheck added in v0.6.0 

type HealthCheck_PluginHealthCheck struct {
	// Plugin health check.
	PluginHealthCheck *PluginHealthCheck `protobuf:"bytes,9,opt,name=plugin_health_check,json=pluginHealthCheck,proto3,oneof"`
}

type HealthCheck_TcpHealthCheck 

type HealthCheck_TcpHealthCheck struct {
	// TCP health check.
	TcpHealthCheck *TcpHealthCheck `protobuf:"bytes,5,opt,name=tcp_health_check,json=tcpHealthCheck,proto3,oneof"`
}

type HealthCheck_UdpHealthCheck added in v0.6.0 

type HealthCheck_UdpHealthCheck struct {
	// UDP health check.
	UdpHealthCheck *UdpHealthCheck `protobuf:"bytes,11,opt,name=udp_health_check,json=udpHealthCheck,proto3,oneof"`
}

type HttpHealthCheck 

type HttpHealthCheck struct {

	// The value of the host header in the HTTP health check request. If
	// left empty (default value), the name of the cluster this health check is associated
	// with will be used.
	Host string `protobuf:"bytes,1,opt,name=host,proto3" json:"host,omitempty"`
	// Specifies the HTTP path that will be requested during health checking. For example
	// */healthcheck*.
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// HTTP specific payload.
	Send *HealthCheckPayload `protobuf:"bytes,3,opt,name=send,proto3" json:"send,omitempty"`
	// HTTP specific response.
	Receive *HealthCheckPayload `protobuf:"bytes,4,opt,name=receive,proto3" json:"receive,omitempty"`
	// Specifies a list of HTTP headers that should be added to each request that is sent to the
	// health checked cluster.
	RequestHeadersToAdd []*v1.HeaderValueOption `protobuf:"bytes,5,rep,name=request_headers_to_add,json=requestHeadersToAdd,proto3" json:"request_headers_to_add,omitempty"`
	// Specifies a list of HTTP response statuses considered healthy. If provided, replaces default
	// 200-only policy - 200 must be included explicitly as needed. Ranges follow half-open
	// semantics of Int64Range. The start and end of each
	// range are required. Only statuses in the range [100, 600) are allowed.
	ExpectedStatuses *v11.Int64Range `protobuf:"bytes,6,opt,name=expected_statuses,json=expectedStatuses,proto3" json:"expected_statuses,omitempty"`
	// Use specified application protocol for health checks.
	CodecClientType v11.CodecClientType `` /* 144-byte string literal not displayed */
	// HTTP Method that will be used for health checking, default is "GET".
	// GET, HEAD, POST, PUT, DELETE, OPTIONS, TRACE, PATCH methods are supported, but making request body is not supported.
	// CONNECT method is disallowed because it is not appropriate for health check request.
	// If a non-200 response is expected by the method, it needs to be set in expected_statuses.
	Method RequestMethod `protobuf:"varint,8,opt,name=method,proto3,enum=gsloc.api.config.healthchecks.v1.RequestMethod" json:"method,omitempty"`
	// contains filtered or unexported fields
}

func (*HttpHealthCheck) Descriptor deprecated 

func (*HttpHealthCheck) Descriptor() ([]byte, []int)

Deprecated: Use HttpHealthCheck.ProtoReflect.Descriptor instead.

func (*HttpHealthCheck) GetCodecClientType 

func (x *HttpHealthCheck) GetCodecClientType() v11.CodecClientType

func (*HttpHealthCheck) GetExpectedStatuses 

func (x *HttpHealthCheck) GetExpectedStatuses() *v11.Int64Range

func (*HttpHealthCheck) GetHost 

func (x *HttpHealthCheck) GetHost() string

func (*HttpHealthCheck) GetMethod 

func (x *HttpHealthCheck) GetMethod() RequestMethod

func (*HttpHealthCheck) GetPath 

func (x *HttpHealthCheck) GetPath() string

func (*HttpHealthCheck) GetReceive 

func (x *HttpHealthCheck) GetReceive() *HealthCheckPayload

func (*HttpHealthCheck) GetRequestHeadersToAdd 

func (x *HttpHealthCheck) GetRequestHeadersToAdd() []*v1.HeaderValueOption

func (*HttpHealthCheck) GetSend 

func (x *HttpHealthCheck) GetSend() *HealthCheckPayload

func (*HttpHealthCheck) ProtoMessage 

func (*HttpHealthCheck) ProtoMessage()

func (*HttpHealthCheck) ProtoReflect 

func (x *HttpHealthCheck) ProtoReflect() protoreflect.Message

func (*HttpHealthCheck) Reset 

func (x *HttpHealthCheck) Reset()

func (*HttpHealthCheck) String 

func (x *HttpHealthCheck) String() string

func (*HttpHealthCheck) Validate 

func (m *HttpHealthCheck) Validate() error

Validate checks the field values on HttpHealthCheck 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 (*HttpHealthCheck) ValidateAll 

func (m *HttpHealthCheck) ValidateAll() error

ValidateAll checks the field values on HttpHealthCheck 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 HttpHealthCheckMultiError, or nil if none found.

type HttpHealthCheckMultiError 

type HttpHealthCheckMultiError []error

HttpHealthCheckMultiError is an error wrapping multiple validation errors returned by HttpHealthCheck.ValidateAll() if the designated constraints aren't met.

func (HttpHealthCheckMultiError) AllErrors 

func (m HttpHealthCheckMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HttpHealthCheckMultiError) Error 

func (m HttpHealthCheckMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type HttpHealthCheckValidationError 

type HttpHealthCheckValidationError struct {
	// contains filtered or unexported fields
}

HttpHealthCheckValidationError is the validation error returned by HttpHealthCheck.Validate if the designated constraints aren't met.

func (HttpHealthCheckValidationError) Cause 

func (e HttpHealthCheckValidationError) Cause() error

Cause function returns cause value.

func (HttpHealthCheckValidationError) Error 

func (e HttpHealthCheckValidationError) Error() string

Error satisfies the builtin error interface

func (HttpHealthCheckValidationError) ErrorName 

func (e HttpHealthCheckValidationError) ErrorName() string

ErrorName returns error name.

func (HttpHealthCheckValidationError) Field 

func (e HttpHealthCheckValidationError) Field() string

Field function returns field value.

func (HttpHealthCheckValidationError) Key 

func (e HttpHealthCheckValidationError) Key() bool

Key function returns key value.

func (HttpHealthCheckValidationError) Reason 

func (e HttpHealthCheckValidationError) Reason() string

Reason function returns reason value.

type IcmpHealthCheck added in v0.6.0 

type IcmpHealthCheck struct {

	// Delay specifies the delay between ICMP reply read try. If left empty (default to 1s).
	Delay *durationpb.Duration `protobuf:"bytes,1,opt,name=delay,proto3" json:"delay,omitempty"`
	// contains filtered or unexported fields
}

ICMP health check also known as ping.

func (*IcmpHealthCheck) Descriptor deprecated added in v0.6.0 

func (*IcmpHealthCheck) Descriptor() ([]byte, []int)

Deprecated: Use IcmpHealthCheck.ProtoReflect.Descriptor instead.

func (*IcmpHealthCheck) GetDelay added in v0.6.0 

func (x *IcmpHealthCheck) GetDelay() *durationpb.Duration

func (*IcmpHealthCheck) ProtoMessage added in v0.6.0 

func (*IcmpHealthCheck) ProtoMessage()

func (*IcmpHealthCheck) ProtoReflect added in v0.6.0 

func (x *IcmpHealthCheck) ProtoReflect() protoreflect.Message

func (*IcmpHealthCheck) Reset added in v0.6.0 

func (x *IcmpHealthCheck) Reset()

func (*IcmpHealthCheck) String added in v0.6.0 

func (x *IcmpHealthCheck) String() string

func (*IcmpHealthCheck) Validate added in v0.6.0 

func (m *IcmpHealthCheck) Validate() error

Validate checks the field values on IcmpHealthCheck 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 (*IcmpHealthCheck) ValidateAll added in v0.6.0 

func (m *IcmpHealthCheck) ValidateAll() error

ValidateAll checks the field values on IcmpHealthCheck 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 IcmpHealthCheckMultiError, or nil if none found.

type IcmpHealthCheckMultiError added in v0.6.0 

type IcmpHealthCheckMultiError []error

IcmpHealthCheckMultiError is an error wrapping multiple validation errors returned by IcmpHealthCheck.ValidateAll() if the designated constraints aren't met.

func (IcmpHealthCheckMultiError) AllErrors added in v0.6.0 

func (m IcmpHealthCheckMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (IcmpHealthCheckMultiError) Error added in v0.6.0 

func (m IcmpHealthCheckMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type IcmpHealthCheckValidationError added in v0.6.0 

type IcmpHealthCheckValidationError struct {
	// contains filtered or unexported fields
}

IcmpHealthCheckValidationError is the validation error returned by IcmpHealthCheck.Validate if the designated constraints aren't met.

func (IcmpHealthCheckValidationError) Cause added in v0.6.0 

func (e IcmpHealthCheckValidationError) Cause() error

Cause function returns cause value.

func (IcmpHealthCheckValidationError) Error added in v0.6.0 

func (e IcmpHealthCheckValidationError) Error() string

Error satisfies the builtin error interface

func (IcmpHealthCheckValidationError) ErrorName added in v0.6.0 

func (e IcmpHealthCheckValidationError) ErrorName() string

ErrorName returns error name.

func (IcmpHealthCheckValidationError) Field added in v0.6.0 

func (e IcmpHealthCheckValidationError) Field() string

Field function returns field value.

func (IcmpHealthCheckValidationError) Key added in v0.6.0 

func (e IcmpHealthCheckValidationError) Key() bool

Key function returns key value.

func (IcmpHealthCheckValidationError) Reason added in v0.6.0 

func (e IcmpHealthCheckValidationError) Reason() string

Reason function returns reason value.

type NoHealthCheck 

type NoHealthCheck struct {
	// contains filtered or unexported fields
}

No health check. This health check is always considered healthy. This is particularly useful for udp route which cannot be health checked.

func (*NoHealthCheck) Descriptor deprecated 

func (*NoHealthCheck) Descriptor() ([]byte, []int)

Deprecated: Use NoHealthCheck.ProtoReflect.Descriptor instead.

func (*NoHealthCheck) ProtoMessage 

func (*NoHealthCheck) ProtoMessage()

func (*NoHealthCheck) ProtoReflect 

func (x *NoHealthCheck) ProtoReflect() protoreflect.Message

func (*NoHealthCheck) Reset 

func (x *NoHealthCheck) Reset()

func (*NoHealthCheck) String 

func (x *NoHealthCheck) String() string

func (*NoHealthCheck) Validate 

func (m *NoHealthCheck) Validate() error

Validate checks the field values on NoHealthCheck 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 (*NoHealthCheck) ValidateAll 

func (m *NoHealthCheck) ValidateAll() error

ValidateAll checks the field values on NoHealthCheck 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 NoHealthCheckMultiError, or nil if none found.

type NoHealthCheckMultiError 

type NoHealthCheckMultiError []error

NoHealthCheckMultiError is an error wrapping multiple validation errors returned by NoHealthCheck.ValidateAll() if the designated constraints aren't met.

func (NoHealthCheckMultiError) AllErrors 

func (m NoHealthCheckMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (NoHealthCheckMultiError) Error 

func (m NoHealthCheckMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type NoHealthCheckValidationError 

type NoHealthCheckValidationError struct {
	// contains filtered or unexported fields
}

NoHealthCheckValidationError is the validation error returned by NoHealthCheck.Validate if the designated constraints aren't met.

func (NoHealthCheckValidationError) Cause 

func (e NoHealthCheckValidationError) Cause() error

Cause function returns cause value.

func (NoHealthCheckValidationError) Error 

func (e NoHealthCheckValidationError) Error() string

Error satisfies the builtin error interface

func (NoHealthCheckValidationError) ErrorName 

func (e NoHealthCheckValidationError) ErrorName() string

ErrorName returns error name.

func (NoHealthCheckValidationError) Field 

func (e NoHealthCheckValidationError) Field() string

Field function returns field value.

func (NoHealthCheckValidationError) Key 

func (e NoHealthCheckValidationError) Key() bool

Key function returns key value.

func (NoHealthCheckValidationError) Reason 

func (e NoHealthCheckValidationError) Reason() string

Reason function returns reason value.

type PluginHealthCheck added in v0.6.0 

type PluginHealthCheck struct {

	// The name of the plugin to use for health checking.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The options to pass to the plugin.
	Options *structpb.Struct `protobuf:"bytes,2,opt,name=options,proto3" json:"options,omitempty"`
	// contains filtered or unexported fields
}

Plugin health check by using a external program defined in the plugin configuration in the server. Plugin name and description can be view in service list plugins.

func (*PluginHealthCheck) Descriptor deprecated added in v0.6.0 

func (*PluginHealthCheck) Descriptor() ([]byte, []int)

Deprecated: Use PluginHealthCheck.ProtoReflect.Descriptor instead.

func (*PluginHealthCheck) GetName added in v0.6.0 

func (x *PluginHealthCheck) GetName() string

func (*PluginHealthCheck) GetOptions added in v0.6.0 

func (x *PluginHealthCheck) GetOptions() *structpb.Struct

func (*PluginHealthCheck) ProtoMessage added in v0.6.0 

func (*PluginHealthCheck) ProtoMessage()

func (*PluginHealthCheck) ProtoReflect added in v0.6.0 

func (x *PluginHealthCheck) ProtoReflect() protoreflect.Message

func (*PluginHealthCheck) Reset added in v0.6.0 

func (x *PluginHealthCheck) Reset()

func (*PluginHealthCheck) String added in v0.6.0 

func (x *PluginHealthCheck) String() string

func (*PluginHealthCheck) Validate added in v0.6.0 

func (m *PluginHealthCheck) Validate() error

Validate checks the field values on PluginHealthCheck 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 (*PluginHealthCheck) ValidateAll added in v0.6.0 

func (m *PluginHealthCheck) ValidateAll() error

ValidateAll checks the field values on PluginHealthCheck 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 PluginHealthCheckMultiError, or nil if none found.

type PluginHealthCheckMultiError added in v0.6.0 

type PluginHealthCheckMultiError []error

PluginHealthCheckMultiError is an error wrapping multiple validation errors returned by PluginHealthCheck.ValidateAll() if the designated constraints aren't met.

func (PluginHealthCheckMultiError) AllErrors added in v0.6.0 

func (m PluginHealthCheckMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (PluginHealthCheckMultiError) Error added in v0.6.0 

func (m PluginHealthCheckMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type PluginHealthCheckValidationError added in v0.6.0 

type PluginHealthCheckValidationError struct {
	// contains filtered or unexported fields
}

PluginHealthCheckValidationError is the validation error returned by PluginHealthCheck.Validate if the designated constraints aren't met.

func (PluginHealthCheckValidationError) Cause added in v0.6.0 

func (e PluginHealthCheckValidationError) Cause() error

Cause function returns cause value.

func (PluginHealthCheckValidationError) Error added in v0.6.0 

func (e PluginHealthCheckValidationError) Error() string

Error satisfies the builtin error interface

func (PluginHealthCheckValidationError) ErrorName added in v0.6.0 

func (e PluginHealthCheckValidationError) ErrorName() string

ErrorName returns error name.

func (PluginHealthCheckValidationError) Field added in v0.6.0 

func (e PluginHealthCheckValidationError) Field() string

Field function returns field value.

func (PluginHealthCheckValidationError) Key added in v0.6.0 

func (e PluginHealthCheckValidationError) Key() bool

Key function returns key value.

func (PluginHealthCheckValidationError) Reason added in v0.6.0 

func (e PluginHealthCheckValidationError) Reason() string

Reason function returns reason value.

type RequestMethod 

type RequestMethod int32

HTTP request method. 

const (
	RequestMethod_METHOD_UNSPECIFIED RequestMethod = 0
	RequestMethod_GET                RequestMethod = 1
	RequestMethod_HEAD               RequestMethod = 2
	RequestMethod_POST               RequestMethod = 3
	RequestMethod_PUT                RequestMethod = 4
	RequestMethod_DELETE             RequestMethod = 5
	RequestMethod_CONNECT            RequestMethod = 6
	RequestMethod_OPTIONS            RequestMethod = 7
	RequestMethod_TRACE              RequestMethod = 8
	RequestMethod_PATCH              RequestMethod = 9
)

func (RequestMethod) Descriptor 

func (RequestMethod) Descriptor() protoreflect.EnumDescriptor

func (RequestMethod) Enum 

func (x RequestMethod) Enum() *RequestMethod

func (RequestMethod) EnumDescriptor deprecated 

func (RequestMethod) EnumDescriptor() ([]byte, []int)

Deprecated: Use RequestMethod.Descriptor instead.

func (RequestMethod) Number 

func (x RequestMethod) Number() protoreflect.EnumNumber

func (RequestMethod) String 

func (x RequestMethod) String() string

func (RequestMethod) Type 

func (RequestMethod) Type() protoreflect.EnumType

type TcpHealthCheck 

type TcpHealthCheck struct {

	// Empty payloads imply a connect-only health check.
	Send *HealthCheckPayload `protobuf:"bytes,1,opt,name=send,proto3" json:"send,omitempty"`
	// When checking the response, “fuzzy” matching is performed such that each
	// binary block must be found, and in the order specified, but not
	// necessarily contiguous.
	Receive []*HealthCheckPayload `protobuf:"bytes,2,rep,name=receive,proto3" json:"receive,omitempty"`
	// contains filtered or unexported fields
}

func (*TcpHealthCheck) Descriptor deprecated 

func (*TcpHealthCheck) Descriptor() ([]byte, []int)

Deprecated: Use TcpHealthCheck.ProtoReflect.Descriptor instead.

func (*TcpHealthCheck) GetReceive 

func (x *TcpHealthCheck) GetReceive() []*HealthCheckPayload

func (*TcpHealthCheck) GetSend 

func (x *TcpHealthCheck) GetSend() *HealthCheckPayload

func (*TcpHealthCheck) ProtoMessage 

func (*TcpHealthCheck) ProtoMessage()

func (*TcpHealthCheck) ProtoReflect 

func (x *TcpHealthCheck) ProtoReflect() protoreflect.Message

func (*TcpHealthCheck) Reset 

func (x *TcpHealthCheck) Reset()

func (*TcpHealthCheck) String 

func (x *TcpHealthCheck) String() string

func (*TcpHealthCheck) Validate 

func (m *TcpHealthCheck) Validate() error

Validate checks the field values on TcpHealthCheck 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 (*TcpHealthCheck) ValidateAll 

func (m *TcpHealthCheck) ValidateAll() error

ValidateAll checks the field values on TcpHealthCheck 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 TcpHealthCheckMultiError, or nil if none found.

type TcpHealthCheckMultiError 

type TcpHealthCheckMultiError []error

TcpHealthCheckMultiError is an error wrapping multiple validation errors returned by TcpHealthCheck.ValidateAll() if the designated constraints aren't met.

func (TcpHealthCheckMultiError) AllErrors 

func (m TcpHealthCheckMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (TcpHealthCheckMultiError) Error 

func (m TcpHealthCheckMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type TcpHealthCheckValidationError 

type TcpHealthCheckValidationError struct {
	// contains filtered or unexported fields
}

TcpHealthCheckValidationError is the validation error returned by TcpHealthCheck.Validate if the designated constraints aren't met.

func (TcpHealthCheckValidationError) Cause 

func (e TcpHealthCheckValidationError) Cause() error

Cause function returns cause value.

func (TcpHealthCheckValidationError) Error 

func (e TcpHealthCheckValidationError) Error() string

Error satisfies the builtin error interface

func (TcpHealthCheckValidationError) ErrorName 

func (e TcpHealthCheckValidationError) ErrorName() string

ErrorName returns error name.

func (TcpHealthCheckValidationError) Field 

func (e TcpHealthCheckValidationError) Field() string

Field function returns field value.

func (TcpHealthCheckValidationError) Key 

func (e TcpHealthCheckValidationError) Key() bool

Key function returns key value.

func (TcpHealthCheckValidationError) Reason 

func (e TcpHealthCheckValidationError) Reason() string

Reason function returns reason value.

type TlsConfig added in v0.3.0 

type TlsConfig struct {

	// Enable TLS for healthcheck.
	Enable bool `protobuf:"varint,1,opt,name=enable,proto3" json:"enable,omitempty"`
	// The CA certificate to use for healthcheck. this is not necessary if the CA certificate is already in the system trust store.
	Ca string `protobuf:"bytes,2,opt,name=ca,proto3" json:"ca,omitempty"`
	// The server name to use for healthcheck. By default server name take the value of the fqdn entry
	ServerName string `protobuf:"bytes,3,opt,name=server_name,json=serverName,proto3" json:"server_name,omitempty"`
	// contains filtered or unexported fields
}

func (*TlsConfig) Descriptor deprecated added in v0.3.0 

func (*TlsConfig) Descriptor() ([]byte, []int)

Deprecated: Use TlsConfig.ProtoReflect.Descriptor instead.

func (*TlsConfig) GetCa added in v0.3.0 

func (x *TlsConfig) GetCa() string

func (*TlsConfig) GetEnable added in v0.3.0 

func (x *TlsConfig) GetEnable() bool

func (*TlsConfig) GetServerName added in v0.3.0 

func (x *TlsConfig) GetServerName() string

func (*TlsConfig) ProtoMessage added in v0.3.0 

func (*TlsConfig) ProtoMessage()

func (*TlsConfig) ProtoReflect added in v0.3.0 

func (x *TlsConfig) ProtoReflect() protoreflect.Message

func (*TlsConfig) Reset added in v0.3.0 

func (x *TlsConfig) Reset()

func (*TlsConfig) String added in v0.3.0 

func (x *TlsConfig) String() string

func (*TlsConfig) Validate added in v0.3.0 

func (m *TlsConfig) Validate() error

Validate checks the field values on TlsConfig 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 (*TlsConfig) ValidateAll added in v0.3.0 

func (m *TlsConfig) ValidateAll() error

ValidateAll checks the field values on TlsConfig 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 TlsConfigMultiError, or nil if none found.

type TlsConfigMultiError added in v0.3.0 

type TlsConfigMultiError []error

TlsConfigMultiError is an error wrapping multiple validation errors returned by TlsConfig.ValidateAll() if the designated constraints aren't met.

func (TlsConfigMultiError) AllErrors added in v0.3.0 

func (m TlsConfigMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (TlsConfigMultiError) Error added in v0.3.0 

func (m TlsConfigMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type TlsConfigValidationError added in v0.3.0 

type TlsConfigValidationError struct {
	// contains filtered or unexported fields
}

TlsConfigValidationError is the validation error returned by TlsConfig.Validate if the designated constraints aren't met.

func (TlsConfigValidationError) Cause added in v0.3.0 

func (e TlsConfigValidationError) Cause() error

Cause function returns cause value.

func (TlsConfigValidationError) Error added in v0.3.0 

func (e TlsConfigValidationError) Error() string

Error satisfies the builtin error interface

func (TlsConfigValidationError) ErrorName added in v0.3.0 

func (e TlsConfigValidationError) ErrorName() string

ErrorName returns error name.

func (TlsConfigValidationError) Field added in v0.3.0 

func (e TlsConfigValidationError) Field() string

Field function returns field value.

func (TlsConfigValidationError) Key added in v0.3.0 

func (e TlsConfigValidationError) Key() bool

Key function returns key value.

func (TlsConfigValidationError) Reason added in v0.3.0 

func (e TlsConfigValidationError) Reason() string

Reason function returns reason value.

type UdpHealthCheck added in v0.6.0 

type UdpHealthCheck struct {

	// Udp specific payload to send.
	// It always send something to test UDP connection.
	// If left empty (default to "test-gohc")
	Send *HealthCheckPayload `protobuf:"bytes,1,opt,name=send,proto3" json:"send,omitempty"`
	// When checking the response, “fuzzy” matching is performed such that each
	// binary block must be found, and in the order specified, but not
	// necessarily contiguous.
	Receive []*HealthCheckPayload `protobuf:"bytes,2,rep,name=receive,proto3" json:"receive,omitempty"`
	// PingTimeout specifies the timeout for ICMP requests. If left empty (default to 5s)
	PingTimeout *durationpb.Duration `protobuf:"bytes,3,opt,name=ping_timeout,json=pingTimeout,proto3" json:"ping_timeout,omitempty"`
	// Delay specifies the delay between ICMP requests. If left empty (default to 1s)
	Delay *durationpb.Duration `protobuf:"bytes,4,opt,name=delay,proto3" json:"delay,omitempty"`
	// contains filtered or unexported fields
}

UDP health check. It has 2 behaviors:

  • if receive is not empty, it will send the payload and check the response received by server with receive.
  • (Weak method) if receive is empty, it will ping the server if not responding it will be considered as unhealthy, if it's responding it will send the payload and wait to receive a Port Unreachable ICMP message, if not has been received after the timeout it will considered healthy.

func (*UdpHealthCheck) Descriptor deprecated added in v0.6.0 

func (*UdpHealthCheck) Descriptor() ([]byte, []int)

Deprecated: Use UdpHealthCheck.ProtoReflect.Descriptor instead.

func (*UdpHealthCheck) GetDelay added in v0.6.0 

func (x *UdpHealthCheck) GetDelay() *durationpb.Duration

func (*UdpHealthCheck) GetPingTimeout added in v0.6.0 

func (x *UdpHealthCheck) GetPingTimeout() *durationpb.Duration

func (*UdpHealthCheck) GetReceive added in v0.6.0 

func (x *UdpHealthCheck) GetReceive() []*HealthCheckPayload

func (*UdpHealthCheck) GetSend added in v0.6.0 

func (x *UdpHealthCheck) GetSend() *HealthCheckPayload

func (*UdpHealthCheck) ProtoMessage added in v0.6.0 

func (*UdpHealthCheck) ProtoMessage()

func (*UdpHealthCheck) ProtoReflect added in v0.6.0 

func (x *UdpHealthCheck) ProtoReflect() protoreflect.Message

func (*UdpHealthCheck) Reset added in v0.6.0 

func (x *UdpHealthCheck) Reset()

func (*UdpHealthCheck) String added in v0.6.0 

func (x *UdpHealthCheck) String() string

func (*UdpHealthCheck) Validate added in v0.6.0 

func (m *UdpHealthCheck) Validate() error

Validate checks the field values on UdpHealthCheck 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 (*UdpHealthCheck) ValidateAll added in v0.6.0 

func (m *UdpHealthCheck) ValidateAll() error

ValidateAll checks the field values on UdpHealthCheck 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 UdpHealthCheckMultiError, or nil if none found.

type UdpHealthCheckMultiError added in v0.6.0 

type UdpHealthCheckMultiError []error

UdpHealthCheckMultiError is an error wrapping multiple validation errors returned by UdpHealthCheck.ValidateAll() if the designated constraints aren't met.

func (UdpHealthCheckMultiError) AllErrors added in v0.6.0 

func (m UdpHealthCheckMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (UdpHealthCheckMultiError) Error added in v0.6.0 

func (m UdpHealthCheckMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type UdpHealthCheckValidationError added in v0.6.0 

type UdpHealthCheckValidationError struct {
	// contains filtered or unexported fields
}

UdpHealthCheckValidationError is the validation error returned by UdpHealthCheck.Validate if the designated constraints aren't met.

func (UdpHealthCheckValidationError) Cause added in v0.6.0 

func (e UdpHealthCheckValidationError) Cause() error

Cause function returns cause value.

func (UdpHealthCheckValidationError) Error added in v0.6.0 

func (e UdpHealthCheckValidationError) Error() string

Error satisfies the builtin error interface

func (UdpHealthCheckValidationError) ErrorName added in v0.6.0 

func (e UdpHealthCheckValidationError) ErrorName() string

ErrorName returns error name.

func (UdpHealthCheckValidationError) Field added in v0.6.0 

func (e UdpHealthCheckValidationError) Field() string

Field function returns field value.

func (UdpHealthCheckValidationError) Key added in v0.6.0 

func (e UdpHealthCheckValidationError) Key() bool

Key function returns key value.

func (UdpHealthCheckValidationError) Reason added in v0.6.0 

func (e UdpHealthCheckValidationError) Reason() string

Reason function returns reason value.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.