import "github.com/envoyproxy/go-control-plane/envoy/api/v2/core"
address.pb.go address.pb.validate.go backoff.pb.go backoff.pb.validate.go base.pb.go base.pb.validate.go config_source.pb.go config_source.pb.validate.go event_service_config.pb.go event_service_config.pb.validate.go grpc_method_list.pb.go grpc_method_list.pb.validate.go grpc_service.pb.go grpc_service.pb.validate.go health_check.pb.go health_check.pb.validate.go http_uri.pb.go http_uri.pb.validate.go protocol.pb.go protocol.pb.validate.go socket_option.pb.go socket_option.pb.validate.go
var (
SocketAddress_Protocol_name = map[int32]string{
0: "TCP",
1: "UDP",
}
SocketAddress_Protocol_value = map[string]int32{
"TCP": 0,
"UDP": 1,
}
)Enum value maps for SocketAddress_Protocol.
var (
RoutingPriority_name = map[int32]string{
0: "DEFAULT",
1: "HIGH",
}
RoutingPriority_value = map[string]int32{
"DEFAULT": 0,
"HIGH": 1,
}
)Enum value maps for RoutingPriority.
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.
var (
TrafficDirection_name = map[int32]string{
0: "UNSPECIFIED",
1: "INBOUND",
2: "OUTBOUND",
}
TrafficDirection_value = map[string]int32{
"UNSPECIFIED": 0,
"INBOUND": 1,
"OUTBOUND": 2,
}
)Enum value maps for TrafficDirection.
var (
ApiVersion_name = map[int32]string{
0: "AUTO",
1: "V2",
2: "V3",
}
ApiVersion_value = map[string]int32{
"AUTO": 0,
"V2": 1,
"V3": 2,
}
)Enum value maps for ApiVersion.
var (
ApiConfigSource_ApiType_name = map[int32]string{
0: "UNSUPPORTED_REST_LEGACY",
1: "REST",
2: "GRPC",
3: "DELTA_GRPC",
}
ApiConfigSource_ApiType_value = map[string]int32{
"UNSUPPORTED_REST_LEGACY": 0,
"REST": 1,
"GRPC": 2,
"DELTA_GRPC": 3,
}
)Enum value maps for ApiConfigSource_ApiType.
var (
HealthStatus_name = map[int32]string{
0: "UNKNOWN",
1: "HEALTHY",
2: "UNHEALTHY",
3: "DRAINING",
4: "TIMEOUT",
5: "DEGRADED",
}
HealthStatus_value = map[string]int32{
"UNKNOWN": 0,
"HEALTHY": 1,
"UNHEALTHY": 2,
"DRAINING": 3,
"TIMEOUT": 4,
"DEGRADED": 5,
}
)Enum value maps for HealthStatus.
var (
HttpProtocolOptions_HeadersWithUnderscoresAction_name = map[int32]string{
0: "ALLOW",
1: "REJECT_REQUEST",
2: "DROP_HEADER",
}
HttpProtocolOptions_HeadersWithUnderscoresAction_value = map[string]int32{
"ALLOW": 0,
"REJECT_REQUEST": 1,
"DROP_HEADER": 2,
}
)Enum value maps for HttpProtocolOptions_HeadersWithUnderscoresAction.
var (
SocketOption_SocketState_name = map[int32]string{
0: "STATE_PREBIND",
1: "STATE_BOUND",
2: "STATE_LISTENING",
}
SocketOption_SocketState_value = map[string]int32{
"STATE_PREBIND": 0,
"STATE_BOUND": 1,
"STATE_LISTENING": 2,
}
)Enum value maps for SocketOption_SocketState.
var File_envoy_api_v2_core_address_proto protoreflect.FileDescriptor
var File_envoy_api_v2_core_backoff_proto protoreflect.FileDescriptor
var File_envoy_api_v2_core_base_proto protoreflect.FileDescriptor
var File_envoy_api_v2_core_config_source_proto protoreflect.FileDescriptor
var File_envoy_api_v2_core_event_service_config_proto protoreflect.FileDescriptor
var File_envoy_api_v2_core_grpc_method_list_proto protoreflect.FileDescriptor
var File_envoy_api_v2_core_grpc_service_proto protoreflect.FileDescriptor
var File_envoy_api_v2_core_health_check_proto protoreflect.FileDescriptor
var File_envoy_api_v2_core_http_uri_proto protoreflect.FileDescriptor
var File_envoy_api_v2_core_protocol_proto protoreflect.FileDescriptor
var File_envoy_api_v2_core_socket_option_proto protoreflect.FileDescriptor
type Address struct {
// Types that are assignable to Address:
// *Address_SocketAddress
// *Address_Pipe
Address isAddress_Address `protobuf_oneof:"address"`
// contains filtered or unexported fields
}Addresses specify either a logical or physical address and port, which are used to tell Envoy where to bind/listen, connect to upstream and find management servers.
Deprecated: Use Address.ProtoReflect.Descriptor instead.
func (x *Address) GetSocketAddress() *SocketAddress
func (x *Address) ProtoReflect() protoreflect.Message
Validate checks the field values on Address with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type AddressValidationError struct {
// contains filtered or unexported fields
}AddressValidationError is the validation error returned by Address.Validate if the designated constraints aren't met.
func (e AddressValidationError) Cause() error
Cause function returns cause value.
func (e AddressValidationError) Error() string
Error satisfies the builtin error interface
func (e AddressValidationError) ErrorName() string
ErrorName returns error name.
func (e AddressValidationError) Field() string
Field function returns field value.
func (e AddressValidationError) Key() bool
Key function returns key value.
func (e AddressValidationError) Reason() string
Reason function returns reason value.
type Address_SocketAddress struct {
SocketAddress *SocketAddress `protobuf:"bytes,1,opt,name=socket_address,json=socketAddress,proto3,oneof"`
}type AggregatedConfigSource struct {
// contains filtered or unexported fields
}Aggregated Discovery Service (ADS) options. This is currently empty, but when set in :ref:`ConfigSource <envoy_api_msg_core.ConfigSource>` can be used to specify that ADS is to be used.
func (*AggregatedConfigSource) Descriptor() ([]byte, []int)
Deprecated: Use AggregatedConfigSource.ProtoReflect.Descriptor instead.
func (*AggregatedConfigSource) ProtoMessage()
func (x *AggregatedConfigSource) ProtoReflect() protoreflect.Message
func (x *AggregatedConfigSource) Reset()
func (x *AggregatedConfigSource) String() string
func (m *AggregatedConfigSource) Validate() error
Validate checks the field values on AggregatedConfigSource with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type AggregatedConfigSourceValidationError struct {
// contains filtered or unexported fields
}AggregatedConfigSourceValidationError is the validation error returned by AggregatedConfigSource.Validate if the designated constraints aren't met.
func (e AggregatedConfigSourceValidationError) Cause() error
Cause function returns cause value.
func (e AggregatedConfigSourceValidationError) Error() string
Error satisfies the builtin error interface
func (e AggregatedConfigSourceValidationError) ErrorName() string
ErrorName returns error name.
func (e AggregatedConfigSourceValidationError) Field() string
Field function returns field value.
func (e AggregatedConfigSourceValidationError) Key() bool
Key function returns key value.
func (e AggregatedConfigSourceValidationError) Reason() string
Reason function returns reason value.
type ApiConfigSource struct {
// API type (gRPC, REST, delta gRPC)
ApiType ApiConfigSource_ApiType `protobuf:"varint,1,opt,name=api_type,json=apiType,proto3,enum=envoy.api.v2.core.ApiConfigSource_ApiType" json:"api_type,omitempty"`
// API version for xDS transport protocol. This describes the xDS gRPC/REST
// endpoint and version of [Delta]DiscoveryRequest/Response used on the wire.
TransportApiVersion ApiVersion `protobuf:"varint,8,opt,name=transport_api_version,json=transportApiVersion,proto3,enum=envoy.api.v2.core.ApiVersion" json:"transport_api_version,omitempty"`
// Cluster names should be used only with REST. If > 1
// cluster is defined, clusters will be cycled through if any kind of failure
// occurs.
//
// .. note::
//
// The cluster with name ``cluster_name`` must be statically defined and its
// type must not be ``EDS``.
ClusterNames []string `protobuf:"bytes,2,rep,name=cluster_names,json=clusterNames,proto3" json:"cluster_names,omitempty"`
// Multiple gRPC services be provided for GRPC. If > 1 cluster is defined,
// services will be cycled through if any kind of failure occurs.
GrpcServices []*GrpcService `protobuf:"bytes,4,rep,name=grpc_services,json=grpcServices,proto3" json:"grpc_services,omitempty"`
// For REST APIs, the delay between successive polls.
RefreshDelay *duration.Duration `protobuf:"bytes,3,opt,name=refresh_delay,json=refreshDelay,proto3" json:"refresh_delay,omitempty"`
// For REST APIs, the request timeout. If not set, a default value of 1s will be used.
RequestTimeout *duration.Duration `protobuf:"bytes,5,opt,name=request_timeout,json=requestTimeout,proto3" json:"request_timeout,omitempty"`
// For GRPC APIs, the rate limit settings. If present, discovery requests made by Envoy will be
// rate limited.
RateLimitSettings *RateLimitSettings `protobuf:"bytes,6,opt,name=rate_limit_settings,json=rateLimitSettings,proto3" json:"rate_limit_settings,omitempty"`
// Skip the node identifier in subsequent discovery requests for streaming gRPC config types.
SetNodeOnFirstMessageOnly bool `protobuf:"varint,7,opt,name=set_node_on_first_message_only,json=setNodeOnFirstMessageOnly,proto3" json:"set_node_on_first_message_only,omitempty"`
// contains filtered or unexported fields
}API configuration source. This identifies the API type and cluster that Envoy will use to fetch an xDS API. [#next-free-field: 9]
func (*ApiConfigSource) Descriptor() ([]byte, []int)
Deprecated: Use ApiConfigSource.ProtoReflect.Descriptor instead.
func (x *ApiConfigSource) GetApiType() ApiConfigSource_ApiType
func (x *ApiConfigSource) GetClusterNames() []string
func (x *ApiConfigSource) GetGrpcServices() []*GrpcService
func (x *ApiConfigSource) GetRateLimitSettings() *RateLimitSettings
func (x *ApiConfigSource) GetRefreshDelay() *duration.Duration
func (x *ApiConfigSource) GetRequestTimeout() *duration.Duration
func (x *ApiConfigSource) GetSetNodeOnFirstMessageOnly() bool
func (x *ApiConfigSource) GetTransportApiVersion() ApiVersion
func (*ApiConfigSource) ProtoMessage()
func (x *ApiConfigSource) ProtoReflect() protoreflect.Message
func (x *ApiConfigSource) Reset()
func (x *ApiConfigSource) String() string
func (m *ApiConfigSource) Validate() error
Validate checks the field values on ApiConfigSource with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type ApiConfigSourceValidationError struct {
// contains filtered or unexported fields
}ApiConfigSourceValidationError is the validation error returned by ApiConfigSource.Validate if the designated constraints aren't met.
func (e ApiConfigSourceValidationError) Cause() error
Cause function returns cause value.
func (e ApiConfigSourceValidationError) Error() string
Error satisfies the builtin error interface
func (e ApiConfigSourceValidationError) ErrorName() string
ErrorName returns error name.
func (e ApiConfigSourceValidationError) Field() string
Field function returns field value.
func (e ApiConfigSourceValidationError) Key() bool
Key function returns key value.
func (e ApiConfigSourceValidationError) Reason() string
Reason function returns reason value.
APIs may be fetched via either REST or gRPC.
const (
// Ideally this would be 'reserved 0' but one can't reserve the default
// value. Instead we throw an exception if this is ever used.
//
// Deprecated: Do not use.
ApiConfigSource_UNSUPPORTED_REST_LEGACY ApiConfigSource_ApiType = 0
// REST-JSON v2 API. The `canonical JSON encoding
// <https://developers.google.com/protocol-buffers/docs/proto3#json>`_ for
// the v2 protos is used.
ApiConfigSource_REST ApiConfigSource_ApiType = 1
// gRPC v2 API.
ApiConfigSource_GRPC ApiConfigSource_ApiType = 2
// Using the delta xDS gRPC service, i.e. DeltaDiscovery{Request,Response}
// rather than Discovery{Request,Response}. Rather than sending Envoy the entire state
// with every update, the xDS server only sends what has changed since the last update.
ApiConfigSource_DELTA_GRPC ApiConfigSource_ApiType = 3
)func (ApiConfigSource_ApiType) Descriptor() protoreflect.EnumDescriptor
func (x ApiConfigSource_ApiType) Enum() *ApiConfigSource_ApiType
func (ApiConfigSource_ApiType) EnumDescriptor() ([]byte, []int)
Deprecated: Use ApiConfigSource_ApiType.Descriptor instead.
func (x ApiConfigSource_ApiType) Number() protoreflect.EnumNumber
func (x ApiConfigSource_ApiType) String() string
func (ApiConfigSource_ApiType) Type() protoreflect.EnumType
xDS API version. This is used to describe both resource and transport protocol versions (in distinct configuration fields).
const (
// When not specified, we assume v2, to ease migration to Envoy's stable API
// versioning. If a client does not support v2 (e.g. due to deprecation), this
// is an invalid value.
//
// Deprecated: Do not use.
ApiVersion_AUTO ApiVersion = 0
// Use xDS v2 API.
//
// Deprecated: Do not use.
ApiVersion_V2 ApiVersion = 1
// Use xDS v3 API.
ApiVersion_V3 ApiVersion = 2
)func (ApiVersion) Descriptor() protoreflect.EnumDescriptor
func (x ApiVersion) Enum() *ApiVersion
func (ApiVersion) EnumDescriptor() ([]byte, []int)
Deprecated: Use ApiVersion.Descriptor instead.
func (x ApiVersion) Number() protoreflect.EnumNumber
func (x ApiVersion) String() string
func (ApiVersion) Type() protoreflect.EnumType
type AsyncDataSource struct {
// Types that are assignable to Specifier:
// *AsyncDataSource_Local
// *AsyncDataSource_Remote
Specifier isAsyncDataSource_Specifier `protobuf_oneof:"specifier"`
// contains filtered or unexported fields
}Async data source which support async data fetch.
func (*AsyncDataSource) Descriptor() ([]byte, []int)
Deprecated: Use AsyncDataSource.ProtoReflect.Descriptor instead.
func (x *AsyncDataSource) GetLocal() *DataSource
func (x *AsyncDataSource) GetRemote() *RemoteDataSource
func (m *AsyncDataSource) GetSpecifier() isAsyncDataSource_Specifier
func (*AsyncDataSource) ProtoMessage()
func (x *AsyncDataSource) ProtoReflect() protoreflect.Message
func (x *AsyncDataSource) Reset()
func (x *AsyncDataSource) String() string
func (m *AsyncDataSource) Validate() error
Validate checks the field values on AsyncDataSource with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type AsyncDataSourceValidationError struct {
// contains filtered or unexported fields
}AsyncDataSourceValidationError is the validation error returned by AsyncDataSource.Validate if the designated constraints aren't met.
func (e AsyncDataSourceValidationError) Cause() error
Cause function returns cause value.
func (e AsyncDataSourceValidationError) Error() string
Error satisfies the builtin error interface
func (e AsyncDataSourceValidationError) ErrorName() string
ErrorName returns error name.
func (e AsyncDataSourceValidationError) Field() string
Field function returns field value.
func (e AsyncDataSourceValidationError) Key() bool
Key function returns key value.
func (e AsyncDataSourceValidationError) Reason() string
Reason function returns reason value.
type AsyncDataSource_Local struct {
// Local async data source.
Local *DataSource `protobuf:"bytes,1,opt,name=local,proto3,oneof"`
}type AsyncDataSource_Remote struct {
// Remote async data source.
Remote *RemoteDataSource `protobuf:"bytes,2,opt,name=remote,proto3,oneof"`
}type BackoffStrategy struct {
// The base interval to be used for the next back off computation. It should
// be greater than zero and less than or equal to :ref:`max_interval
// <envoy_api_field_core.BackoffStrategy.max_interval>`.
BaseInterval *duration.Duration `protobuf:"bytes,1,opt,name=base_interval,json=baseInterval,proto3" json:"base_interval,omitempty"`
// Specifies the maximum interval between retries. This parameter is optional,
// but must be greater than or equal to the :ref:`base_interval
// <envoy_api_field_core.BackoffStrategy.base_interval>` if set. The default
// is 10 times the :ref:`base_interval
// <envoy_api_field_core.BackoffStrategy.base_interval>`.
MaxInterval *duration.Duration `protobuf:"bytes,2,opt,name=max_interval,json=maxInterval,proto3" json:"max_interval,omitempty"`
// contains filtered or unexported fields
}Configuration defining a jittered exponential back off strategy.
func (*BackoffStrategy) Descriptor() ([]byte, []int)
Deprecated: Use BackoffStrategy.ProtoReflect.Descriptor instead.
func (x *BackoffStrategy) GetBaseInterval() *duration.Duration
func (x *BackoffStrategy) GetMaxInterval() *duration.Duration
func (*BackoffStrategy) ProtoMessage()
func (x *BackoffStrategy) ProtoReflect() protoreflect.Message
func (x *BackoffStrategy) Reset()
func (x *BackoffStrategy) String() string
func (m *BackoffStrategy) Validate() error
Validate checks the field values on BackoffStrategy with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type BackoffStrategyValidationError struct {
// contains filtered or unexported fields
}BackoffStrategyValidationError is the validation error returned by BackoffStrategy.Validate if the designated constraints aren't met.
func (e BackoffStrategyValidationError) Cause() error
Cause function returns cause value.
func (e BackoffStrategyValidationError) Error() string
Error satisfies the builtin error interface
func (e BackoffStrategyValidationError) ErrorName() string
ErrorName returns error name.
func (e BackoffStrategyValidationError) Field() string
Field function returns field value.
func (e BackoffStrategyValidationError) Key() bool
Key function returns key value.
func (e BackoffStrategyValidationError) Reason() string
Reason function returns reason value.
type BindConfig struct {
// The address to bind to when creating a socket.
SourceAddress *SocketAddress `protobuf:"bytes,1,opt,name=source_address,json=sourceAddress,proto3" json:"source_address,omitempty"`
// Whether to set the *IP_FREEBIND* option when creating the socket. When this
// flag is set to true, allows the :ref:`source_address
// <envoy_api_field_UpstreamBindConfig.source_address>` to be an IP address
// that is not configured on the system running Envoy. When this flag is set
// to false, the option *IP_FREEBIND* is disabled on the socket. When this
// flag is not set (default), the socket is not modified, i.e. the option is
// neither enabled nor disabled.
Freebind *wrappers.BoolValue `protobuf:"bytes,2,opt,name=freebind,proto3" json:"freebind,omitempty"`
// Additional socket options that may not be present in Envoy source code or
// precompiled binaries.
SocketOptions []*SocketOption `protobuf:"bytes,3,rep,name=socket_options,json=socketOptions,proto3" json:"socket_options,omitempty"`
// contains filtered or unexported fields
}func (*BindConfig) Descriptor() ([]byte, []int)
Deprecated: Use BindConfig.ProtoReflect.Descriptor instead.
func (x *BindConfig) GetFreebind() *wrappers.BoolValue
func (x *BindConfig) GetSocketOptions() []*SocketOption
func (x *BindConfig) GetSourceAddress() *SocketAddress
func (*BindConfig) ProtoMessage()
func (x *BindConfig) ProtoReflect() protoreflect.Message
func (x *BindConfig) Reset()
func (x *BindConfig) String() string
func (m *BindConfig) Validate() error
Validate checks the field values on BindConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type BindConfigValidationError struct {
// contains filtered or unexported fields
}BindConfigValidationError is the validation error returned by BindConfig.Validate if the designated constraints aren't met.
func (e BindConfigValidationError) Cause() error
Cause function returns cause value.
func (e BindConfigValidationError) Error() string
Error satisfies the builtin error interface
func (e BindConfigValidationError) ErrorName() string
ErrorName returns error name.
func (e BindConfigValidationError) Field() string
Field function returns field value.
func (e BindConfigValidationError) Key() bool
Key function returns key value.
func (e BindConfigValidationError) Reason() string
Reason function returns reason value.
type BuildVersion struct {
// SemVer version of extension.
Version *_type.SemanticVersion `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
// Free-form build information.
// Envoy defines several well known keys in the source/common/version/version.h file
Metadata *_struct.Struct `protobuf:"bytes,2,opt,name=metadata,proto3" json:"metadata,omitempty"`
// contains filtered or unexported fields
}BuildVersion combines SemVer version of extension with free-form build information (i.e. 'alpha', 'private-build') as a set of strings.
func (*BuildVersion) Descriptor() ([]byte, []int)
Deprecated: Use BuildVersion.ProtoReflect.Descriptor instead.
func (x *BuildVersion) GetMetadata() *_struct.Struct
func (x *BuildVersion) GetVersion() *_type.SemanticVersion
func (*BuildVersion) ProtoMessage()
func (x *BuildVersion) ProtoReflect() protoreflect.Message
func (x *BuildVersion) Reset()
func (x *BuildVersion) String() string
func (m *BuildVersion) Validate() error
Validate checks the field values on BuildVersion with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type BuildVersionValidationError struct {
// contains filtered or unexported fields
}BuildVersionValidationError is the validation error returned by BuildVersion.Validate if the designated constraints aren't met.
func (e BuildVersionValidationError) Cause() error
Cause function returns cause value.
func (e BuildVersionValidationError) Error() string
Error satisfies the builtin error interface
func (e BuildVersionValidationError) ErrorName() string
ErrorName returns error name.
func (e BuildVersionValidationError) Field() string
Field function returns field value.
func (e BuildVersionValidationError) Key() bool
Key function returns key value.
func (e BuildVersionValidationError) Reason() string
Reason function returns reason value.
type CidrRange struct {
// IPv4 or IPv6 address, e.g. ``192.0.0.0`` or ``2001:db8::``.
AddressPrefix string `protobuf:"bytes,1,opt,name=address_prefix,json=addressPrefix,proto3" json:"address_prefix,omitempty"`
// Length of prefix, e.g. 0, 32.
PrefixLen *wrappers.UInt32Value `protobuf:"bytes,2,opt,name=prefix_len,json=prefixLen,proto3" json:"prefix_len,omitempty"`
// contains filtered or unexported fields
}CidrRange specifies an IP Address and a prefix length to construct the subnet mask for a `CIDR <https://tools.ietf.org/html/rfc4632>`_ range.
Deprecated: Use CidrRange.ProtoReflect.Descriptor instead.
func (x *CidrRange) GetPrefixLen() *wrappers.UInt32Value
func (x *CidrRange) ProtoReflect() protoreflect.Message
Validate checks the field values on CidrRange with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type CidrRangeValidationError struct {
// contains filtered or unexported fields
}CidrRangeValidationError is the validation error returned by CidrRange.Validate if the designated constraints aren't met.
func (e CidrRangeValidationError) Cause() error
Cause function returns cause value.
func (e CidrRangeValidationError) Error() string
Error satisfies the builtin error interface
func (e CidrRangeValidationError) ErrorName() string
ErrorName returns error name.
func (e CidrRangeValidationError) Field() string
Field function returns field value.
func (e CidrRangeValidationError) Key() bool
Key function returns key value.
func (e CidrRangeValidationError) Reason() string
Reason function returns reason value.
type ConfigSource struct {
// Types that are assignable to ConfigSourceSpecifier:
// *ConfigSource_Path
// *ConfigSource_ApiConfigSource
// *ConfigSource_Ads
// *ConfigSource_Self
ConfigSourceSpecifier isConfigSource_ConfigSourceSpecifier `protobuf_oneof:"config_source_specifier"`
// When this timeout is specified, Envoy will wait no longer than the specified time for first
// config response on this xDS subscription during the :ref:`initialization process
// <arch_overview_initialization>`. After reaching the timeout, Envoy will move to the next
// initialization phase, even if the first config is not delivered yet. The timer is activated
// when the xDS API subscription starts, and is disarmed on first config update or on error. 0
// means no timeout - Envoy will wait indefinitely for the first xDS config (unless another
// timeout applies). The default is 15s.
InitialFetchTimeout *duration.Duration `protobuf:"bytes,4,opt,name=initial_fetch_timeout,json=initialFetchTimeout,proto3" json:"initial_fetch_timeout,omitempty"`
// API version for xDS resources. This implies the type URLs that the client
// will request for resources and the resource type that the client will in
// turn expect to be delivered.
ResourceApiVersion ApiVersion `protobuf:"varint,6,opt,name=resource_api_version,json=resourceApiVersion,proto3,enum=envoy.api.v2.core.ApiVersion" json:"resource_api_version,omitempty"`
// contains filtered or unexported fields
}Configuration for :ref:`listeners <config_listeners>`, :ref:`clusters <config_cluster_manager>`, :ref:`routes <envoy_api_msg_RouteConfiguration>`, :ref:`endpoints <arch_overview_service_discovery>` etc. may either be sourced from the filesystem or from an xDS API source. Filesystem configs are watched with inotify for updates. [#next-free-field: 7]
func (*ConfigSource) Descriptor() ([]byte, []int)
Deprecated: Use ConfigSource.ProtoReflect.Descriptor instead.
func (x *ConfigSource) GetAds() *AggregatedConfigSource
func (x *ConfigSource) GetApiConfigSource() *ApiConfigSource
func (m *ConfigSource) GetConfigSourceSpecifier() isConfigSource_ConfigSourceSpecifier
func (x *ConfigSource) GetInitialFetchTimeout() *duration.Duration
func (x *ConfigSource) GetPath() string
func (x *ConfigSource) GetResourceApiVersion() ApiVersion
func (x *ConfigSource) GetSelf() *SelfConfigSource
func (*ConfigSource) ProtoMessage()
func (x *ConfigSource) ProtoReflect() protoreflect.Message
func (x *ConfigSource) Reset()
func (x *ConfigSource) String() string
func (m *ConfigSource) Validate() error
Validate checks the field values on ConfigSource with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type ConfigSourceValidationError struct {
// contains filtered or unexported fields
}ConfigSourceValidationError is the validation error returned by ConfigSource.Validate if the designated constraints aren't met.
func (e ConfigSourceValidationError) Cause() error
Cause function returns cause value.
func (e ConfigSourceValidationError) Error() string
Error satisfies the builtin error interface
func (e ConfigSourceValidationError) ErrorName() string
ErrorName returns error name.
func (e ConfigSourceValidationError) Field() string
Field function returns field value.
func (e ConfigSourceValidationError) Key() bool
Key function returns key value.
func (e ConfigSourceValidationError) Reason() string
Reason function returns reason value.
type ConfigSource_Ads struct {
// When set, ADS will be used to fetch resources. The ADS API configuration
// source in the bootstrap configuration is used.
Ads *AggregatedConfigSource `protobuf:"bytes,3,opt,name=ads,proto3,oneof"`
}type ConfigSource_ApiConfigSource struct {
// API configuration source.
ApiConfigSource *ApiConfigSource `protobuf:"bytes,2,opt,name=api_config_source,json=apiConfigSource,proto3,oneof"`
}type ConfigSource_Path struct {
// Path on the filesystem to source and watch for configuration updates.
// When sourcing configuration for :ref:`secret <envoy_api_msg_auth.Secret>`,
// the certificate and key files are also watched for updates.
//
// .. note::
//
// The path to the source must exist at config load time.
//
// .. note::
//
// Envoy will only watch the file path for *moves.* This is because in general only moves
// are atomic. The same method of swapping files as is demonstrated in the
// :ref:`runtime documentation <config_runtime_symbolic_link_swap>` can be used here also.
Path string `protobuf:"bytes,1,opt,name=path,proto3,oneof"`
}type ConfigSource_Self struct {
// [#not-implemented-hide:]
// When set, the client will access the resources from the same server it got the
// ConfigSource from, although not necessarily from the same stream. This is similar to the
// :ref:`ads<envoy_api_field.ConfigSource.ads>` field, except that the client may use a
// different stream to the same server. As a result, this field can be used for things
// like LRS that cannot be sent on an ADS stream. It can also be used to link from (e.g.)
// LDS to RDS on the same server without requiring the management server to know its name
// or required credentials.
// [#next-major-version: In xDS v3, consider replacing the ads field with this one, since
// this field can implicitly mean to use the same stream in the case where the ConfigSource
// is provided via ADS and the specified data can also be obtained via ADS.]
Self *SelfConfigSource `protobuf:"bytes,5,opt,name=self,proto3,oneof"`
}type ControlPlane struct {
// An opaque control plane identifier that uniquely identifies an instance
// of control plane. This can be used to identify which control plane instance,
// the Envoy is connected to.
Identifier string `protobuf:"bytes,1,opt,name=identifier,proto3" json:"identifier,omitempty"`
// contains filtered or unexported fields
}Identifies a specific ControlPlane instance that Envoy is connected to.
func (*ControlPlane) Descriptor() ([]byte, []int)
Deprecated: Use ControlPlane.ProtoReflect.Descriptor instead.
func (x *ControlPlane) GetIdentifier() string
func (*ControlPlane) ProtoMessage()
func (x *ControlPlane) ProtoReflect() protoreflect.Message
func (x *ControlPlane) Reset()
func (x *ControlPlane) String() string
func (m *ControlPlane) Validate() error
Validate checks the field values on ControlPlane with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type ControlPlaneValidationError struct {
// contains filtered or unexported fields
}ControlPlaneValidationError is the validation error returned by ControlPlane.Validate if the designated constraints aren't met.
func (e ControlPlaneValidationError) Cause() error
Cause function returns cause value.
func (e ControlPlaneValidationError) Error() string
Error satisfies the builtin error interface
func (e ControlPlaneValidationError) ErrorName() string
ErrorName returns error name.
func (e ControlPlaneValidationError) Field() string
Field function returns field value.
func (e ControlPlaneValidationError) Key() bool
Key function returns key value.
func (e ControlPlaneValidationError) Reason() string
Reason function returns reason value.
type DataSource struct {
// Types that are assignable to Specifier:
// *DataSource_Filename
// *DataSource_InlineBytes
// *DataSource_InlineString
Specifier isDataSource_Specifier `protobuf_oneof:"specifier"`
// contains filtered or unexported fields
}Data source consisting of either a file or an inline value.
func (*DataSource) Descriptor() ([]byte, []int)
Deprecated: Use DataSource.ProtoReflect.Descriptor instead.
func (x *DataSource) GetFilename() string
func (x *DataSource) GetInlineBytes() []byte
func (x *DataSource) GetInlineString() string
func (m *DataSource) GetSpecifier() isDataSource_Specifier
func (*DataSource) ProtoMessage()
func (x *DataSource) ProtoReflect() protoreflect.Message
func (x *DataSource) Reset()
func (x *DataSource) String() string
func (m *DataSource) Validate() error
Validate checks the field values on DataSource with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type DataSourceValidationError struct {
// contains filtered or unexported fields
}DataSourceValidationError is the validation error returned by DataSource.Validate if the designated constraints aren't met.
func (e DataSourceValidationError) Cause() error
Cause function returns cause value.
func (e DataSourceValidationError) Error() string
Error satisfies the builtin error interface
func (e DataSourceValidationError) ErrorName() string
ErrorName returns error name.
func (e DataSourceValidationError) Field() string
Field function returns field value.
func (e DataSourceValidationError) Key() bool
Key function returns key value.
func (e DataSourceValidationError) Reason() string
Reason function returns reason value.
type DataSource_Filename struct {
// Local filesystem data source.
Filename string `protobuf:"bytes,1,opt,name=filename,proto3,oneof"`
}type DataSource_InlineBytes struct {
// Bytes inlined in the configuration.
InlineBytes []byte `protobuf:"bytes,2,opt,name=inline_bytes,json=inlineBytes,proto3,oneof"`
}type DataSource_InlineString struct {
// String inlined in the configuration.
InlineString string `protobuf:"bytes,3,opt,name=inline_string,json=inlineString,proto3,oneof"`
}type EventServiceConfig struct {
// Types that are assignable to ConfigSourceSpecifier:
// *EventServiceConfig_GrpcService
ConfigSourceSpecifier isEventServiceConfig_ConfigSourceSpecifier `protobuf_oneof:"config_source_specifier"`
// contains filtered or unexported fields
}[#not-implemented-hide:] Configuration of the event reporting service endpoint.
func (*EventServiceConfig) Descriptor() ([]byte, []int)
Deprecated: Use EventServiceConfig.ProtoReflect.Descriptor instead.
func (m *EventServiceConfig) GetConfigSourceSpecifier() isEventServiceConfig_ConfigSourceSpecifier
func (x *EventServiceConfig) GetGrpcService() *GrpcService
func (*EventServiceConfig) ProtoMessage()
func (x *EventServiceConfig) ProtoReflect() protoreflect.Message
func (x *EventServiceConfig) Reset()
func (x *EventServiceConfig) String() string
func (m *EventServiceConfig) Validate() error
Validate checks the field values on EventServiceConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type EventServiceConfigValidationError struct {
// contains filtered or unexported fields
}EventServiceConfigValidationError is the validation error returned by EventServiceConfig.Validate if the designated constraints aren't met.
func (e EventServiceConfigValidationError) Cause() error
Cause function returns cause value.
func (e EventServiceConfigValidationError) Error() string
Error satisfies the builtin error interface
func (e EventServiceConfigValidationError) ErrorName() string
ErrorName returns error name.
func (e EventServiceConfigValidationError) Field() string
Field function returns field value.
func (e EventServiceConfigValidationError) Key() bool
Key function returns key value.
func (e EventServiceConfigValidationError) Reason() string
Reason function returns reason value.
type EventServiceConfig_GrpcService struct {
// Specifies the gRPC service that hosts the event reporting service.
GrpcService *GrpcService `protobuf:"bytes,1,opt,name=grpc_service,json=grpcService,proto3,oneof"`
}type Extension struct {
// This is the name of the Envoy filter as specified in the Envoy
// configuration, e.g. envoy.filters.http.router, com.acme.widget.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Category of the extension.
// Extension category names use reverse DNS notation. For instance "envoy.filters.listener"
// for Envoy's built-in listener filters or "com.acme.filters.http" for HTTP filters from
// acme.com vendor.
// [#comment:TODO(yanavlasov): Link to the doc with existing envoy category names.]
Category string `protobuf:"bytes,2,opt,name=category,proto3" json:"category,omitempty"`
// [#not-implemented-hide:] Type descriptor of extension configuration proto.
// [#comment:TODO(yanavlasov): Link to the doc with existing configuration protos.]
// [#comment:TODO(yanavlasov): Add tests when PR #9391 lands.]
TypeDescriptor string `protobuf:"bytes,3,opt,name=type_descriptor,json=typeDescriptor,proto3" json:"type_descriptor,omitempty"`
// The version is a property of the extension and maintained independently
// of other extensions and the Envoy API.
// This field is not set when extension did not provide version information.
Version *BuildVersion `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
// Indicates that the extension is present but was disabled via dynamic configuration.
Disabled bool `protobuf:"varint,5,opt,name=disabled,proto3" json:"disabled,omitempty"`
// contains filtered or unexported fields
}Version and identification for an Envoy extension. [#next-free-field: 6]
Deprecated: Use Extension.ProtoReflect.Descriptor instead.
func (x *Extension) GetVersion() *BuildVersion
func (x *Extension) ProtoReflect() protoreflect.Message
Validate checks the field values on Extension with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type ExtensionValidationError struct {
// contains filtered or unexported fields
}ExtensionValidationError is the validation error returned by Extension.Validate if the designated constraints aren't met.
func (e ExtensionValidationError) Cause() error
Cause function returns cause value.
func (e ExtensionValidationError) Error() string
Error satisfies the builtin error interface
func (e ExtensionValidationError) ErrorName() string
ErrorName returns error name.
func (e ExtensionValidationError) Field() string
Field function returns field value.
func (e ExtensionValidationError) Key() bool
Key function returns key value.
func (e ExtensionValidationError) Reason() string
Reason function returns reason value.
type GrpcMethodList struct {
Services []*GrpcMethodList_Service `protobuf:"bytes,1,rep,name=services,proto3" json:"services,omitempty"`
// contains filtered or unexported fields
}A list of gRPC methods which can be used as an allowlist, for example.
func (*GrpcMethodList) Descriptor() ([]byte, []int)
Deprecated: Use GrpcMethodList.ProtoReflect.Descriptor instead.
func (x *GrpcMethodList) GetServices() []*GrpcMethodList_Service
func (*GrpcMethodList) ProtoMessage()
func (x *GrpcMethodList) ProtoReflect() protoreflect.Message
func (x *GrpcMethodList) Reset()
func (x *GrpcMethodList) String() string
func (m *GrpcMethodList) Validate() error
Validate checks the field values on GrpcMethodList with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type GrpcMethodListValidationError struct {
// contains filtered or unexported fields
}GrpcMethodListValidationError is the validation error returned by GrpcMethodList.Validate if the designated constraints aren't met.
func (e GrpcMethodListValidationError) Cause() error
Cause function returns cause value.
func (e GrpcMethodListValidationError) Error() string
Error satisfies the builtin error interface
func (e GrpcMethodListValidationError) ErrorName() string
ErrorName returns error name.
func (e GrpcMethodListValidationError) Field() string
Field function returns field value.
func (e GrpcMethodListValidationError) Key() bool
Key function returns key value.
func (e GrpcMethodListValidationError) Reason() string
Reason function returns reason value.
type GrpcMethodList_Service struct {
// The name of the gRPC service.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The names of the gRPC methods in this service.
MethodNames []string `protobuf:"bytes,2,rep,name=method_names,json=methodNames,proto3" json:"method_names,omitempty"`
// contains filtered or unexported fields
}func (*GrpcMethodList_Service) Descriptor() ([]byte, []int)
Deprecated: Use GrpcMethodList_Service.ProtoReflect.Descriptor instead.
func (x *GrpcMethodList_Service) GetMethodNames() []string
func (x *GrpcMethodList_Service) GetName() string
func (*GrpcMethodList_Service) ProtoMessage()
func (x *GrpcMethodList_Service) ProtoReflect() protoreflect.Message
func (x *GrpcMethodList_Service) Reset()
func (x *GrpcMethodList_Service) String() string
func (m *GrpcMethodList_Service) Validate() error
Validate checks the field values on GrpcMethodList_Service with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type GrpcMethodList_ServiceValidationError struct {
// contains filtered or unexported fields
}GrpcMethodList_ServiceValidationError is the validation error returned by GrpcMethodList_Service.Validate if the designated constraints aren't met.
func (e GrpcMethodList_ServiceValidationError) Cause() error
Cause function returns cause value.
func (e GrpcMethodList_ServiceValidationError) Error() string
Error satisfies the builtin error interface
func (e GrpcMethodList_ServiceValidationError) ErrorName() string
ErrorName returns error name.
func (e GrpcMethodList_ServiceValidationError) Field() string
Field function returns field value.
func (e GrpcMethodList_ServiceValidationError) Key() bool
Key function returns key value.
func (e GrpcMethodList_ServiceValidationError) Reason() string
Reason function returns reason value.
type GrpcProtocolOptions struct {
Http2ProtocolOptions *Http2ProtocolOptions `protobuf:"bytes,1,opt,name=http2_protocol_options,json=http2ProtocolOptions,proto3" json:"http2_protocol_options,omitempty"`
// contains filtered or unexported fields
}[#not-implemented-hide:]
func (*GrpcProtocolOptions) Descriptor() ([]byte, []int)
Deprecated: Use GrpcProtocolOptions.ProtoReflect.Descriptor instead.
func (x *GrpcProtocolOptions) GetHttp2ProtocolOptions() *Http2ProtocolOptions
func (*GrpcProtocolOptions) ProtoMessage()
func (x *GrpcProtocolOptions) ProtoReflect() protoreflect.Message
func (x *GrpcProtocolOptions) Reset()
func (x *GrpcProtocolOptions) String() string
func (m *GrpcProtocolOptions) Validate() error
Validate checks the field values on GrpcProtocolOptions with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type GrpcProtocolOptionsValidationError struct {
// contains filtered or unexported fields
}GrpcProtocolOptionsValidationError is the validation error returned by GrpcProtocolOptions.Validate if the designated constraints aren't met.
func (e GrpcProtocolOptionsValidationError) Cause() error
Cause function returns cause value.
func (e GrpcProtocolOptionsValidationError) Error() string
Error satisfies the builtin error interface
func (e GrpcProtocolOptionsValidationError) ErrorName() string
ErrorName returns error name.
func (e GrpcProtocolOptionsValidationError) Field() string
Field function returns field value.
func (e GrpcProtocolOptionsValidationError) Key() bool
Key function returns key value.
func (e GrpcProtocolOptionsValidationError) Reason() string
Reason function returns reason value.
type GrpcService struct {
// Types that are assignable to TargetSpecifier:
// *GrpcService_EnvoyGrpc_
// *GrpcService_GoogleGrpc_
TargetSpecifier isGrpcService_TargetSpecifier `protobuf_oneof:"target_specifier"`
// The timeout for the gRPC request. This is the timeout for a specific
// request.
Timeout *duration.Duration `protobuf:"bytes,3,opt,name=timeout,proto3" json:"timeout,omitempty"`
// Additional metadata to include in streams initiated to the GrpcService.
// This can be used for scenarios in which additional ad hoc authorization
// headers (e.g. ``x-foo-bar: baz-key``) are to be injected.
InitialMetadata []*HeaderValue `protobuf:"bytes,5,rep,name=initial_metadata,json=initialMetadata,proto3" json:"initial_metadata,omitempty"`
// contains filtered or unexported fields
}gRPC service configuration. This is used by :ref:`ApiConfigSource <envoy_api_msg_core.ApiConfigSource>` and filter configurations. [#next-free-field: 6]
func (*GrpcService) Descriptor() ([]byte, []int)
Deprecated: Use GrpcService.ProtoReflect.Descriptor instead.
func (x *GrpcService) GetEnvoyGrpc() *GrpcService_EnvoyGrpc
func (x *GrpcService) GetGoogleGrpc() *GrpcService_GoogleGrpc
func (x *GrpcService) GetInitialMetadata() []*HeaderValue
func (m *GrpcService) GetTargetSpecifier() isGrpcService_TargetSpecifier
func (x *GrpcService) GetTimeout() *duration.Duration
func (*GrpcService) ProtoMessage()
func (x *GrpcService) ProtoReflect() protoreflect.Message
func (x *GrpcService) Reset()
func (x *GrpcService) String() string
func (m *GrpcService) Validate() error
Validate checks the field values on GrpcService with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type GrpcServiceValidationError struct {
// contains filtered or unexported fields
}GrpcServiceValidationError is the validation error returned by GrpcService.Validate if the designated constraints aren't met.
func (e GrpcServiceValidationError) Cause() error
Cause function returns cause value.
func (e GrpcServiceValidationError) Error() string
Error satisfies the builtin error interface
func (e GrpcServiceValidationError) ErrorName() string
ErrorName returns error name.
func (e GrpcServiceValidationError) Field() string
Field function returns field value.
func (e GrpcServiceValidationError) Key() bool
Key function returns key value.
func (e GrpcServiceValidationError) Reason() string
Reason function returns reason value.
type GrpcService_EnvoyGrpc struct {
// The name of the upstream gRPC cluster. SSL credentials will be supplied
// in the :ref:`Cluster <envoy_api_msg_Cluster>` :ref:`transport_socket
// <envoy_api_field_Cluster.transport_socket>`.
ClusterName string `protobuf:"bytes,1,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"`
// contains filtered or unexported fields
}func (*GrpcService_EnvoyGrpc) Descriptor() ([]byte, []int)
Deprecated: Use GrpcService_EnvoyGrpc.ProtoReflect.Descriptor instead.
func (x *GrpcService_EnvoyGrpc) GetClusterName() string
func (*GrpcService_EnvoyGrpc) ProtoMessage()
func (x *GrpcService_EnvoyGrpc) ProtoReflect() protoreflect.Message
func (x *GrpcService_EnvoyGrpc) Reset()
func (x *GrpcService_EnvoyGrpc) String() string
func (m *GrpcService_EnvoyGrpc) Validate() error
Validate checks the field values on GrpcService_EnvoyGrpc with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type GrpcService_EnvoyGrpcValidationError struct {
// contains filtered or unexported fields
}GrpcService_EnvoyGrpcValidationError is the validation error returned by GrpcService_EnvoyGrpc.Validate if the designated constraints aren't met.
func (e GrpcService_EnvoyGrpcValidationError) Cause() error
Cause function returns cause value.
func (e GrpcService_EnvoyGrpcValidationError) Error() string
Error satisfies the builtin error interface
func (e GrpcService_EnvoyGrpcValidationError) ErrorName() string
ErrorName returns error name.
func (e GrpcService_EnvoyGrpcValidationError) Field() string
Field function returns field value.
func (e GrpcService_EnvoyGrpcValidationError) Key() bool
Key function returns key value.
func (e GrpcService_EnvoyGrpcValidationError) Reason() string
Reason function returns reason value.
type GrpcService_EnvoyGrpc_ struct {
// Envoy's in-built gRPC client.
// See the :ref:`gRPC services overview <arch_overview_grpc_services>`
// documentation for discussion on gRPC client selection.
EnvoyGrpc *GrpcService_EnvoyGrpc `protobuf:"bytes,1,opt,name=envoy_grpc,json=envoyGrpc,proto3,oneof"`
}type GrpcService_GoogleGrpc struct {
// The target URI when using the `Google C++ gRPC client
// <https://github.com/grpc/grpc>`_. SSL credentials will be supplied in
// :ref:`channel_credentials <envoy_api_field_core.GrpcService.GoogleGrpc.channel_credentials>`.
TargetUri string `protobuf:"bytes,1,opt,name=target_uri,json=targetUri,proto3" json:"target_uri,omitempty"`
ChannelCredentials *GrpcService_GoogleGrpc_ChannelCredentials `protobuf:"bytes,2,opt,name=channel_credentials,json=channelCredentials,proto3" json:"channel_credentials,omitempty"`
// A set of call credentials that can be composed with `channel credentials
// <https://grpc.io/docs/guides/auth.html#credential-types>`_.
CallCredentials []*GrpcService_GoogleGrpc_CallCredentials `protobuf:"bytes,3,rep,name=call_credentials,json=callCredentials,proto3" json:"call_credentials,omitempty"`
// The human readable prefix to use when emitting statistics for the gRPC
// service.
//
// .. csv-table::
// :header: Name, Type, Description
// :widths: 1, 1, 2
//
// streams_total, Counter, Total number of streams opened
// streams_closed_<gRPC status code>, Counter, Total streams closed with <gRPC status code>
StatPrefix string `protobuf:"bytes,4,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"`
// The name of the Google gRPC credentials factory to use. This must have been registered with
// Envoy. If this is empty, a default credentials factory will be used that sets up channel
// credentials based on other configuration parameters.
CredentialsFactoryName string `protobuf:"bytes,5,opt,name=credentials_factory_name,json=credentialsFactoryName,proto3" json:"credentials_factory_name,omitempty"`
// Additional configuration for site-specific customizations of the Google
// gRPC library.
Config *_struct.Struct `protobuf:"bytes,6,opt,name=config,proto3" json:"config,omitempty"`
// contains filtered or unexported fields
}[#next-free-field: 7]
func (*GrpcService_GoogleGrpc) Descriptor() ([]byte, []int)
Deprecated: Use GrpcService_GoogleGrpc.ProtoReflect.Descriptor instead.
func (x *GrpcService_GoogleGrpc) GetCallCredentials() []*GrpcService_GoogleGrpc_CallCredentials
func (x *GrpcService_GoogleGrpc) GetChannelCredentials() *GrpcService_GoogleGrpc_ChannelCredentials
func (x *GrpcService_GoogleGrpc) GetConfig() *_struct.Struct
func (x *GrpcService_GoogleGrpc) GetCredentialsFactoryName() string
func (x *GrpcService_GoogleGrpc) GetStatPrefix() string
func (x *GrpcService_GoogleGrpc) GetTargetUri() string
func (*GrpcService_GoogleGrpc) ProtoMessage()
func (x *GrpcService_GoogleGrpc) ProtoReflect() protoreflect.Message
func (x *GrpcService_GoogleGrpc) Reset()
func (x *GrpcService_GoogleGrpc) String() string
func (m *GrpcService_GoogleGrpc) Validate() error
Validate checks the field values on GrpcService_GoogleGrpc with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type GrpcService_GoogleGrpcValidationError struct {
// contains filtered or unexported fields
}GrpcService_GoogleGrpcValidationError is the validation error returned by GrpcService_GoogleGrpc.Validate if the designated constraints aren't met.
func (e GrpcService_GoogleGrpcValidationError) Cause() error
Cause function returns cause value.
func (e GrpcService_GoogleGrpcValidationError) Error() string
Error satisfies the builtin error interface
func (e GrpcService_GoogleGrpcValidationError) ErrorName() string
ErrorName returns error name.
func (e GrpcService_GoogleGrpcValidationError) Field() string
Field function returns field value.
func (e GrpcService_GoogleGrpcValidationError) Key() bool
Key function returns key value.
func (e GrpcService_GoogleGrpcValidationError) Reason() string
Reason function returns reason value.
type GrpcService_GoogleGrpc_ struct {
// `Google C++ gRPC client <https://github.com/grpc/grpc>`_
// See the :ref:`gRPC services overview <arch_overview_grpc_services>`
// documentation for discussion on gRPC client selection.
GoogleGrpc *GrpcService_GoogleGrpc `protobuf:"bytes,2,opt,name=google_grpc,json=googleGrpc,proto3,oneof"`
}type GrpcService_GoogleGrpc_CallCredentials struct {
// Types that are assignable to CredentialSpecifier:
// *GrpcService_GoogleGrpc_CallCredentials_AccessToken
// *GrpcService_GoogleGrpc_CallCredentials_GoogleComputeEngine
// *GrpcService_GoogleGrpc_CallCredentials_GoogleRefreshToken
// *GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJwtAccess
// *GrpcService_GoogleGrpc_CallCredentials_GoogleIam
// *GrpcService_GoogleGrpc_CallCredentials_FromPlugin
// *GrpcService_GoogleGrpc_CallCredentials_StsService_
CredentialSpecifier isGrpcService_GoogleGrpc_CallCredentials_CredentialSpecifier `protobuf_oneof:"credential_specifier"`
// contains filtered or unexported fields
}[#next-free-field: 8]
func (*GrpcService_GoogleGrpc_CallCredentials) Descriptor() ([]byte, []int)
Deprecated: Use GrpcService_GoogleGrpc_CallCredentials.ProtoReflect.Descriptor instead.
func (x *GrpcService_GoogleGrpc_CallCredentials) GetAccessToken() string
func (m *GrpcService_GoogleGrpc_CallCredentials) GetCredentialSpecifier() isGrpcService_GoogleGrpc_CallCredentials_CredentialSpecifier
func (x *GrpcService_GoogleGrpc_CallCredentials) GetFromPlugin() *GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin
func (x *GrpcService_GoogleGrpc_CallCredentials) GetGoogleComputeEngine() *emptypb.Empty
func (x *GrpcService_GoogleGrpc_CallCredentials) GetGoogleIam() *GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentials
func (x *GrpcService_GoogleGrpc_CallCredentials) GetGoogleRefreshToken() string
func (x *GrpcService_GoogleGrpc_CallCredentials) GetServiceAccountJwtAccess() *GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentials
func (x *GrpcService_GoogleGrpc_CallCredentials) GetStsService() *GrpcService_GoogleGrpc_CallCredentials_StsService
func (*GrpcService_GoogleGrpc_CallCredentials) ProtoMessage()
func (x *GrpcService_GoogleGrpc_CallCredentials) ProtoReflect() protoreflect.Message
func (x *GrpcService_GoogleGrpc_CallCredentials) Reset()
func (x *GrpcService_GoogleGrpc_CallCredentials) String() string
func (m *GrpcService_GoogleGrpc_CallCredentials) Validate() error
Validate checks the field values on GrpcService_GoogleGrpc_CallCredentials with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type GrpcService_GoogleGrpc_CallCredentialsValidationError struct {
// contains filtered or unexported fields
}GrpcService_GoogleGrpc_CallCredentialsValidationError is the validation error returned by GrpcService_GoogleGrpc_CallCredentials.Validate if the designated constraints aren't met.
func (e GrpcService_GoogleGrpc_CallCredentialsValidationError) Cause() error
Cause function returns cause value.
func (e GrpcService_GoogleGrpc_CallCredentialsValidationError) Error() string
Error satisfies the builtin error interface
func (e GrpcService_GoogleGrpc_CallCredentialsValidationError) ErrorName() string
ErrorName returns error name.
func (e GrpcService_GoogleGrpc_CallCredentialsValidationError) Field() string
Field function returns field value.
func (e GrpcService_GoogleGrpc_CallCredentialsValidationError) Key() bool
Key function returns key value.
func (e GrpcService_GoogleGrpc_CallCredentialsValidationError) Reason() string
Reason function returns reason value.
type GrpcService_GoogleGrpc_CallCredentials_AccessToken struct {
// Access token credentials.
// https://grpc.io/grpc/cpp/namespacegrpc.html#ad3a80da696ffdaea943f0f858d7a360d.
AccessToken string `protobuf:"bytes,1,opt,name=access_token,json=accessToken,proto3,oneof"`
}type GrpcService_GoogleGrpc_CallCredentials_FromPlugin struct {
// Custom authenticator credentials.
// https://grpc.io/grpc/cpp/namespacegrpc.html#a823c6a4b19ffc71fb33e90154ee2ad07.
// https://grpc.io/docs/guides/auth.html#extending-grpc-to-support-other-authentication-mechanisms.
FromPlugin *GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin `protobuf:"bytes,6,opt,name=from_plugin,json=fromPlugin,proto3,oneof"`
}type GrpcService_GoogleGrpc_CallCredentials_GoogleComputeEngine struct {
// Google Compute Engine credentials.
// https://grpc.io/grpc/cpp/namespacegrpc.html#a6beb3ac70ff94bd2ebbd89b8f21d1f61
GoogleComputeEngine *emptypb.Empty `protobuf:"bytes,2,opt,name=google_compute_engine,json=googleComputeEngine,proto3,oneof"`
}type GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentials struct {
AuthorizationToken string `protobuf:"bytes,1,opt,name=authorization_token,json=authorizationToken,proto3" json:"authorization_token,omitempty"`
AuthoritySelector string `protobuf:"bytes,2,opt,name=authority_selector,json=authoritySelector,proto3" json:"authority_selector,omitempty"`
// contains filtered or unexported fields
}func (*GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentials) Descriptor() ([]byte, []int)
Deprecated: Use GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentials.ProtoReflect.Descriptor instead.
func (x *GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentials) GetAuthoritySelector() string
func (x *GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentials) GetAuthorizationToken() string
func (*GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentials) ProtoMessage()
func (x *GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentials) ProtoReflect() protoreflect.Message
func (x *GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentials) Reset()
func (x *GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentials) String() string
func (m *GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentials) Validate() error
Validate checks the field values on GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentials with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentialsValidationError struct {
// contains filtered or unexported fields
}GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentialsValidationError is the validation error returned by GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentials.Validate if the designated constraints aren't met.
Cause function returns cause value.
Error satisfies the builtin error interface
func (e GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentialsValidationError) ErrorName() string
ErrorName returns error name.
Field function returns field value.
Key function returns key value.
func (e GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentialsValidationError) Reason() string
Reason function returns reason value.
type GrpcService_GoogleGrpc_CallCredentials_GoogleIam struct {
// Google IAM credentials.
// https://grpc.io/grpc/cpp/namespacegrpc.html#a9fc1fc101b41e680d47028166e76f9d0.
GoogleIam *GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentials `protobuf:"bytes,5,opt,name=google_iam,json=googleIam,proto3,oneof"`
}type GrpcService_GoogleGrpc_CallCredentials_GoogleRefreshToken struct {
// Google refresh token credentials.
// https://grpc.io/grpc/cpp/namespacegrpc.html#a96901c997b91bc6513b08491e0dca37c.
GoogleRefreshToken string `protobuf:"bytes,3,opt,name=google_refresh_token,json=googleRefreshToken,proto3,oneof"`
}type GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Types that are assignable to ConfigType:
// *GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin_Config
// *GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin_TypedConfig
ConfigType isGrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin_ConfigType `protobuf_oneof:"config_type"`
// contains filtered or unexported fields
}func (*GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin) Descriptor() ([]byte, []int)
Deprecated: Use GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin.ProtoReflect.Descriptor instead.
func (x *GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin) GetConfig() *_struct.Struct
Deprecated: Do not use.
func (m *GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin) GetConfigType() isGrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin_ConfigType
func (x *GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin) GetName() string
func (x *GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin) GetTypedConfig() *any.Any
func (*GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin) ProtoMessage()
func (x *GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin) ProtoReflect() protoreflect.Message
func (x *GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin) Reset()
func (x *GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin) String() string
func (m *GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin) Validate() error
Validate checks the field values on GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPluginValidationError struct {
// contains filtered or unexported fields
}GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPluginValidationError is the validation error returned by GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin.Validate if the designated constraints aren't met.
func (e GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPluginValidationError) Cause() error
Cause function returns cause value.
func (e GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPluginValidationError) Error() string
Error satisfies the builtin error interface
func (e GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPluginValidationError) ErrorName() string
ErrorName returns error name.
func (e GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPluginValidationError) Field() string
Field function returns field value.
func (e GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPluginValidationError) Key() bool
Key function returns key value.
func (e GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPluginValidationError) Reason() string
Reason function returns reason value.
type GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin_Config struct {
// Deprecated: Do not use.
Config *_struct.Struct `protobuf:"bytes,2,opt,name=config,proto3,oneof"`
}type GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin_TypedConfig struct {
TypedConfig *any.Any `protobuf:"bytes,3,opt,name=typed_config,json=typedConfig,proto3,oneof"`
}type GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentials struct {
JsonKey string `protobuf:"bytes,1,opt,name=json_key,json=jsonKey,proto3" json:"json_key,omitempty"`
TokenLifetimeSeconds uint64 `protobuf:"varint,2,opt,name=token_lifetime_seconds,json=tokenLifetimeSeconds,proto3" json:"token_lifetime_seconds,omitempty"`
// contains filtered or unexported fields
}func (*GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentials) Descriptor() ([]byte, []int)
Deprecated: Use GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentials.ProtoReflect.Descriptor instead.
func (x *GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentials) GetJsonKey() string
func (x *GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentials) GetTokenLifetimeSeconds() uint64
func (*GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentials) ProtoMessage()
func (x *GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentials) ProtoReflect() protoreflect.Message
func (x *GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentials) String() string
func (m *GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentials) Validate() error
Validate checks the field values on GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentials with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentialsValidationError struct {
// contains filtered or unexported fields
}GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentialsValidationError is the validation error returned by GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentials.Validate if the designated constraints aren't met.
func (e GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentialsValidationError) Cause() error
Cause function returns cause value.
func (e GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentialsValidationError) Error() string
Error satisfies the builtin error interface
func (e GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentialsValidationError) ErrorName() string
ErrorName returns error name.
func (e GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentialsValidationError) Field() string
Field function returns field value.
func (e GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentialsValidationError) Key() bool
Key function returns key value.
func (e GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentialsValidationError) Reason() string
Reason function returns reason value.
type GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJwtAccess struct {
// Service Account JWT Access credentials.
// https://grpc.io/grpc/cpp/namespacegrpc.html#a92a9f959d6102461f66ee973d8e9d3aa.
ServiceAccountJwtAccess *GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentials `protobuf:"bytes,4,opt,name=service_account_jwt_access,json=serviceAccountJwtAccess,proto3,oneof"`
}type GrpcService_GoogleGrpc_CallCredentials_StsService struct {
// URI of the token exchange service that handles token exchange requests.
// [#comment:TODO(asraa): Add URI validation when implemented. Tracked by
// https://github.com/envoyproxy/protoc-gen-validate/issues/303]
TokenExchangeServiceUri string `protobuf:"bytes,1,opt,name=token_exchange_service_uri,json=tokenExchangeServiceUri,proto3" json:"token_exchange_service_uri,omitempty"`
// Location of the target service or resource where the client
// intends to use the requested security token.
Resource string `protobuf:"bytes,2,opt,name=resource,proto3" json:"resource,omitempty"`
// Logical name of the target service where the client intends to
// use the requested security token.
Audience string `protobuf:"bytes,3,opt,name=audience,proto3" json:"audience,omitempty"`
// The desired scope of the requested security token in the
// context of the service or resource where the token will be used.
Scope string `protobuf:"bytes,4,opt,name=scope,proto3" json:"scope,omitempty"`
// Type of the requested security token.
RequestedTokenType string `protobuf:"bytes,5,opt,name=requested_token_type,json=requestedTokenType,proto3" json:"requested_token_type,omitempty"`
// The path of subject token, a security token that represents the
// identity of the party on behalf of whom the request is being made.
SubjectTokenPath string `protobuf:"bytes,6,opt,name=subject_token_path,json=subjectTokenPath,proto3" json:"subject_token_path,omitempty"`
// Type of the subject token.
SubjectTokenType string `protobuf:"bytes,7,opt,name=subject_token_type,json=subjectTokenType,proto3" json:"subject_token_type,omitempty"`
// The path of actor token, a security token that represents the identity
// of the acting party. The acting party is authorized to use the
// requested security token and act on behalf of the subject.
ActorTokenPath string `protobuf:"bytes,8,opt,name=actor_token_path,json=actorTokenPath,proto3" json:"actor_token_path,omitempty"`
// Type of the actor token.
ActorTokenType string `protobuf:"bytes,9,opt,name=actor_token_type,json=actorTokenType,proto3" json:"actor_token_type,omitempty"`
// contains filtered or unexported fields
}Security token service configuration that allows Google gRPC to fetch security token from an OAuth 2.0 authorization server. See https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16 and https://github.com/grpc/grpc/pull/19587. [#next-free-field: 10]
func (*GrpcService_GoogleGrpc_CallCredentials_StsService) Descriptor() ([]byte, []int)
Deprecated: Use GrpcService_GoogleGrpc_CallCredentials_StsService.ProtoReflect.Descriptor instead.
func (x *GrpcService_GoogleGrpc_CallCredentials_StsService) GetActorTokenPath() string
func (x *GrpcService_GoogleGrpc_CallCredentials_StsService) GetActorTokenType() string
func (x *GrpcService_GoogleGrpc_CallCredentials_StsService) GetAudience() string
func (x *GrpcService_GoogleGrpc_CallCredentials_StsService) GetRequestedTokenType() string
func (x *GrpcService_GoogleGrpc_CallCredentials_StsService) GetResource() string
func (x *GrpcService_GoogleGrpc_CallCredentials_StsService) GetScope() string
func (x *GrpcService_GoogleGrpc_CallCredentials_StsService) GetSubjectTokenPath() string
func (x *GrpcService_GoogleGrpc_CallCredentials_StsService) GetSubjectTokenType() string
func (x *GrpcService_GoogleGrpc_CallCredentials_StsService) GetTokenExchangeServiceUri() string
func (*GrpcService_GoogleGrpc_CallCredentials_StsService) ProtoMessage()
func (x *GrpcService_GoogleGrpc_CallCredentials_StsService) ProtoReflect() protoreflect.Message
func (x *GrpcService_GoogleGrpc_CallCredentials_StsService) Reset()
func (x *GrpcService_GoogleGrpc_CallCredentials_StsService) String() string
func (m *GrpcService_GoogleGrpc_CallCredentials_StsService) Validate() error
Validate checks the field values on GrpcService_GoogleGrpc_CallCredentials_StsService with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type GrpcService_GoogleGrpc_CallCredentials_StsServiceValidationError struct {
// contains filtered or unexported fields
}GrpcService_GoogleGrpc_CallCredentials_StsServiceValidationError is the validation error returned by GrpcService_GoogleGrpc_CallCredentials_StsService.Validate if the designated constraints aren't met.
func (e GrpcService_GoogleGrpc_CallCredentials_StsServiceValidationError) Cause() error
Cause function returns cause value.
func (e GrpcService_GoogleGrpc_CallCredentials_StsServiceValidationError) Error() string
Error satisfies the builtin error interface
func (e GrpcService_GoogleGrpc_CallCredentials_StsServiceValidationError) ErrorName() string
ErrorName returns error name.
func (e GrpcService_GoogleGrpc_CallCredentials_StsServiceValidationError) Field() string
Field function returns field value.
Key function returns key value.
func (e GrpcService_GoogleGrpc_CallCredentials_StsServiceValidationError) Reason() string
Reason function returns reason value.
type GrpcService_GoogleGrpc_CallCredentials_StsService_ struct {
// Custom security token service which implements OAuth 2.0 token exchange.
// https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-16
// See https://github.com/grpc/grpc/pull/19587.
StsService *GrpcService_GoogleGrpc_CallCredentials_StsService `protobuf:"bytes,7,opt,name=sts_service,json=stsService,proto3,oneof"`
}type GrpcService_GoogleGrpc_ChannelCredentials struct {
// Types that are assignable to CredentialSpecifier:
// *GrpcService_GoogleGrpc_ChannelCredentials_SslCredentials
// *GrpcService_GoogleGrpc_ChannelCredentials_GoogleDefault
// *GrpcService_GoogleGrpc_ChannelCredentials_LocalCredentials
CredentialSpecifier isGrpcService_GoogleGrpc_ChannelCredentials_CredentialSpecifier `protobuf_oneof:"credential_specifier"`
// contains filtered or unexported fields
}See https://grpc.io/docs/guides/auth.html#credential-types to understand Channel and Call credential types.
func (*GrpcService_GoogleGrpc_ChannelCredentials) Descriptor() ([]byte, []int)
Deprecated: Use GrpcService_GoogleGrpc_ChannelCredentials.ProtoReflect.Descriptor instead.
func (m *GrpcService_GoogleGrpc_ChannelCredentials) GetCredentialSpecifier() isGrpcService_GoogleGrpc_ChannelCredentials_CredentialSpecifier
func (x *GrpcService_GoogleGrpc_ChannelCredentials) GetGoogleDefault() *emptypb.Empty
func (x *GrpcService_GoogleGrpc_ChannelCredentials) GetLocalCredentials() *GrpcService_GoogleGrpc_GoogleLocalCredentials
func (x *GrpcService_GoogleGrpc_ChannelCredentials) GetSslCredentials() *GrpcService_GoogleGrpc_SslCredentials
func (*GrpcService_GoogleGrpc_ChannelCredentials) ProtoMessage()
func (x *GrpcService_GoogleGrpc_ChannelCredentials) ProtoReflect() protoreflect.Message
func (x *GrpcService_GoogleGrpc_ChannelCredentials) Reset()
func (x *GrpcService_GoogleGrpc_ChannelCredentials) String() string
func (m *GrpcService_GoogleGrpc_ChannelCredentials) Validate() error
Validate checks the field values on GrpcService_GoogleGrpc_ChannelCredentials with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type GrpcService_GoogleGrpc_ChannelCredentialsValidationError struct {
// contains filtered or unexported fields
}GrpcService_GoogleGrpc_ChannelCredentialsValidationError is the validation error returned by GrpcService_GoogleGrpc_ChannelCredentials.Validate if the designated constraints aren't met.
func (e GrpcService_GoogleGrpc_ChannelCredentialsValidationError) Cause() error
Cause function returns cause value.
func (e GrpcService_GoogleGrpc_ChannelCredentialsValidationError) Error() string
Error satisfies the builtin error interface
func (e GrpcService_GoogleGrpc_ChannelCredentialsValidationError) ErrorName() string
ErrorName returns error name.
func (e GrpcService_GoogleGrpc_ChannelCredentialsValidationError) Field() string
Field function returns field value.
func (e GrpcService_GoogleGrpc_ChannelCredentialsValidationError) Key() bool
Key function returns key value.
func (e GrpcService_GoogleGrpc_ChannelCredentialsValidationError) Reason() string
Reason function returns reason value.
type GrpcService_GoogleGrpc_ChannelCredentials_GoogleDefault struct {
// https://grpc.io/grpc/cpp/namespacegrpc.html#a6beb3ac70ff94bd2ebbd89b8f21d1f61
GoogleDefault *emptypb.Empty `protobuf:"bytes,2,opt,name=google_default,json=googleDefault,proto3,oneof"`
}type GrpcService_GoogleGrpc_ChannelCredentials_LocalCredentials struct {
LocalCredentials *GrpcService_GoogleGrpc_GoogleLocalCredentials `protobuf:"bytes,3,opt,name=local_credentials,json=localCredentials,proto3,oneof"`
}type GrpcService_GoogleGrpc_ChannelCredentials_SslCredentials struct {
SslCredentials *GrpcService_GoogleGrpc_SslCredentials `protobuf:"bytes,1,opt,name=ssl_credentials,json=sslCredentials,proto3,oneof"`
}type GrpcService_GoogleGrpc_GoogleLocalCredentials struct {
// contains filtered or unexported fields
}Local channel credentials. Only UDS is supported for now. See https://github.com/grpc/grpc/pull/15909.
func (*GrpcService_GoogleGrpc_GoogleLocalCredentials) Descriptor() ([]byte, []int)
Deprecated: Use GrpcService_GoogleGrpc_GoogleLocalCredentials.ProtoReflect.Descriptor instead.
func (*GrpcService_GoogleGrpc_GoogleLocalCredentials) ProtoMessage()
func (x *GrpcService_GoogleGrpc_GoogleLocalCredentials) ProtoReflect() protoreflect.Message
func (x *GrpcService_GoogleGrpc_GoogleLocalCredentials) Reset()
func (x *GrpcService_GoogleGrpc_GoogleLocalCredentials) String() string
func (m *GrpcService_GoogleGrpc_GoogleLocalCredentials) Validate() error
Validate checks the field values on GrpcService_GoogleGrpc_GoogleLocalCredentials with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type GrpcService_GoogleGrpc_GoogleLocalCredentialsValidationError struct {
// contains filtered or unexported fields
}GrpcService_GoogleGrpc_GoogleLocalCredentialsValidationError is the validation error returned by GrpcService_GoogleGrpc_GoogleLocalCredentials.Validate if the designated constraints aren't met.
func (e GrpcService_GoogleGrpc_GoogleLocalCredentialsValidationError) Cause() error
Cause function returns cause value.
func (e GrpcService_GoogleGrpc_GoogleLocalCredentialsValidationError) Error() string
Error satisfies the builtin error interface
func (e GrpcService_GoogleGrpc_GoogleLocalCredentialsValidationError) ErrorName() string
ErrorName returns error name.
func (e GrpcService_GoogleGrpc_GoogleLocalCredentialsValidationError) Field() string
Field function returns field value.
Key function returns key value.
func (e GrpcService_GoogleGrpc_GoogleLocalCredentialsValidationError) Reason() string
Reason function returns reason value.
type GrpcService_GoogleGrpc_SslCredentials struct {
// PEM encoded server root certificates.
RootCerts *DataSource `protobuf:"bytes,1,opt,name=root_certs,json=rootCerts,proto3" json:"root_certs,omitempty"`
// PEM encoded client private key.
PrivateKey *DataSource `protobuf:"bytes,2,opt,name=private_key,json=privateKey,proto3" json:"private_key,omitempty"`
// PEM encoded client certificate chain.
CertChain *DataSource `protobuf:"bytes,3,opt,name=cert_chain,json=certChain,proto3" json:"cert_chain,omitempty"`
// contains filtered or unexported fields
}See https://grpc.io/grpc/cpp/structgrpc_1_1_ssl_credentials_options.html.
func (*GrpcService_GoogleGrpc_SslCredentials) Descriptor() ([]byte, []int)
Deprecated: Use GrpcService_GoogleGrpc_SslCredentials.ProtoReflect.Descriptor instead.
func (x *GrpcService_GoogleGrpc_SslCredentials) GetCertChain() *DataSource
func (x *GrpcService_GoogleGrpc_SslCredentials) GetPrivateKey() *DataSource
func (x *GrpcService_GoogleGrpc_SslCredentials) GetRootCerts() *DataSource
func (*GrpcService_GoogleGrpc_SslCredentials) ProtoMessage()
func (x *GrpcService_GoogleGrpc_SslCredentials) ProtoReflect() protoreflect.Message
func (x *GrpcService_GoogleGrpc_SslCredentials) Reset()
func (x *GrpcService_GoogleGrpc_SslCredentials) String() string
func (m *GrpcService_GoogleGrpc_SslCredentials) Validate() error
Validate checks the field values on GrpcService_GoogleGrpc_SslCredentials with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type GrpcService_GoogleGrpc_SslCredentialsValidationError struct {
// contains filtered or unexported fields
}GrpcService_GoogleGrpc_SslCredentialsValidationError is the validation error returned by GrpcService_GoogleGrpc_SslCredentials.Validate if the designated constraints aren't met.
func (e GrpcService_GoogleGrpc_SslCredentialsValidationError) Cause() error
Cause function returns cause value.
func (e GrpcService_GoogleGrpc_SslCredentialsValidationError) Error() string
Error satisfies the builtin error interface
func (e GrpcService_GoogleGrpc_SslCredentialsValidationError) ErrorName() string
ErrorName returns error name.
func (e GrpcService_GoogleGrpc_SslCredentialsValidationError) Field() string
Field function returns field value.
func (e GrpcService_GoogleGrpc_SslCredentialsValidationError) Key() bool
Key function returns key value.
func (e GrpcService_GoogleGrpc_SslCredentialsValidationError) Reason() string
Reason function returns reason value.
type HeaderMap struct {
Headers []*HeaderValue `protobuf:"bytes,1,rep,name=headers,proto3" json:"headers,omitempty"`
// contains filtered or unexported fields
}Wrapper for a set of headers.
Deprecated: Use HeaderMap.ProtoReflect.Descriptor instead.
func (x *HeaderMap) GetHeaders() []*HeaderValue
func (x *HeaderMap) ProtoReflect() protoreflect.Message
Validate checks the field values on HeaderMap with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type HeaderMapValidationError struct {
// contains filtered or unexported fields
}HeaderMapValidationError is the validation error returned by HeaderMap.Validate if the designated constraints aren't met.
func (e HeaderMapValidationError) Cause() error
Cause function returns cause value.
func (e HeaderMapValidationError) Error() string
Error satisfies the builtin error interface
func (e HeaderMapValidationError) ErrorName() string
ErrorName returns error name.
func (e HeaderMapValidationError) Field() string
Field function returns field value.
func (e HeaderMapValidationError) Key() bool
Key function returns key value.
func (e HeaderMapValidationError) Reason() string
Reason function returns reason value.
type HeaderValue struct {
// Header name.
Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
// Header value.
//
// The same :ref:`format specifier <config_access_log_format>` as used for
// :ref:`HTTP access logging <config_access_log>` applies here, however
// unknown header values are replaced with the empty string instead of `-`.
Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
// contains filtered or unexported fields
}Header name/value pair.
func (*HeaderValue) Descriptor() ([]byte, []int)
Deprecated: Use HeaderValue.ProtoReflect.Descriptor instead.
func (x *HeaderValue) GetKey() string
func (x *HeaderValue) GetValue() string
func (*HeaderValue) ProtoMessage()
func (x *HeaderValue) ProtoReflect() protoreflect.Message
func (x *HeaderValue) Reset()
func (x *HeaderValue) String() string
func (m *HeaderValue) Validate() error
Validate checks the field values on HeaderValue with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type HeaderValueOption struct {
// Header name/value pair that this option applies to.
Header *HeaderValue `protobuf:"bytes,1,opt,name=header,proto3" json:"header,omitempty"`
// Should the value be appended? If true (default), the value is appended to
// existing values.
Append *wrappers.BoolValue `protobuf:"bytes,2,opt,name=append,proto3" json:"append,omitempty"`
// contains filtered or unexported fields
}Header name/value pair plus option to control append behavior.
func (*HeaderValueOption) Descriptor() ([]byte, []int)
Deprecated: Use HeaderValueOption.ProtoReflect.Descriptor instead.
func (x *HeaderValueOption) GetAppend() *wrappers.BoolValue
func (x *HeaderValueOption) GetHeader() *HeaderValue
func (*HeaderValueOption) ProtoMessage()
func (x *HeaderValueOption) ProtoReflect() protoreflect.Message
func (x *HeaderValueOption) Reset()
func (x *HeaderValueOption) String() string
func (m *HeaderValueOption) Validate() error
Validate checks the field values on HeaderValueOption with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type HeaderValueOptionValidationError struct {
// contains filtered or unexported fields
}HeaderValueOptionValidationError is the validation error returned by HeaderValueOption.Validate if the designated constraints aren't met.
func (e HeaderValueOptionValidationError) Cause() error
Cause function returns cause value.
func (e HeaderValueOptionValidationError) Error() string
Error satisfies the builtin error interface
func (e HeaderValueOptionValidationError) ErrorName() string
ErrorName returns error name.
func (e HeaderValueOptionValidationError) Field() string
Field function returns field value.
func (e HeaderValueOptionValidationError) Key() bool
Key function returns key value.
func (e HeaderValueOptionValidationError) Reason() string
Reason function returns reason value.
type HeaderValueValidationError struct {
// contains filtered or unexported fields
}HeaderValueValidationError is the validation error returned by HeaderValue.Validate if the designated constraints aren't met.
func (e HeaderValueValidationError) Cause() error
Cause function returns cause value.
func (e HeaderValueValidationError) Error() string
Error satisfies the builtin error interface
func (e HeaderValueValidationError) ErrorName() string
ErrorName returns error name.
func (e HeaderValueValidationError) Field() string
Field function returns field value.
func (e HeaderValueValidationError) Key() bool
Key function returns key value.
func (e HeaderValueValidationError) Reason() string
Reason function returns reason value.
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 *duration.Duration `protobuf:"bytes,1,opt,name=timeout,proto3" json:"timeout,omitempty"`
// The interval between health checks.
Interval *duration.Duration `protobuf:"bytes,2,opt,name=interval,proto3" json:"interval,omitempty"`
// An optional jitter amount in milliseconds. If specified, Envoy will start health
// checking after for a random time in ms between 0 and initial_jitter. This only
// applies to the first health check.
InitialJitter *duration.Duration `protobuf:"bytes,20,opt,name=initial_jitter,json=initialJitter,proto3" json:"initial_jitter,omitempty"`
// An optional jitter amount in milliseconds. If specified, during every
// interval Envoy will add interval_jitter to the wait time.
IntervalJitter *duration.Duration `protobuf:"bytes,3,opt,name=interval_jitter,json=intervalJitter,proto3" json:"interval_jitter,omitempty"`
// An optional jitter amount as a percentage of interval_ms. If specified,
// during every interval Envoy will add interval_ms *
// interval_jitter_percent / 100 to the wait time.
//
// If interval_jitter_ms and interval_jitter_percent are both set, both of
// them will be used to increase the wait time.
IntervalJitterPercent uint32 `protobuf:"varint,18,opt,name=interval_jitter_percent,json=intervalJitterPercent,proto3" json:"interval_jitter_percent,omitempty"`
// The number of unhealthy health checks required before a host is marked
// unhealthy. Note that for *http* health checking if a host responds with 503
// this threshold is ignored and the host is considered unhealthy immediately.
UnhealthyThreshold *wrappers.UInt32Value `protobuf:"bytes,4,opt,name=unhealthy_threshold,json=unhealthyThreshold,proto3" json:"unhealthy_threshold,omitempty"`
// The number of healthy health checks required before a host is marked
// healthy. Note that during startup, only a single successful health check is
// required to mark a host healthy.
HealthyThreshold *wrappers.UInt32Value `protobuf:"bytes,5,opt,name=healthy_threshold,json=healthyThreshold,proto3" json:"healthy_threshold,omitempty"`
// [#not-implemented-hide:] Non-serving port for health checking.
AltPort *wrappers.UInt32Value `protobuf:"bytes,6,opt,name=alt_port,json=altPort,proto3" json:"alt_port,omitempty"`
// Reuse health check connection between health checks. Default is true.
ReuseConnection *wrappers.BoolValue `protobuf:"bytes,7,opt,name=reuse_connection,json=reuseConnection,proto3" json:"reuse_connection,omitempty"`
// Types that are assignable to HealthChecker:
// *HealthCheck_HttpHealthCheck_
// *HealthCheck_TcpHealthCheck_
// *HealthCheck_GrpcHealthCheck_
// *HealthCheck_CustomHealthCheck_
HealthChecker isHealthCheck_HealthChecker `protobuf_oneof:"health_checker"`
// The "no traffic interval" is a special health check interval that is used when a cluster has
// never had traffic routed to it. This lower interval allows cluster information to be kept up to
// date, without sending a potentially large amount of active health checking traffic for no
// reason. Once a cluster has been used for traffic routing, Envoy will shift back to using the
// standard health check interval that is defined. Note that this interval takes precedence over
// any other.
//
// The default value for "no traffic interval" is 60 seconds.
NoTrafficInterval *duration.Duration `protobuf:"bytes,12,opt,name=no_traffic_interval,json=noTrafficInterval,proto3" json:"no_traffic_interval,omitempty"`
// The "unhealthy interval" is a health check interval that is used for hosts that are marked as
// unhealthy. As soon as the host is marked as healthy, Envoy will shift back to using the
// standard health check interval that is defined.
//
// The default value for "unhealthy interval" is the same as "interval".
UnhealthyInterval *duration.Duration `protobuf:"bytes,14,opt,name=unhealthy_interval,json=unhealthyInterval,proto3" json:"unhealthy_interval,omitempty"`
// The "unhealthy edge interval" is a special health check interval that is used for the first
// health check right after a host is marked as unhealthy. For subsequent health checks
// Envoy will shift back to using either "unhealthy interval" if present or the standard health
// check interval that is defined.
//
// The default value for "unhealthy edge interval" is the same as "unhealthy interval".
UnhealthyEdgeInterval *duration.Duration `protobuf:"bytes,15,opt,name=unhealthy_edge_interval,json=unhealthyEdgeInterval,proto3" json:"unhealthy_edge_interval,omitempty"`
// The "healthy edge interval" is a special health check interval that is used for the first
// health check right after a host is marked as healthy. For subsequent health checks
// Envoy will shift back to using the standard health check interval that is defined.
//
// The default value for "healthy edge interval" is the same as the default interval.
HealthyEdgeInterval *duration.Duration `protobuf:"bytes,16,opt,name=healthy_edge_interval,json=healthyEdgeInterval,proto3" json:"healthy_edge_interval,omitempty"`
// Specifies the path to the :ref:`health check event log <arch_overview_health_check_logging>`.
// If empty, no event log will be written.
EventLogPath string `protobuf:"bytes,17,opt,name=event_log_path,json=eventLogPath,proto3" json:"event_log_path,omitempty"`
// [#not-implemented-hide:]
// The gRPC service for the health check event service.
// If empty, health check events won't be sent to a remote endpoint.
EventService *EventServiceConfig `protobuf:"bytes,22,opt,name=event_service,json=eventService,proto3" json:"event_service,omitempty"`
// If set to true, health check failure events will always be logged. If set to false, only the
// initial health check failure event will be logged.
// The default value is false.
AlwaysLogHealthCheckFailures bool `protobuf:"varint,19,opt,name=always_log_health_check_failures,json=alwaysLogHealthCheckFailures,proto3" json:"always_log_health_check_failures,omitempty"`
// This allows overriding the cluster TLS settings, just for health check connections.
TlsOptions *HealthCheck_TlsOptions `protobuf:"bytes,21,opt,name=tls_options,json=tlsOptions,proto3" json:"tls_options,omitempty"`
// contains filtered or unexported fields
}[#next-free-field: 23]
func (*HealthCheck) Descriptor() ([]byte, []int)
Deprecated: Use HealthCheck.ProtoReflect.Descriptor instead.
func (x *HealthCheck) GetAltPort() *wrappers.UInt32Value
func (x *HealthCheck) GetAlwaysLogHealthCheckFailures() bool
func (x *HealthCheck) GetCustomHealthCheck() *HealthCheck_CustomHealthCheck
func (x *HealthCheck) GetEventLogPath() string
func (x *HealthCheck) GetEventService() *EventServiceConfig
func (x *HealthCheck) GetGrpcHealthCheck() *HealthCheck_GrpcHealthCheck
func (m *HealthCheck) GetHealthChecker() isHealthCheck_HealthChecker
func (x *HealthCheck) GetHealthyEdgeInterval() *duration.Duration
func (x *HealthCheck) GetHealthyThreshold() *wrappers.UInt32Value
func (x *HealthCheck) GetHttpHealthCheck() *HealthCheck_HttpHealthCheck
func (x *HealthCheck) GetInitialJitter() *duration.Duration
func (x *HealthCheck) GetInterval() *duration.Duration
func (x *HealthCheck) GetIntervalJitter() *duration.Duration
func (x *HealthCheck) GetIntervalJitterPercent() uint32
func (x *HealthCheck) GetNoTrafficInterval() *duration.Duration
func (x *HealthCheck) GetReuseConnection() *wrappers.BoolValue
func (x *HealthCheck) GetTcpHealthCheck() *HealthCheck_TcpHealthCheck
func (x *HealthCheck) GetTimeout() *duration.Duration
func (x *HealthCheck) GetTlsOptions() *HealthCheck_TlsOptions
func (x *HealthCheck) GetUnhealthyEdgeInterval() *duration.Duration
func (x *HealthCheck) GetUnhealthyInterval() *duration.Duration
func (x *HealthCheck) GetUnhealthyThreshold() *wrappers.UInt32Value
func (*HealthCheck) ProtoMessage()
func (x *HealthCheck) ProtoReflect() protoreflect.Message
func (x *HealthCheck) Reset()
func (x *HealthCheck) String() string
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, an error is returned.
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 (e HealthCheckValidationError) Cause() error
Cause function returns cause value.
func (e HealthCheckValidationError) Error() string
Error satisfies the builtin error interface
func (e HealthCheckValidationError) ErrorName() string
ErrorName returns error name.
func (e HealthCheckValidationError) Field() string
Field function returns field value.
func (e HealthCheckValidationError) Key() bool
Key function returns key value.
func (e HealthCheckValidationError) Reason() string
Reason function returns reason value.
type HealthCheck_CustomHealthCheck struct {
// The registered name of the custom health checker.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// A custom health checker specific configuration which depends on the custom health checker
// being instantiated. See :api:`envoy/config/health_checker` for reference.
//
// Types that are assignable to ConfigType:
// *HealthCheck_CustomHealthCheck_Config
// *HealthCheck_CustomHealthCheck_TypedConfig
ConfigType isHealthCheck_CustomHealthCheck_ConfigType `protobuf_oneof:"config_type"`
// contains filtered or unexported fields
}Custom health check.
func (*HealthCheck_CustomHealthCheck) Descriptor() ([]byte, []int)
Deprecated: Use HealthCheck_CustomHealthCheck.ProtoReflect.Descriptor instead.
func (x *HealthCheck_CustomHealthCheck) GetConfig() *_struct.Struct
Deprecated: Do not use.
func (m *HealthCheck_CustomHealthCheck) GetConfigType() isHealthCheck_CustomHealthCheck_ConfigType
func (x *HealthCheck_CustomHealthCheck) GetName() string
func (x *HealthCheck_CustomHealthCheck) GetTypedConfig() *any.Any
func (*HealthCheck_CustomHealthCheck) ProtoMessage()
func (x *HealthCheck_CustomHealthCheck) ProtoReflect() protoreflect.Message
func (x *HealthCheck_CustomHealthCheck) Reset()
func (x *HealthCheck_CustomHealthCheck) String() string
func (m *HealthCheck_CustomHealthCheck) Validate() error
Validate checks the field values on HealthCheck_CustomHealthCheck with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type HealthCheck_CustomHealthCheckValidationError struct {
// contains filtered or unexported fields
}HealthCheck_CustomHealthCheckValidationError is the validation error returned by HealthCheck_CustomHealthCheck.Validate if the designated constraints aren't met.
func (e HealthCheck_CustomHealthCheckValidationError) Cause() error
Cause function returns cause value.
func (e HealthCheck_CustomHealthCheckValidationError) Error() string
Error satisfies the builtin error interface
func (e HealthCheck_CustomHealthCheckValidationError) ErrorName() string
ErrorName returns error name.
func (e HealthCheck_CustomHealthCheckValidationError) Field() string
Field function returns field value.
func (e HealthCheck_CustomHealthCheckValidationError) Key() bool
Key function returns key value.
func (e HealthCheck_CustomHealthCheckValidationError) Reason() string
Reason function returns reason value.
type HealthCheck_CustomHealthCheck_ struct {
// Custom health check.
CustomHealthCheck *HealthCheck_CustomHealthCheck `protobuf:"bytes,13,opt,name=custom_health_check,json=customHealthCheck,proto3,oneof"`
}type HealthCheck_CustomHealthCheck_Config struct {
// Deprecated: Do not use.
Config *_struct.Struct `protobuf:"bytes,2,opt,name=config,proto3,oneof"`
}type HealthCheck_CustomHealthCheck_TypedConfig struct {
TypedConfig *any.Any `protobuf:"bytes,3,opt,name=typed_config,json=typedConfig,proto3,oneof"`
}type HealthCheck_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 :ref:`hostname <envoy_api_field_endpoint.Endpoint.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 (*HealthCheck_GrpcHealthCheck) Descriptor() ([]byte, []int)
Deprecated: Use HealthCheck_GrpcHealthCheck.ProtoReflect.Descriptor instead.
func (x *HealthCheck_GrpcHealthCheck) GetAuthority() string
func (x *HealthCheck_GrpcHealthCheck) GetServiceName() string
func (*HealthCheck_GrpcHealthCheck) ProtoMessage()
func (x *HealthCheck_GrpcHealthCheck) ProtoReflect() protoreflect.Message
func (x *HealthCheck_GrpcHealthCheck) Reset()
func (x *HealthCheck_GrpcHealthCheck) String() string
func (m *HealthCheck_GrpcHealthCheck) Validate() error
Validate checks the field values on HealthCheck_GrpcHealthCheck with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type HealthCheck_GrpcHealthCheckValidationError struct {
// contains filtered or unexported fields
}HealthCheck_GrpcHealthCheckValidationError is the validation error returned by HealthCheck_GrpcHealthCheck.Validate if the designated constraints aren't met.
func (e HealthCheck_GrpcHealthCheckValidationError) Cause() error
Cause function returns cause value.
func (e HealthCheck_GrpcHealthCheckValidationError) Error() string
Error satisfies the builtin error interface
func (e HealthCheck_GrpcHealthCheckValidationError) ErrorName() string
ErrorName returns error name.
func (e HealthCheck_GrpcHealthCheckValidationError) Field() string
Field function returns field value.
func (e HealthCheck_GrpcHealthCheckValidationError) Key() bool
Key function returns key value.
func (e HealthCheck_GrpcHealthCheckValidationError) Reason() string
Reason function returns reason value.
type HealthCheck_GrpcHealthCheck_ struct {
// gRPC health check.
GrpcHealthCheck *HealthCheck_GrpcHealthCheck `protobuf:"bytes,11,opt,name=grpc_health_check,json=grpcHealthCheck,proto3,oneof"`
}type HealthCheck_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. The host header can be customized for a specific endpoint by setting the
// :ref:`hostname <envoy_api_field_endpoint.Endpoint.HealthCheckConfig.hostname>` field.
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"`
// [#not-implemented-hide:] HTTP specific payload.
Send *HealthCheck_Payload `protobuf:"bytes,3,opt,name=send,proto3" json:"send,omitempty"`
// [#not-implemented-hide:] HTTP specific response.
Receive *HealthCheck_Payload `protobuf:"bytes,4,opt,name=receive,proto3" json:"receive,omitempty"`
// An optional service name parameter which is used to validate the identity of
// the health checked cluster. See the :ref:`architecture overview
// <arch_overview_health_checking_identity>` for more information.
//
// .. attention::
//
// This field has been deprecated in favor of `service_name_matcher` for better flexibility
// over matching with service-cluster name.
//
// Deprecated: Do not use.
ServiceName string `protobuf:"bytes,5,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
// Specifies a list of HTTP headers that should be added to each request that is sent to the
// health checked cluster. For more information, including details on header value syntax, see
// the documentation on :ref:`custom request headers
// <config_http_conn_man_headers_custom_request_headers>`.
RequestHeadersToAdd []*HeaderValueOption `protobuf:"bytes,6,rep,name=request_headers_to_add,json=requestHeadersToAdd,proto3" json:"request_headers_to_add,omitempty"`
// Specifies a list of HTTP headers that should be removed from each request that is sent to the
// health checked cluster.
RequestHeadersToRemove []string `protobuf:"bytes,8,rep,name=request_headers_to_remove,json=requestHeadersToRemove,proto3" json:"request_headers_to_remove,omitempty"`
// If set, health checks will be made using http/2.
// Deprecated, use :ref:`codec_client_type
// <envoy_api_field_core.HealthCheck.HttpHealthCheck.codec_client_type>` instead.
//
// Deprecated: Do not use.
UseHttp2 bool `protobuf:"varint,7,opt,name=use_http2,json=useHttp2,proto3" json:"use_http2,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 :ref:`Int64Range <envoy_api_msg_type.Int64Range>`. The start and end of each
// range are required. Only statuses in the range [100, 600) are allowed.
ExpectedStatuses []*_type.Int64Range `protobuf:"bytes,9,rep,name=expected_statuses,json=expectedStatuses,proto3" json:"expected_statuses,omitempty"`
// Use specified application protocol for health checks.
CodecClientType _type.CodecClientType `protobuf:"varint,10,opt,name=codec_client_type,json=codecClientType,proto3,enum=envoy.type.CodecClientType" json:"codec_client_type,omitempty"`
// An optional service name parameter which is used to validate the identity of
// the health checked cluster using a :ref:`StringMatcher
// <envoy_api_msg_type.matcher.StringMatcher>`. See the :ref:`architecture overview
// <arch_overview_health_checking_identity>` for more information.
ServiceNameMatcher *matcher.StringMatcher `protobuf:"bytes,11,opt,name=service_name_matcher,json=serviceNameMatcher,proto3" json:"service_name_matcher,omitempty"`
// contains filtered or unexported fields
}[#next-free-field: 12]
func (*HealthCheck_HttpHealthCheck) Descriptor() ([]byte, []int)
Deprecated: Use HealthCheck_HttpHealthCheck.ProtoReflect.Descriptor instead.
func (x *HealthCheck_HttpHealthCheck) GetCodecClientType() _type.CodecClientType
func (x *HealthCheck_HttpHealthCheck) GetExpectedStatuses() []*_type.Int64Range
func (x *HealthCheck_HttpHealthCheck) GetHost() string
func (x *HealthCheck_HttpHealthCheck) GetPath() string
func (x *HealthCheck_HttpHealthCheck) GetReceive() *HealthCheck_Payload
func (x *HealthCheck_HttpHealthCheck) GetRequestHeadersToAdd() []*HeaderValueOption
func (x *HealthCheck_HttpHealthCheck) GetRequestHeadersToRemove() []string
func (x *HealthCheck_HttpHealthCheck) GetSend() *HealthCheck_Payload
func (x *HealthCheck_HttpHealthCheck) GetServiceName() string
Deprecated: Do not use.
func (x *HealthCheck_HttpHealthCheck) GetServiceNameMatcher() *matcher.StringMatcher
func (x *HealthCheck_HttpHealthCheck) GetUseHttp2() bool
Deprecated: Do not use.
func (*HealthCheck_HttpHealthCheck) ProtoMessage()
func (x *HealthCheck_HttpHealthCheck) ProtoReflect() protoreflect.Message
func (x *HealthCheck_HttpHealthCheck) Reset()
func (x *HealthCheck_HttpHealthCheck) String() string
func (m *HealthCheck_HttpHealthCheck) Validate() error
Validate checks the field values on HealthCheck_HttpHealthCheck with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type HealthCheck_HttpHealthCheckValidationError struct {
// contains filtered or unexported fields
}HealthCheck_HttpHealthCheckValidationError is the validation error returned by HealthCheck_HttpHealthCheck.Validate if the designated constraints aren't met.
func (e HealthCheck_HttpHealthCheckValidationError) Cause() error
Cause function returns cause value.
func (e HealthCheck_HttpHealthCheckValidationError) Error() string
Error satisfies the builtin error interface
func (e HealthCheck_HttpHealthCheckValidationError) ErrorName() string
ErrorName returns error name.
func (e HealthCheck_HttpHealthCheckValidationError) Field() string
Field function returns field value.
func (e HealthCheck_HttpHealthCheckValidationError) Key() bool
Key function returns key value.
func (e HealthCheck_HttpHealthCheckValidationError) Reason() string
Reason function returns reason value.
type HealthCheck_HttpHealthCheck_ struct {
// HTTP health check.
HttpHealthCheck *HealthCheck_HttpHealthCheck `protobuf:"bytes,8,opt,name=http_health_check,json=httpHealthCheck,proto3,oneof"`
}type HealthCheck_Payload struct {
// Types that are assignable to Payload:
// *HealthCheck_Payload_Text
// *HealthCheck_Payload_Binary
Payload isHealthCheck_Payload_Payload `protobuf_oneof:"payload"`
// contains filtered or unexported fields
}Describes the encoding of the payload bytes in the payload.
func (*HealthCheck_Payload) Descriptor() ([]byte, []int)
Deprecated: Use HealthCheck_Payload.ProtoReflect.Descriptor instead.
func (x *HealthCheck_Payload) GetBinary() []byte
func (m *HealthCheck_Payload) GetPayload() isHealthCheck_Payload_Payload
func (x *HealthCheck_Payload) GetText() string
func (*HealthCheck_Payload) ProtoMessage()
func (x *HealthCheck_Payload) ProtoReflect() protoreflect.Message
func (x *HealthCheck_Payload) Reset()
func (x *HealthCheck_Payload) String() string
func (m *HealthCheck_Payload) Validate() error
Validate checks the field values on HealthCheck_Payload with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type HealthCheck_PayloadValidationError struct {
// contains filtered or unexported fields
}HealthCheck_PayloadValidationError is the validation error returned by HealthCheck_Payload.Validate if the designated constraints aren't met.
func (e HealthCheck_PayloadValidationError) Cause() error
Cause function returns cause value.
func (e HealthCheck_PayloadValidationError) Error() string
Error satisfies the builtin error interface
func (e HealthCheck_PayloadValidationError) ErrorName() string
ErrorName returns error name.
func (e HealthCheck_PayloadValidationError) Field() string
Field function returns field value.
func (e HealthCheck_PayloadValidationError) Key() bool
Key function returns key value.
func (e HealthCheck_PayloadValidationError) Reason() string
Reason function returns reason value.
type HealthCheck_Payload_Binary struct {
// [#not-implemented-hide:] Binary payload.
Binary []byte `protobuf:"bytes,2,opt,name=binary,proto3,oneof"`
}type HealthCheck_Payload_Text struct {
// Hex encoded payload. E.g., "000000FF".
Text string `protobuf:"bytes,1,opt,name=text,proto3,oneof"`
}type HealthCheck_RedisHealthCheck struct {
// If set, optionally perform ``EXISTS <key>`` instead of ``PING``. A return value
// from Redis of 0 (does not exist) is considered a passing healthcheck. A return value other
// than 0 is considered a failure. This allows the user to mark a Redis instance for maintenance
// by setting the specified key to any value and waiting for traffic to drain.
Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
// contains filtered or unexported fields
}func (*HealthCheck_RedisHealthCheck) Descriptor() ([]byte, []int)
Deprecated: Use HealthCheck_RedisHealthCheck.ProtoReflect.Descriptor instead.
func (x *HealthCheck_RedisHealthCheck) GetKey() string
func (*HealthCheck_RedisHealthCheck) ProtoMessage()
func (x *HealthCheck_RedisHealthCheck) ProtoReflect() protoreflect.Message
func (x *HealthCheck_RedisHealthCheck) Reset()
func (x *HealthCheck_RedisHealthCheck) String() string
func (m *HealthCheck_RedisHealthCheck) Validate() error
Validate checks the field values on HealthCheck_RedisHealthCheck with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type HealthCheck_RedisHealthCheckValidationError struct {
// contains filtered or unexported fields
}HealthCheck_RedisHealthCheckValidationError is the validation error returned by HealthCheck_RedisHealthCheck.Validate if the designated constraints aren't met.
func (e HealthCheck_RedisHealthCheckValidationError) Cause() error
Cause function returns cause value.
func (e HealthCheck_RedisHealthCheckValidationError) Error() string
Error satisfies the builtin error interface
func (e HealthCheck_RedisHealthCheckValidationError) ErrorName() string
ErrorName returns error name.
func (e HealthCheck_RedisHealthCheckValidationError) Field() string
Field function returns field value.
func (e HealthCheck_RedisHealthCheckValidationError) Key() bool
Key function returns key value.
func (e HealthCheck_RedisHealthCheckValidationError) Reason() string
Reason function returns reason value.
type HealthCheck_TcpHealthCheck struct {
// Empty payloads imply a connect-only health check.
Send *HealthCheck_Payload `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 []*HealthCheck_Payload `protobuf:"bytes,2,rep,name=receive,proto3" json:"receive,omitempty"`
// contains filtered or unexported fields
}func (*HealthCheck_TcpHealthCheck) Descriptor() ([]byte, []int)
Deprecated: Use HealthCheck_TcpHealthCheck.ProtoReflect.Descriptor instead.
func (x *HealthCheck_TcpHealthCheck) GetReceive() []*HealthCheck_Payload
func (x *HealthCheck_TcpHealthCheck) GetSend() *HealthCheck_Payload
func (*HealthCheck_TcpHealthCheck) ProtoMessage()
func (x *HealthCheck_TcpHealthCheck) ProtoReflect() protoreflect.Message
func (x *HealthCheck_TcpHealthCheck) Reset()
func (x *HealthCheck_TcpHealthCheck) String() string
func (m *HealthCheck_TcpHealthCheck) Validate() error
Validate checks the field values on HealthCheck_TcpHealthCheck with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type HealthCheck_TcpHealthCheckValidationError struct {
// contains filtered or unexported fields
}HealthCheck_TcpHealthCheckValidationError is the validation error returned by HealthCheck_TcpHealthCheck.Validate if the designated constraints aren't met.
func (e HealthCheck_TcpHealthCheckValidationError) Cause() error
Cause function returns cause value.
func (e HealthCheck_TcpHealthCheckValidationError) Error() string
Error satisfies the builtin error interface
func (e HealthCheck_TcpHealthCheckValidationError) ErrorName() string
ErrorName returns error name.
func (e HealthCheck_TcpHealthCheckValidationError) Field() string
Field function returns field value.
func (e HealthCheck_TcpHealthCheckValidationError) Key() bool
Key function returns key value.
func (e HealthCheck_TcpHealthCheckValidationError) Reason() string
Reason function returns reason value.
type HealthCheck_TcpHealthCheck_ struct {
// TCP health check.
TcpHealthCheck *HealthCheck_TcpHealthCheck `protobuf:"bytes,9,opt,name=tcp_health_check,json=tcpHealthCheck,proto3,oneof"`
}type HealthCheck_TlsOptions struct {
// Specifies the ALPN protocols for health check connections. This is useful if the
// corresponding upstream is using ALPN-based :ref:`FilterChainMatch
// <envoy_api_msg_listener.FilterChainMatch>` along with different protocols for health checks
// versus data connections. If empty, no ALPN protocols will be set on health check connections.
AlpnProtocols []string `protobuf:"bytes,1,rep,name=alpn_protocols,json=alpnProtocols,proto3" json:"alpn_protocols,omitempty"`
// contains filtered or unexported fields
}Health checks occur over the transport socket specified for the cluster. This implies that if a cluster is using a TLS-enabled transport socket, the health check will also occur over TLS.
This allows overriding the cluster TLS settings, just for health check connections.
func (*HealthCheck_TlsOptions) Descriptor() ([]byte, []int)
Deprecated: Use HealthCheck_TlsOptions.ProtoReflect.Descriptor instead.
func (x *HealthCheck_TlsOptions) GetAlpnProtocols() []string
func (*HealthCheck_TlsOptions) ProtoMessage()
func (x *HealthCheck_TlsOptions) ProtoReflect() protoreflect.Message
func (x *HealthCheck_TlsOptions) Reset()
func (x *HealthCheck_TlsOptions) String() string
func (m *HealthCheck_TlsOptions) Validate() error
Validate checks the field values on HealthCheck_TlsOptions with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type HealthCheck_TlsOptionsValidationError struct {
// contains filtered or unexported fields
}HealthCheck_TlsOptionsValidationError is the validation error returned by HealthCheck_TlsOptions.Validate if the designated constraints aren't met.
func (e HealthCheck_TlsOptionsValidationError) Cause() error
Cause function returns cause value.
func (e HealthCheck_TlsOptionsValidationError) Error() string
Error satisfies the builtin error interface
func (e HealthCheck_TlsOptionsValidationError) ErrorName() string
ErrorName returns error name.
func (e HealthCheck_TlsOptionsValidationError) Field() string
Field function returns field value.
func (e HealthCheck_TlsOptionsValidationError) Key() bool
Key function returns key value.
func (e HealthCheck_TlsOptionsValidationError) Reason() string
Reason function returns reason value.
Endpoint health status.
const (
// The health status is not known. This is interpreted by Envoy as *HEALTHY*.
HealthStatus_UNKNOWN HealthStatus = 0
// Healthy.
HealthStatus_HEALTHY HealthStatus = 1
// Unhealthy.
HealthStatus_UNHEALTHY HealthStatus = 2
// Connection draining in progress. E.g.,
// `<https://aws.amazon.com/blogs/aws/elb-connection-draining-remove-instances-from-service-with-care/>`_
// or
// `<https://cloud.google.com/compute/docs/load-balancing/enabling-connection-draining>`_.
// This is interpreted by Envoy as *UNHEALTHY*.
HealthStatus_DRAINING HealthStatus = 3
// Health check timed out. This is part of HDS and is interpreted by Envoy as
// *UNHEALTHY*.
HealthStatus_TIMEOUT HealthStatus = 4
// Degraded.
HealthStatus_DEGRADED HealthStatus = 5
)func (HealthStatus) Descriptor() protoreflect.EnumDescriptor
func (x HealthStatus) Enum() *HealthStatus
func (HealthStatus) EnumDescriptor() ([]byte, []int)
Deprecated: Use HealthStatus.Descriptor instead.
func (x HealthStatus) Number() protoreflect.EnumNumber
func (x HealthStatus) String() string
func (HealthStatus) Type() protoreflect.EnumType
type Http1ProtocolOptions struct {
// Handle HTTP requests with absolute URLs in the requests. These requests
// are generally sent by clients to forward/explicit proxies. This allows clients to configure
// envoy as their HTTP proxy. In Unix, for example, this is typically done by setting the
// *http_proxy* environment variable.
AllowAbsoluteUrl *wrappers.BoolValue `protobuf:"bytes,1,opt,name=allow_absolute_url,json=allowAbsoluteUrl,proto3" json:"allow_absolute_url,omitempty"`
// Handle incoming HTTP/1.0 and HTTP 0.9 requests.
// This is off by default, and not fully standards compliant. There is support for pre-HTTP/1.1
// style connect logic, dechunking, and handling lack of client host iff
// *default_host_for_http_10* is configured.
AcceptHttp_10 bool `protobuf:"varint,2,opt,name=accept_http_10,json=acceptHttp10,proto3" json:"accept_http_10,omitempty"`
// A default host for HTTP/1.0 requests. This is highly suggested if *accept_http_10* is true as
// Envoy does not otherwise support HTTP/1.0 without a Host header.
// This is a no-op if *accept_http_10* is not true.
DefaultHostForHttp_10 string `protobuf:"bytes,3,opt,name=default_host_for_http_10,json=defaultHostForHttp10,proto3" json:"default_host_for_http_10,omitempty"`
// Describes how the keys for response headers should be formatted. By default, all header keys
// are lower cased.
HeaderKeyFormat *Http1ProtocolOptions_HeaderKeyFormat `protobuf:"bytes,4,opt,name=header_key_format,json=headerKeyFormat,proto3" json:"header_key_format,omitempty"`
// Enables trailers for HTTP/1. By default the HTTP/1 codec drops proxied trailers.
//
// .. attention::
//
// Note that this only happens when Envoy is chunk encoding which occurs when:
// - The request is HTTP/1.1.
// - Is neither a HEAD only request nor a HTTP Upgrade.
// - Not a response to a HEAD request.
// - The content length header is not present.
EnableTrailers bool `protobuf:"varint,5,opt,name=enable_trailers,json=enableTrailers,proto3" json:"enable_trailers,omitempty"`
// contains filtered or unexported fields
}[#next-free-field: 6]
func (*Http1ProtocolOptions) Descriptor() ([]byte, []int)
Deprecated: Use Http1ProtocolOptions.ProtoReflect.Descriptor instead.
func (x *Http1ProtocolOptions) GetAcceptHttp_10() bool
func (x *Http1ProtocolOptions) GetAllowAbsoluteUrl() *wrappers.BoolValue
func (x *Http1ProtocolOptions) GetDefaultHostForHttp_10() string
func (x *Http1ProtocolOptions) GetEnableTrailers() bool
func (x *Http1ProtocolOptions) GetHeaderKeyFormat() *Http1ProtocolOptions_HeaderKeyFormat
func (*Http1ProtocolOptions) ProtoMessage()
func (x *Http1ProtocolOptions) ProtoReflect() protoreflect.Message
func (x *Http1ProtocolOptions) Reset()
func (x *Http1ProtocolOptions) String() string
func (m *Http1ProtocolOptions) Validate() error
Validate checks the field values on Http1ProtocolOptions with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type Http1ProtocolOptionsValidationError struct {
// contains filtered or unexported fields
}Http1ProtocolOptionsValidationError is the validation error returned by Http1ProtocolOptions.Validate if the designated constraints aren't met.
func (e Http1ProtocolOptionsValidationError) Cause() error
Cause function returns cause value.
func (e Http1ProtocolOptionsValidationError) Error() string
Error satisfies the builtin error interface
func (e Http1ProtocolOptionsValidationError) ErrorName() string
ErrorName returns error name.
func (e Http1ProtocolOptionsValidationError) Field() string
Field function returns field value.
func (e Http1ProtocolOptionsValidationError) Key() bool
Key function returns key value.
func (e Http1ProtocolOptionsValidationError) Reason() string
Reason function returns reason value.
type Http1ProtocolOptions_HeaderKeyFormat struct {
// Types that are assignable to HeaderFormat:
// *Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWords_
HeaderFormat isHttp1ProtocolOptions_HeaderKeyFormat_HeaderFormat `protobuf_oneof:"header_format"`
// contains filtered or unexported fields
}func (*Http1ProtocolOptions_HeaderKeyFormat) Descriptor() ([]byte, []int)
Deprecated: Use Http1ProtocolOptions_HeaderKeyFormat.ProtoReflect.Descriptor instead.
func (m *Http1ProtocolOptions_HeaderKeyFormat) GetHeaderFormat() isHttp1ProtocolOptions_HeaderKeyFormat_HeaderFormat
func (x *Http1ProtocolOptions_HeaderKeyFormat) GetProperCaseWords() *Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWords
func (*Http1ProtocolOptions_HeaderKeyFormat) ProtoMessage()
func (x *Http1ProtocolOptions_HeaderKeyFormat) ProtoReflect() protoreflect.Message
func (x *Http1ProtocolOptions_HeaderKeyFormat) Reset()
func (x *Http1ProtocolOptions_HeaderKeyFormat) String() string
func (m *Http1ProtocolOptions_HeaderKeyFormat) Validate() error
Validate checks the field values on Http1ProtocolOptions_HeaderKeyFormat with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type Http1ProtocolOptions_HeaderKeyFormatValidationError struct {
// contains filtered or unexported fields
}Http1ProtocolOptions_HeaderKeyFormatValidationError is the validation error returned by Http1ProtocolOptions_HeaderKeyFormat.Validate if the designated constraints aren't met.
func (e Http1ProtocolOptions_HeaderKeyFormatValidationError) Cause() error
Cause function returns cause value.
func (e Http1ProtocolOptions_HeaderKeyFormatValidationError) Error() string
Error satisfies the builtin error interface
func (e Http1ProtocolOptions_HeaderKeyFormatValidationError) ErrorName() string
ErrorName returns error name.
func (e Http1ProtocolOptions_HeaderKeyFormatValidationError) Field() string
Field function returns field value.
func (e Http1ProtocolOptions_HeaderKeyFormatValidationError) Key() bool
Key function returns key value.
func (e Http1ProtocolOptions_HeaderKeyFormatValidationError) Reason() string
Reason function returns reason value.
type Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWords struct {
// contains filtered or unexported fields
}func (*Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWords) Descriptor() ([]byte, []int)
Deprecated: Use Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWords.ProtoReflect.Descriptor instead.
func (*Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWords) ProtoMessage()
func (x *Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWords) ProtoReflect() protoreflect.Message
func (x *Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWords) Reset()
func (x *Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWords) String() string
func (m *Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWords) Validate() error
Validate checks the field values on Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWords with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
type Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWordsValidationError struct {
// contains filtered or unexported fields
}Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWordsValidationError is the validation error returned by Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWords.Validate if the designated constraints aren't met.
Cause function returns cause value.
Error satisfies the builtin error interface
func (e Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWordsValidationError) ErrorName() string
ErrorName returns error name.
Field function returns field value.
Key function returns key value.
func (e Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWordsValidationError) Reason() string
Reason function returns reason value.
type Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWords_ struct {
// Formats the header by proper casing words: the first character and any character following
// a special character will be capitalized if it's an alpha character. For example,
// "content-type" becomes "Content-Type", and "foo$b#$are" becomes "Foo$B#$Are".
// Note that while this results in most headers following conventional casing, certain headers
// are not covered. For example, the "TE" header will be formatted as "Te".
ProperCaseWords *Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWords `protobuf:"bytes,1,opt,name=proper_case_words,json=properCaseWords,proto3,oneof"`
}type Http2ProtocolOptions struct {
// `Maximum table size <https://httpwg.org/specs/rfc7541.html#rfc.section.4.2>`_
// (in octets) that the encoder is permitted to use for the dynamic HPACK table. Valid values
// range from 0 to 4294967295 (2^32 - 1) and defaults to 4096. 0 effectively disables header
// compression.
HpackTableSize *wrappers.UInt32Value `protobuf:"bytes,1,opt,name=hpack_table_size,json=hpackTableSize,proto3" json:"hpack_table_size,omitempty"`
// `Maximum concurrent streams <https://httpwg.org/specs/rfc7540.html#rfc.section.5.1.2>`_
// allowed for peer on one HTTP/2 connection. Valid values range from 1 to 2147483647 (2^31 - 1)
// and defaults to 2147483647.
//
// For upstream connections, this also limits how many streams Envoy will initiate concurrently
// on a single connection. If the limit is reached, Envoy may queue requests or establish
// additional connections (as allowed per circuit breaker limits).
MaxConcurrentStreams *wrappers.UInt32Value `protobuf:"bytes,2,opt,name=max_concurrent_streams,json=maxConcurrentStreams,proto3" json:"max_concurrent_streams,omitempty"`
// `Initial stream-level flow-control window
// <https://httpwg.org/specs/rfc7540.html#rfc.section.6.9.2>`_ size. Valid values range from 65535
// (2^16 - 1, HTTP/2 default) to 2147483647 (2^31 - 1, HTTP/2 maximum) and defaults to 268435456
// (256 * 1024 * 1024).
//
// NOTE: 65535 is the initial window size from HTTP/2 spec. We only support increasing the default
// window size now, so it's also the minimum.
//
// This field also acts as a soft limit on the number of bytes Envoy will buffer per-stream in the
// HTTP/2 codec buffers. Once the buffer reaches this pointer, watermark callbacks will fire to
// stop the flow of data to the codec buffers.
InitialStreamWindowSize *wrappers.UInt32Value `protobuf:"bytes,3,opt,name=initial_stream_window_size,json=initialStreamWindowSize,proto3" json:"initial_stream_window_size,omitempty"`
// Similar to *initial_stream_window_size*, but for connection-level flow-control
// window. Currently, this has the same minimum/maximum/default as *initial_stream_window_size*.
InitialConnectionWindowSize *wrappers.UInt32Value `protobuf:"bytes,4,opt,name=initial_connection_window_size,json=initialConnectionWindowSize,proto3" json:"initial_connection_window_size,omitempty"`
// Allows proxying Websocket and other upgrades over H2 connect.
AllowConnect bool `protobuf:"varint,5,opt,name=allow_connect,json=allowConnect,proto3" json:"allow_connect,omitempty"`
// [#not-implemented-hide:] Hiding until envoy has full metadata support.
// Still under implementation. DO NOT USE.
//
// Allows metadata. See [metadata
// docs](https://github.com/envoyproxy/envoy/blob/main/source/docs/h2_metadata.md) for more
// information.
AllowMetadata bool `protobuf:"varint,6,opt,name=allow_metadata,json=allowMetadata,proto3" json:"allow_metadata,omitempty"`
// Limit the number of pending outbound downstream frames of all types (frames that are waiting to
// be written into the socket). Exceeding this limit triggers flood mitigation and connection is
// terminated. The ``http2.outbound_flood`` stat tracks the number of terminated connections due
// to flood mitigation. The default limit is 10000.
// [#comment:TODO: implement same limits for upstream outbound frames as well.]
MaxOutboundFrames *wrappers.UInt32Value `protobuf:"bytes,7,opt,name=max_outbound_frames,json=maxOutboundFrames,proto3" json:"max_outbound_frames,omitempty"`
// Limit the number of pending outbound downstream frames of types PING, SETTINGS and RST_STREAM,
// preventing high memory utilization when receiving continuous stream of these frames. Exceeding
// this limit triggers flood mitigation and connection is terminated. The
// ``http2.outbound_control_flood`` stat tracks the number of terminated connections due to flood
// mitigation. The default limit is 1000.
// [#comment:TODO: implement same limits for upstream outbound frames as well.]
MaxOutboundControlFrames *wrappers.UInt32Value `protobuf:"bytes,8,opt,name=max_outbound_control_frames,json=maxOutboundControlFrames,proto3" json:"max_outbound_control_frames,omitempty"`
// Limit the number of consecutive inbound frames of types HEADERS, CONTINUATION and DATA with an
// empty payload and no end stream flag. Those frames have no legitimate use and are abusive, but
// might be a result of a broken HTTP/2 implementation. The `http2.inbound_empty_frames_flood``
// stat tracks the number of connections terminated due to flood mitigation.
// Setting this to 0 will terminate connection upon receiving first frame with an empty payload
// and no end stream flag. The default limit is 1.
// [#comment:TODO: implement same limits for upstream inbound frames as well.]
MaxConsecutiveInboundFramesWithEmptyPayload *wrappers.UInt32Value `protobuf:"bytes,9,opt,name=max_consecutive_inbound_frames_with_empty_payload,json=maxConsecutiveInboundFramesWithEmptyPayload,proto3" json:"max_consecutive_inbound_frames_with_empty_payload,omitempty"`
// Limit the number of inbound PRIORITY frames allowed per each opened stream. If the number