Package io.envoyproxy.envoy.config.core.v3
package io.envoyproxy.envoy.config.core.v3
-
ClassDescriptionAddresses 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.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.Aggregated Discovery Service (ADS) options.Aggregated Discovery Service (ADS) options.Configures the alternate protocols cache which tracks alternate protocols that can be used to make an HTTP connection to an origin server.Allows pre-populating the cache with HTTP/3 alternate protocols entries with a 7 day lifetime.Allows pre-populating the cache with HTTP/3 alternate protocols entries with a 7 day lifetime.Configures the alternate protocols cache which tracks alternate protocols that can be used to make an HTTP connection to an origin server.API configuration source.APIs may be fetched via either REST or gRPC.API configuration source.xDS API and non-xDS services version.Async data source which support async data fetch.Async data source which support async data fetch.Configuration defining a jittered exponential back off strategy.Configuration defining a jittered exponential back off strategy.[#next-free-field: 7][#next-free-field: 7]BuildVersion combines SemVer version of extension with free-form build information (i.e.BuildVersion combines SemVer version of extension with free-form build information (i.e.CEL expression evaluation configuration.CEL expression evaluation configuration.CidrRange specifies an IP Address and a prefix length to construct the subnet mask for a `CIDR <https://tools.ietf.org/html/rfc4632>`_ range.CidrRange specifies an IP Address and a prefix length to construct the subnet mask for a `CIDR <https://tools.ietf.org/html/rfc4632>`_ range.Configuration for :ref:`listeners <config_listeners>`, :ref:`clusters <config_cluster_manager>`, :ref:`routes <envoy_v3_api_msg_config.route.v3.RouteConfiguration>`, :ref:`endpoints <arch_overview_service_discovery>` etc. may either be sourced from the filesystem or from an xDS API source.Configuration for :ref:`listeners <config_listeners>`, :ref:`clusters <config_cluster_manager>`, :ref:`routes <envoy_v3_api_msg_config.route.v3.RouteConfiguration>`, :ref:`endpoints <arch_overview_service_discovery>` etc. may either be sourced from the filesystem or from an xDS API source.Identifies a specific ControlPlane instance that Envoy is connected to.Identifies a specific ControlPlane instance that Envoy is connected to.Data source consisting of a file, an inline value, or an environment variable.Data source consisting of a file, an inline value, or an environment variable.DNS resolution configuration which includes the underlying dns resolver addresses and options.DNS resolution configuration which includes the underlying dns resolver addresses and options.Configuration of DNS resolver option flags which control the behavior of the DNS resolver.Configuration of DNS resolver option flags which control the behavior of the DNS resolver.The address represents an envoy internal listener.The address represents an envoy internal listener.[#not-implemented-hide:] Configuration of the event reporting service endpoint.[#not-implemented-hide:] Configuration of the event reporting service endpoint.Version and identification for an Envoy extension.Version and identification for an Envoy extension.Configuration source specifier for a late-bound extension configuration.Configuration source specifier for a late-bound extension configuration.Protobuf type
envoy.config.core.v3.ExtraSourceAddressProtobuf typeenvoy.config.core.v3.ExtraSourceAddressA list of gRPC methods which can be used as an allowlist, for example.A list of gRPC methods which can be used as an allowlist, for example.Protobuf typeenvoy.config.core.v3.GrpcMethodList.ServiceProtobuf typeenvoy.config.core.v3.GrpcMethodList.Service[#not-implemented-hide:][#not-implemented-hide:]gRPC service configuration.gRPC service configuration.[#next-free-field: 6][#next-free-field: 6][#next-free-field: 11][#next-free-field: 11][#next-free-field: 8][#next-free-field: 8]Protobuf typeenvoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials.GoogleIAMCredentialsProtobuf typeenvoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials.GoogleIAMCredentialsProtobuf typeenvoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials.MetadataCredentialsFromPluginProtobuf typeenvoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials.MetadataCredentialsFromPluginProtobuf typeenvoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials.ServiceAccountJWTAccessCredentialsProtobuf typeenvoy.config.core.v3.GrpcService.GoogleGrpc.CallCredentials.ServiceAccountJWTAccessCredentialsSecurity token service configuration that allows Google gRPC to fetch security token from an OAuth 2.0 authorization server.Security token service configuration that allows Google gRPC to fetch security token from an OAuth 2.0 authorization server.Channel arguments.Channel arguments.Protobuf typeenvoy.config.core.v3.GrpcService.GoogleGrpc.ChannelArgs.ValueProtobuf typeenvoy.config.core.v3.GrpcService.GoogleGrpc.ChannelArgs.ValueSee https://grpc.io/docs/guides/auth.html#credential-types to understand Channel and Call credential types.See https://grpc.io/docs/guides/auth.html#credential-types to understand Channel and Call credential types.Local channel credentials.Local channel credentials.See https://grpc.io/grpc/cpp/structgrpc_1_1_ssl_credentials_options.html.See https://grpc.io/grpc/cpp/structgrpc_1_1_ssl_credentials_options.html.Wrapper for a set of headers.Wrapper for a set of headers.Header name/value pair.Header name/value pair.Header name/value pair plus option to control append behavior.Header name/value pair plus option to control append behavior.Describes the supported actions types for header append action.[#next-free-field: 27][#next-free-field: 27]Custom health check.Custom health check.`grpc.health.v1.Health <https://github.com/grpc/grpc/blob/master/src/proto/grpc/health/v1/health.proto>`_-based healthcheck.`grpc.health.v1.Health <https://github.com/grpc/grpc/blob/master/src/proto/grpc/health/v1/health.proto>`_-based healthcheck.[#next-free-field: 15][#next-free-field: 15]Describes the encoding of the payload bytes in the payload.Describes the encoding of the payload bytes in the payload.Protobuf typeenvoy.config.core.v3.HealthCheck.RedisHealthCheckProtobuf typeenvoy.config.core.v3.HealthCheck.RedisHealthCheckProtobuf typeenvoy.config.core.v3.HealthCheck.TcpHealthCheckProtobuf typeenvoy.config.core.v3.HealthCheck.TcpHealthCheckHealth checks occur over the transport socket specified for the cluster.Health checks occur over the transport socket specified for the cluster.Endpoint health status.Protobuf typeenvoy.config.core.v3.HealthStatusSetProtobuf typeenvoy.config.core.v3.HealthStatusSet[#next-free-field: 12][#next-free-field: 12][#next-free-field: 9][#next-free-field: 9]Protobuf typeenvoy.config.core.v3.Http1ProtocolOptions.HeaderKeyFormat.ProperCaseWordsProtobuf typeenvoy.config.core.v3.Http1ProtocolOptions.HeaderKeyFormat.ProperCaseWords[#next-free-field: 19][#next-free-field: 19]Defines a parameter to be sent in the SETTINGS frame.Defines a parameter to be sent in the SETTINGS frame.A message which allows using HTTP/3.A message which allows using HTTP/3.[#next-free-field: 8][#next-free-field: 8]Action to take when Envoy receives client request with header names containing underscore characters.HTTP service configuration.HTTP service configuration.Envoy external URI descriptorEnvoy external URI descriptorOptional configuration options to be used with json_format.Optional configuration options to be used with json_format.Protobuf typeenvoy.config.core.v3.KeepaliveSettingsProtobuf typeenvoy.config.core.v3.KeepaliveSettingsPlease use :ref:`KeyValuePair <envoy_api_msg_config.core.v3.KeyValuePair>` instead.Please use :ref:`KeyValuePair <envoy_api_msg_config.core.v3.KeyValuePair>` instead.Key/value pair plus option to control append behavior.Key/value pair plus option to control append behavior.Describes the supported actions types for key/value pair append action.Key/value pair to append or remove.Key/value pair to append or remove.Protobuf typeenvoy.config.core.v3.KeyValuePairProtobuf typeenvoy.config.core.v3.KeyValuePairIdentifies location of where either Envoy runs or where upstream hosts run.Identifies location of where either Envoy runs or where upstream hosts run.Metadata provides additional inputs to filters based on matched listeners, filter chains, routes and endpoints.Metadata provides additional inputs to filters based on matched listeners, filter chains, routes and endpoints.Identifies a specific Envoy instance.Identifies a specific Envoy instance.Local filesystem path configuration source.Local filesystem path configuration source.Protobuf typeenvoy.config.core.v3.PerHostConfigProtobuf typeenvoy.config.core.v3.PerHostConfigProtobuf typeenvoy.config.core.v3.PipeProtobuf typeenvoy.config.core.v3.PipeProtobuf typeenvoy.config.core.v3.ProxyProtocolConfigProtobuf typeenvoy.config.core.v3.ProxyProtocolConfigProtobuf enumenvoy.config.core.v3.ProxyProtocolConfig.VersionProtobuf typeenvoy.config.core.v3.ProxyProtocolPassThroughTLVsProtobuf typeenvoy.config.core.v3.ProxyProtocolPassThroughTLVsProtobuf enumenvoy.config.core.v3.ProxyProtocolPassThroughTLVs.PassTLVsMatchTypeQuery parameter name/value pair.Query parameter name/value pair.Config for keepalive probes in a QUIC connection. .. note:: QUIC keep-alive probing packets work differently from HTTP/2 keep-alive PINGs in a sense that the probing packet itself doesn't timeout waiting for a probing response.Config for keepalive probes in a QUIC connection. .. note:: QUIC keep-alive probing packets work differently from HTTP/2 keep-alive PINGs in a sense that the probing packet itself doesn't timeout waiting for a probing response.QUIC protocol options which apply to both downstream and upstream connections.QUIC protocol options which apply to both downstream and upstream connections.Config for QUIC connection migration across network interfaces, i.e. cellular to WIFI, upon network change events from the platform, i.e. the current network gets disconnected, or upon the QUIC detecting a bad connection.Config for QUIC connection migration across network interfaces, i.e. cellular to WIFI, upon network change events from the platform, i.e. the current network gets disconnected, or upon the QUIC detecting a bad connection.Config for options to migrate idle connections which aren't serving any requests.Config for options to migrate idle connections which aren't serving any requests.Rate Limit settings to be applied for discovery requests made by Envoy.Rate Limit settings to be applied for discovery requests made by Envoy.The message specifies how to fetch data from remote and how to verify it.The message specifies how to fetch data from remote and how to verify it.HTTP request method.The message specifies the retry policy of remote data source when fetching fails.The message specifies the retry policy of remote data source when fetching fails.See :ref:`RetryHostPredicate <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_host_predicate>`.See :ref:`RetryHostPredicate <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_host_predicate>`.See :ref:`RetryPriority <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_priority>`.See :ref:`RetryPriority <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_priority>`.Envoy supports :ref:`upstream priority routing <arch_overview_http_routing_priority>` both at the route and the virtual cluster level.Runtime derived double with a default when not specified.Runtime derived double with a default when not specified.Runtime derived bool with a default when not specified.Runtime derived bool with a default when not specified.Runtime derived FractionalPercent with defaults for when the numerator or denominator is not specified via a runtime key. .. note:: Parsing of the runtime key's data is implemented such that it may be represented as a :ref:`FractionalPercent <envoy_v3_api_msg_type.v3.FractionalPercent>` proto represented as JSON/YAML and may also be represented as an integer with the assumption that the value is an integral percentage out of 100.Runtime derived FractionalPercent with defaults for when the numerator or denominator is not specified via a runtime key. .. note:: Parsing of the runtime key's data is implemented such that it may be represented as a :ref:`FractionalPercent <envoy_v3_api_msg_type.v3.FractionalPercent>` proto represented as JSON/YAML and may also be represented as an integer with the assumption that the value is an integral percentage out of 100.Runtime derived percentage with a default when not specified.Runtime derived percentage with a default when not specified.Runtime derived uint32 with a default when not specified.Runtime derived uint32 with a default when not specified.A message to control transformations to the :scheme headerA message to control transformations to the :scheme header[#not-implemented-hide:] Self-referencing config source options.[#not-implemented-hide:] Self-referencing config source options.[#next-free-field: 8][#next-free-field: 8]Protobuf enumenvoy.config.core.v3.SocketAddress.ProtocolConfiguration for socket cmsg headers.Configuration for socket cmsg headers.Generic socket option message.Generic socket option message.Protobuf enumenvoy.config.core.v3.SocketOption.SocketStateThe `socket type <https://linux.die.net/man/2/socket>`_ to apply the socket option to.The `socket type <https://linux.die.net/man/2/socket>`_ to apply the socket option to.The datagram socket type.The datagram socket type.The stream socket type.The stream socket type.Protobuf typeenvoy.config.core.v3.SocketOptionsOverrideProtobuf typeenvoy.config.core.v3.SocketOptionsOverrideConfiguration to use multiple :ref:`command operators <config_access_log_command_operators>` to generate a new string in either plain text or JSON format.Configuration to use multiple :ref:`command operators <config_access_log_command_operators>` to generate a new string in either plain text or JSON format.Protobuf typeenvoy.config.core.v3.TcpKeepaliveProtobuf typeenvoy.config.core.v3.TcpKeepalive[#not-implemented-hide:][#not-implemented-hide:]Represents a single Type-Length-Value (TLV) entry.Represents a single Type-Length-Value (TLV) entry.Identifies the direction of the traffic relative to the local Envoy.Configuration for transport socket in :ref:`listeners <config_listeners>` and :ref:`clusters <envoy_v3_api_msg_config.cluster.v3.Cluster>`.Configuration for transport socket in :ref:`listeners <config_listeners>` and :ref:`clusters <envoy_v3_api_msg_config.cluster.v3.Cluster>`.Message type for extension configuration.Message type for extension configuration.Generic UDP socket configuration.Generic UDP socket configuration.Protobuf typeenvoy.config.core.v3.UpstreamHttpProtocolOptionsProtobuf typeenvoy.config.core.v3.UpstreamHttpProtocolOptionsA directory that is watched for changes, e.g. by inotify on Linux.A directory that is watched for changes, e.g. by inotify on Linux.