var File_envoy_extensions_upstreams_http_v4alpha_http_protocol_options_proto protoreflect.FileDescriptor
HttpProtocolOptions specifies Http upstream protocol options. This object is used in :ref:`typed_extension_protocol_options<envoy_api_field_config.cluster.v4alpha.Cluster.typed_extension_protocol_options>`, keyed by the name `envoy.extensions.upstreams.http.v3.HttpProtocolOptions`.
This controls what protocol(s) should be used for upstream and how said protocol(s) are configured.
This replaces the prior pattern of explicit protocol configuration directly in the cluster. So a configuration like this, explicitly configuring the use of HTTP/2 upstream:
.. code::
clusters:
- name: some_service
connect_timeout: 5s
upstream_http_protocol_options:
auto_sni: true
common_http_protocol_options:
idle_timeout: 1s
http2_protocol_options:
max_concurrent_streams: 100
.... [further cluster config]
Would now look like this:
.. code::
clusters:
- name: some_service
connect_timeout: 5s
typed_extension_protocol_options:
envoy.extensions.upstreams.http.v3.HttpProtocolOptions:
"@type": type.googleapis.com/envoy.extensions.upstreams.http.v3.HttpProtocolOptions
upstream_http_protocol_options:
auto_sni: true
common_http_protocol_options:
idle_timeout: 1s
explicit_http_config:
http2_protocol_options:
max_concurrent_streams: 100
.... [further cluster config]
[#next-free-field: 6]
type HttpProtocolOptions struct {
// This contains options common across HTTP/1 and HTTP/2
CommonHttpProtocolOptions *v4alpha.HttpProtocolOptions `protobuf:"bytes,1,opt,name=common_http_protocol_options,json=commonHttpProtocolOptions,proto3" json:"common_http_protocol_options,omitempty"`
// This contains common protocol options which are only applied upstream.
UpstreamHttpProtocolOptions *v4alpha.UpstreamHttpProtocolOptions `protobuf:"bytes,2,opt,name=upstream_http_protocol_options,json=upstreamHttpProtocolOptions,proto3" json:"upstream_http_protocol_options,omitempty"`
// This controls the actual protocol to be used upstream.
//
// Types that are assignable to UpstreamProtocolOptions:
// *HttpProtocolOptions_ExplicitHttpConfig_
// *HttpProtocolOptions_UseDownstreamProtocolConfig
// *HttpProtocolOptions_AutoConfig
UpstreamProtocolOptions isHttpProtocolOptions_UpstreamProtocolOptions `protobuf_oneof:"upstream_protocol_options"`
// contains filtered or unexported fields
}
func (*HttpProtocolOptions) Descriptor() ([]byte, []int)
Deprecated: Use HttpProtocolOptions.ProtoReflect.Descriptor instead.
func (x *HttpProtocolOptions) GetAutoConfig() *HttpProtocolOptions_AutoHttpConfig
func (x *HttpProtocolOptions) GetCommonHttpProtocolOptions() *v4alpha.HttpProtocolOptions
func (x *HttpProtocolOptions) GetExplicitHttpConfig() *HttpProtocolOptions_ExplicitHttpConfig
func (x *HttpProtocolOptions) GetUpstreamHttpProtocolOptions() *v4alpha.UpstreamHttpProtocolOptions
func (m *HttpProtocolOptions) GetUpstreamProtocolOptions() isHttpProtocolOptions_UpstreamProtocolOptions
func (x *HttpProtocolOptions) GetUseDownstreamProtocolConfig() *HttpProtocolOptions_UseDownstreamHttpConfig
func (*HttpProtocolOptions) ProtoMessage()
func (x *HttpProtocolOptions) ProtoReflect() protoreflect.Message
func (x *HttpProtocolOptions) Reset()
func (x *HttpProtocolOptions) String() string
func (m *HttpProtocolOptions) Validate() error
Validate checks the field values on HttpProtocolOptions with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
HttpProtocolOptionsValidationError is the validation error returned by HttpProtocolOptions.Validate if the designated constraints aren't met.
type HttpProtocolOptionsValidationError struct {
// contains filtered or unexported fields
}
func (e HttpProtocolOptionsValidationError) Cause() error
Cause function returns cause value.
func (e HttpProtocolOptionsValidationError) Error() string
Error satisfies the builtin error interface
func (e HttpProtocolOptionsValidationError) ErrorName() string
ErrorName returns error name.
func (e HttpProtocolOptionsValidationError) Field() string
Field function returns field value.
func (e HttpProtocolOptionsValidationError) Key() bool
Key function returns key value.
func (e HttpProtocolOptionsValidationError) Reason() string
Reason function returns reason value.
type HttpProtocolOptions_AutoConfig struct {
// This allows switching on protocol based on ALPN
AutoConfig *HttpProtocolOptions_AutoHttpConfig `protobuf:"bytes,5,opt,name=auto_config,json=autoConfig,proto3,oneof"`
}
If this is used, the cluster can use either HTTP/1 or HTTP/2, and will use whichever protocol is negotiated by ALPN with the upstream. Clusters configured with *AutoHttpConfig* will use the highest available protocol; HTTP/2 if supported, otherwise HTTP/1. If the upstream does not support ALPN, *AutoHttpConfig* will fail over to HTTP/1. This can only be used with transport sockets which support ALPN. Using a transport socket which does not support ALPN will result in configuration failure. The transport layer may be configured with custom ALPN, but the default ALPN for the cluster (or if custom ALPN fails) will be "h2,http/1.1".
type HttpProtocolOptions_AutoHttpConfig struct {
HttpProtocolOptions *v4alpha.Http1ProtocolOptions `protobuf:"bytes,1,opt,name=http_protocol_options,json=httpProtocolOptions,proto3" json:"http_protocol_options,omitempty"`
Http2ProtocolOptions *v4alpha.Http2ProtocolOptions `protobuf:"bytes,2,opt,name=http2_protocol_options,json=http2ProtocolOptions,proto3" json:"http2_protocol_options,omitempty"`
// contains filtered or unexported fields
}
func (*HttpProtocolOptions_AutoHttpConfig) Descriptor() ([]byte, []int)
Deprecated: Use HttpProtocolOptions_AutoHttpConfig.ProtoReflect.Descriptor instead.
func (x *HttpProtocolOptions_AutoHttpConfig) GetHttp2ProtocolOptions() *v4alpha.Http2ProtocolOptions
func (x *HttpProtocolOptions_AutoHttpConfig) GetHttpProtocolOptions() *v4alpha.Http1ProtocolOptions
func (*HttpProtocolOptions_AutoHttpConfig) ProtoMessage()
func (x *HttpProtocolOptions_AutoHttpConfig) ProtoReflect() protoreflect.Message
func (x *HttpProtocolOptions_AutoHttpConfig) Reset()
func (x *HttpProtocolOptions_AutoHttpConfig) String() string
func (m *HttpProtocolOptions_AutoHttpConfig) Validate() error
Validate checks the field values on HttpProtocolOptions_AutoHttpConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
HttpProtocolOptions_AutoHttpConfigValidationError is the validation error returned by HttpProtocolOptions_AutoHttpConfig.Validate if the designated constraints aren't met.
type HttpProtocolOptions_AutoHttpConfigValidationError struct {
// contains filtered or unexported fields
}
func (e HttpProtocolOptions_AutoHttpConfigValidationError) Cause() error
Cause function returns cause value.
func (e HttpProtocolOptions_AutoHttpConfigValidationError) Error() string
Error satisfies the builtin error interface
func (e HttpProtocolOptions_AutoHttpConfigValidationError) ErrorName() string
ErrorName returns error name.
func (e HttpProtocolOptions_AutoHttpConfigValidationError) Field() string
Field function returns field value.
func (e HttpProtocolOptions_AutoHttpConfigValidationError) Key() bool
Key function returns key value.
func (e HttpProtocolOptions_AutoHttpConfigValidationError) Reason() string
Reason function returns reason value.
If this is used, the cluster will only operate on one of the possible upstream protocols (HTTP/1.1, HTTP/2). Note that HTTP/2 should generally be used for upstream clusters doing gRPC.
type HttpProtocolOptions_ExplicitHttpConfig struct {
// Types that are assignable to ProtocolConfig:
// *HttpProtocolOptions_ExplicitHttpConfig_HttpProtocolOptions
// *HttpProtocolOptions_ExplicitHttpConfig_Http2ProtocolOptions
ProtocolConfig isHttpProtocolOptions_ExplicitHttpConfig_ProtocolConfig `protobuf_oneof:"protocol_config"`
// contains filtered or unexported fields
}
func (*HttpProtocolOptions_ExplicitHttpConfig) Descriptor() ([]byte, []int)
Deprecated: Use HttpProtocolOptions_ExplicitHttpConfig.ProtoReflect.Descriptor instead.
func (x *HttpProtocolOptions_ExplicitHttpConfig) GetHttp2ProtocolOptions() *v4alpha.Http2ProtocolOptions
func (x *HttpProtocolOptions_ExplicitHttpConfig) GetHttpProtocolOptions() *v4alpha.Http1ProtocolOptions
func (m *HttpProtocolOptions_ExplicitHttpConfig) GetProtocolConfig() isHttpProtocolOptions_ExplicitHttpConfig_ProtocolConfig
func (*HttpProtocolOptions_ExplicitHttpConfig) ProtoMessage()
func (x *HttpProtocolOptions_ExplicitHttpConfig) ProtoReflect() protoreflect.Message
func (x *HttpProtocolOptions_ExplicitHttpConfig) Reset()
func (x *HttpProtocolOptions_ExplicitHttpConfig) String() string
func (m *HttpProtocolOptions_ExplicitHttpConfig) Validate() error
Validate checks the field values on HttpProtocolOptions_ExplicitHttpConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
HttpProtocolOptions_ExplicitHttpConfigValidationError is the validation error returned by HttpProtocolOptions_ExplicitHttpConfig.Validate if the designated constraints aren't met.
type HttpProtocolOptions_ExplicitHttpConfigValidationError struct {
// contains filtered or unexported fields
}
func (e HttpProtocolOptions_ExplicitHttpConfigValidationError) Cause() error
Cause function returns cause value.
func (e HttpProtocolOptions_ExplicitHttpConfigValidationError) Error() string
Error satisfies the builtin error interface
func (e HttpProtocolOptions_ExplicitHttpConfigValidationError) ErrorName() string
ErrorName returns error name.
func (e HttpProtocolOptions_ExplicitHttpConfigValidationError) Field() string
Field function returns field value.
func (e HttpProtocolOptions_ExplicitHttpConfigValidationError) Key() bool
Key function returns key value.
func (e HttpProtocolOptions_ExplicitHttpConfigValidationError) Reason() string
Reason function returns reason value.
type HttpProtocolOptions_ExplicitHttpConfig_ struct {
// To explicitly configure either HTTP/1 or HTTP/2 (but not both!) use *explicit_http_config*.
// If the *explicit_http_config* is empty, HTTP/1.1 is used.
ExplicitHttpConfig *HttpProtocolOptions_ExplicitHttpConfig `protobuf:"bytes,3,opt,name=explicit_http_config,json=explicitHttpConfig,proto3,oneof"`
}
type HttpProtocolOptions_ExplicitHttpConfig_Http2ProtocolOptions struct {
Http2ProtocolOptions *v4alpha.Http2ProtocolOptions `protobuf:"bytes,2,opt,name=http2_protocol_options,json=http2ProtocolOptions,proto3,oneof"`
}
type HttpProtocolOptions_ExplicitHttpConfig_HttpProtocolOptions struct {
HttpProtocolOptions *v4alpha.Http1ProtocolOptions `protobuf:"bytes,1,opt,name=http_protocol_options,json=httpProtocolOptions,proto3,oneof"`
}
If this is used, the cluster can use either of the configured protocols, and will use whichever protocol was used by the downstream connection.
type HttpProtocolOptions_UseDownstreamHttpConfig struct {
HttpProtocolOptions *v4alpha.Http1ProtocolOptions `protobuf:"bytes,1,opt,name=http_protocol_options,json=httpProtocolOptions,proto3" json:"http_protocol_options,omitempty"`
Http2ProtocolOptions *v4alpha.Http2ProtocolOptions `protobuf:"bytes,2,opt,name=http2_protocol_options,json=http2ProtocolOptions,proto3" json:"http2_protocol_options,omitempty"`
// contains filtered or unexported fields
}
func (*HttpProtocolOptions_UseDownstreamHttpConfig) Descriptor() ([]byte, []int)
Deprecated: Use HttpProtocolOptions_UseDownstreamHttpConfig.ProtoReflect.Descriptor instead.
func (x *HttpProtocolOptions_UseDownstreamHttpConfig) GetHttp2ProtocolOptions() *v4alpha.Http2ProtocolOptions
func (x *HttpProtocolOptions_UseDownstreamHttpConfig) GetHttpProtocolOptions() *v4alpha.Http1ProtocolOptions
func (*HttpProtocolOptions_UseDownstreamHttpConfig) ProtoMessage()
func (x *HttpProtocolOptions_UseDownstreamHttpConfig) ProtoReflect() protoreflect.Message
func (x *HttpProtocolOptions_UseDownstreamHttpConfig) Reset()
func (x *HttpProtocolOptions_UseDownstreamHttpConfig) String() string
func (m *HttpProtocolOptions_UseDownstreamHttpConfig) Validate() error
Validate checks the field values on HttpProtocolOptions_UseDownstreamHttpConfig with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.
HttpProtocolOptions_UseDownstreamHttpConfigValidationError is the validation error returned by HttpProtocolOptions_UseDownstreamHttpConfig.Validate if the designated constraints aren't met.
type HttpProtocolOptions_UseDownstreamHttpConfigValidationError struct {
// contains filtered or unexported fields
}
func (e HttpProtocolOptions_UseDownstreamHttpConfigValidationError) Cause() error
Cause function returns cause value.
func (e HttpProtocolOptions_UseDownstreamHttpConfigValidationError) Error() string
Error satisfies the builtin error interface
func (e HttpProtocolOptions_UseDownstreamHttpConfigValidationError) ErrorName() string
ErrorName returns error name.
func (e HttpProtocolOptions_UseDownstreamHttpConfigValidationError) Field() string
Field function returns field value.
func (e HttpProtocolOptions_UseDownstreamHttpConfigValidationError) Key() bool
Key function returns key value.
func (e HttpProtocolOptions_UseDownstreamHttpConfigValidationError) Reason() string
Reason function returns reason value.
type HttpProtocolOptions_UseDownstreamProtocolConfig struct {
// This allows switching on protocol based on what protocol the downstream
// connection used.
UseDownstreamProtocolConfig *HttpProtocolOptions_UseDownstreamHttpConfig `protobuf:"bytes,4,opt,name=use_downstream_protocol_config,json=useDownstreamProtocolConfig,proto3,oneof"`
}