# Constants
gRPC v2 API.
REST-JSON v2 API.
REST-JSON legacy corresponds to the v1 API.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Connection draining in progress.
Healthy.
Health check timed out.
Unhealthy.
The health status is not known.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Socket options are applied after binding the socket to a port but before calling listen().
Socket options are applied after calling listen().
Socket options are applied after socket creation but before binding the socket to a port.
No description provided by the author
No description provided by the author
[#not-implemented-hide:].
# Variables
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Structs
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.
No description provided by the author
No description provided by the author
AddressValidationError is the validation error returned by Address.Validate if the designated constraints aren't met.
Aggregated Discovery Service (ADS) options.
AggregatedConfigSourceValidationError is the validation error returned by AggregatedConfigSource.Validate if the designated constraints aren't met.
API configuration source.
ApiConfigSourceValidationError is the validation error returned by ApiConfigSource.Validate if the designated constraints aren't met.
No description provided by the author
BindConfigValidationError is the validation error returned by BindConfig.Validate if the designated constraints aren't met.
CidrRange specifies an IP Address and a prefix length to construct the subnet mask for a `CIDR <https://tools.ietf.org/html/rfc4632>`_ range.
CidrRangeValidationError is the validation error returned by CidrRange.Validate if the designated constraints aren't met.
Configuration for :ref:`listeners <config_listeners>`, :ref:`clusters <config_cluster_manager>`, :ref:`routes <envoy_api_msg_RouteConfiguration>`, :ref:`endpoints <arch_overview_service_discovery>` etc.
No description provided by the author
No description provided by the author
No description provided by the author
ConfigSourceValidationError is the validation error returned by ConfigSource.Validate if the designated constraints aren't met.
Data source consisting of either a file or an inline value.
No description provided by the author
No description provided by the author
No description provided by the author
DataSourceValidationError is the validation error returned by DataSource.Validate if the designated constraints aren't met.
[#not-implemented-hide:].
GrpcProtocolOptionsValidationError is the validation error returned by GrpcProtocolOptions.Validate if the designated constraints aren't met.
gRPC service configuration.
No description provided by the author
No description provided by the author
GrpcService_EnvoyGrpcValidationError is the validation error returned by GrpcService_EnvoyGrpc.Validate if the designated constraints aren't met.
[#proto-status: draft].
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentialsValidationError is the validation error returned by GrpcService_GoogleGrpc_CallCredentials_GoogleIAMCredentials.Validate if the designated constraints aren't met.
No description provided by the author
No description provided by the author
GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPluginValidationError is the validation error returned by GrpcService_GoogleGrpc_CallCredentials_MetadataCredentialsFromPlugin.Validate if the designated constraints aren't met.
No description provided by the author
No description provided by the author
GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentialsValidationError is the validation error returned by GrpcService_GoogleGrpc_CallCredentials_ServiceAccountJWTAccessCredentials.Validate if the designated constraints aren't met.
GrpcService_GoogleGrpc_CallCredentialsValidationError is the validation error returned by GrpcService_GoogleGrpc_CallCredentials.Validate if the designated constraints aren't met.
See https://grpc.io/docs/guides/auth.html#credential-types to understand Channel and Call credential types.
No description provided by the author
No description provided by the author
No description provided by the author
GrpcService_GoogleGrpc_ChannelCredentialsValidationError is the validation error returned by GrpcService_GoogleGrpc_ChannelCredentials.Validate if the designated constraints aren't met.
Local channel credentials.
GrpcService_GoogleGrpc_GoogleLocalCredentialsValidationError is the validation error returned by GrpcService_GoogleGrpc_GoogleLocalCredentials.Validate if the designated constraints aren't met.
See https://grpc.io/grpc/cpp/structgrpc_1_1_ssl_credentials_options.html.
GrpcService_GoogleGrpc_SslCredentialsValidationError is the validation error returned by GrpcService_GoogleGrpc_SslCredentials.Validate if the designated constraints aren't met.
GrpcService_GoogleGrpcValidationError is the validation error returned by GrpcService_GoogleGrpc.Validate if the designated constraints aren't met.
GrpcServiceValidationError is the validation error returned by GrpcService.Validate if the designated constraints aren't met.
Header name/value pair.
Header name/value pair plus option to control append behavior.
HeaderValueOptionValidationError is the validation error returned by HeaderValueOption.Validate if the designated constraints aren't met.
HeaderValueValidationError is the validation error returned by HeaderValue.Validate if the designated constraints aren't met.
No description provided by the author
Custom health check.
No description provided by the author
HealthCheck_CustomHealthCheckValidationError is the validation error returned by HealthCheck_CustomHealthCheck.Validate if the designated constraints aren't met.
`grpc.health.v1.Health <https://github.com/grpc/grpc/blob/master/src/proto/grpc/health/v1/health.proto>`_-based healthcheck.
No description provided by the author
HealthCheck_GrpcHealthCheckValidationError is the validation error returned by HealthCheck_GrpcHealthCheck.Validate if the designated constraints aren't met.
[#comment:next free field: 9].
No description provided by the author
HealthCheck_HttpHealthCheckValidationError is the validation error returned by HealthCheck_HttpHealthCheck.Validate if the designated constraints aren't met.
Describes the encoding of the payload bytes in the payload.
No description provided by the author
No description provided by the author
HealthCheck_PayloadValidationError is the validation error returned by HealthCheck_Payload.Validate if the designated constraints aren't met.
No description provided by the author
HealthCheck_RedisHealthCheckValidationError is the validation error returned by HealthCheck_RedisHealthCheck.Validate if the designated constraints aren't met.
No description provided by the author
No description provided by the author
HealthCheck_TcpHealthCheckValidationError is the validation error returned by HealthCheck_TcpHealthCheck.Validate if the designated constraints aren't met.
HealthCheckValidationError is the validation error returned by HealthCheck.Validate if the designated constraints aren't met.
No description provided by the author
Http1ProtocolOptionsValidationError is the validation error returned by Http1ProtocolOptions.Validate if the designated constraints aren't met.
No description provided by the author
Http2ProtocolOptionsValidationError is the validation error returned by Http2ProtocolOptions.Validate if the designated constraints aren't met.
No description provided by the author
HttpProtocolOptionsValidationError is the validation error returned by HttpProtocolOptions.Validate if the designated constraints aren't met.
Envoy external URI descriptor.
No description provided by the author
HttpUriValidationError is the validation error returned by HttpUri.Validate if the designated constraints aren't met.
Identifies location of where either Envoy runs or where upstream hosts run.
LocalityValidationError is the validation error returned by Locality.Validate if the designated constraints aren't met.
Metadata provides additional inputs to filters based on matched listeners, filter chains, routes and endpoints.
MetadataValidationError is the validation error returned by Metadata.Validate if the designated constraints aren't met.
Identifies a specific Envoy instance.
NodeValidationError is the validation error returned by Node.Validate if the designated constraints aren't met.
No description provided by the author
PipeValidationError is the validation error returned by Pipe.Validate if the designated constraints aren't met.
Runtime derived FractionalPercent with defaults for when the numerator or denominator is not specified via a runtime key.
RuntimeFractionalPercentValidationError is the validation error returned by RuntimeFractionalPercent.Validate if the designated constraints aren't met.
Runtime derived uint32 with a default when not specified.
RuntimeUInt32ValidationError is the validation error returned by RuntimeUInt32.Validate if the designated constraints aren't met.
No description provided by the author
No description provided by the author
No description provided by the author
SocketAddressValidationError is the validation error returned by SocketAddress.Validate if the designated constraints aren't met.
Generic socket option message.
No description provided by the author
No description provided by the author
SocketOptionValidationError is the validation error returned by SocketOption.Validate if the designated constraints aren't met.
No description provided by the author
TcpKeepaliveValidationError is the validation error returned by TcpKeepalive.Validate if the designated constraints aren't met.
[#not-implemented-hide:].
TcpProtocolOptionsValidationError is the validation error returned by TcpProtocolOptions.Validate if the designated constraints aren't met.
Configuration for transport socket in :ref:`listeners <config_listeners>` and :ref:`clusters <envoy_api_msg_Cluster>`.
TransportSocketValidationError is the validation error returned by TransportSocket.Validate if the designated constraints aren't met.
# Type aliases
APIs may be fetched via either REST or gRPC.
Endpoint health status.
HTTP request method.
Envoy supports :ref:`upstream priority routing <arch_overview_http_routing_priority>` both at the route and the virtual cluster level.
No description provided by the author
No description provided by the author