package
0.9.13
Repository: https://github.com/durd07/go-control-plane.git
Documentation: pkg.go.dev

# Constants

Using the delta xDS gRPC service, i.e.
gRPC v2 API.
REST-JSON v2 API.
Ideally this would be 'reserved 0' but one can't reserve the default value.
When not specified, we assume v2, to ease migration to Envoy's stable API versioning.
Use xDS v2 API.
Use xDS v3 API.
Degraded.
Connection draining in progress.
Healthy.
Health check timed out.
Unhealthy.
The health status is not known.
Allow headers with underscores.
Drop the header with name containing underscores.
Reject client request.
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
RequestMethod_POST
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
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.
The transport is used for incoming traffic.
The transport is used for outgoing traffic.
Default option is unspecified.

# Variables

Enum value maps for ApiConfigSource_ApiType.
Enum value maps for ApiConfigSource_ApiType.
Enum value maps for ApiVersion.
Enum value maps for ApiVersion.
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
Enum value maps for HealthStatus.
Enum value maps for HealthStatus.
Enum value maps for HttpProtocolOptions_HeadersWithUnderscoresAction.
Enum value maps for HttpProtocolOptions_HeadersWithUnderscoresAction.
Enum value maps for RequestMethod.
Enum value maps for RequestMethod.
Enum value maps for RoutingPriority.
Enum value maps for RoutingPriority.
Enum value maps for SocketAddress_Protocol.
Enum value maps for SocketAddress_Protocol.
Enum value maps for SocketOption_SocketState.
Enum value maps for SocketOption_SocketState.
Enum value maps for TrafficDirection.
Enum value maps for TrafficDirection.

# 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.
Async data source which support async data fetch.
No description provided by the author
No description provided by the author
AsyncDataSourceValidationError is the validation error returned by AsyncDataSource.Validate if the designated constraints aren't met.
Configuration defining a jittered exponential back off strategy.
BackoffStrategyValidationError is the validation error returned by BackoffStrategy.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.
BuildVersion combines SemVer version of extension with free-form build information (i.e.
BuildVersionValidationError is the validation error returned by BuildVersion.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
No description provided by the author
ConfigSourceValidationError is the validation error returned by ConfigSource.Validate if the designated constraints aren't met.
Identifies a specific ControlPlane instance that Envoy is connected to.
ControlPlaneValidationError is the validation error returned by ControlPlane.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:] Configuration of the event reporting service endpoint.
No description provided by the author
EventServiceConfigValidationError is the validation error returned by EventServiceConfig.Validate if the designated constraints aren't met.
Version and identification for an Envoy extension.
ExtensionValidationError is the validation error returned by Extension.Validate if the designated constraints aren't met.
A list of gRPC methods which can be used as an allowlist, for example.
No description provided by the author
GrpcMethodList_ServiceValidationError is the validation error returned by GrpcMethodList_Service.Validate if the designated constraints aren't met.
GrpcMethodListValidationError is the validation error returned by GrpcMethodList.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.
[#next-free-field: 7].
No description provided by the author
[#next-free-field: 8].
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
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.
Security token service configuration that allows Google gRPC to fetch security token from an OAuth 2.0 authorization server.
No description provided by the author
GrpcService_GoogleGrpc_CallCredentials_StsServiceValidationError is the validation error returned by GrpcService_GoogleGrpc_CallCredentials_StsService.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.
Wrapper for a set of headers.
HeaderMapValidationError is the validation error returned by HeaderMap.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.
[#next-free-field: 23].
Custom health check.
No description provided by the author
No description provided by the author
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.
[#next-free-field: 12].
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.
Health checks occur over the transport socket specified for the cluster.
HealthCheck_TlsOptionsValidationError is the validation error returned by HealthCheck_TlsOptions.Validate if the designated constraints aren't met.
HealthCheckValidationError is the validation error returned by HealthCheck.Validate if the designated constraints aren't met.
[#next-free-field: 6].
No description provided by the author
No description provided by the author
No description provided by the author
Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWordsValidationError is the validation error returned by Http1ProtocolOptions_HeaderKeyFormat_ProperCaseWords.Validate if the designated constraints aren't met.
Http1ProtocolOptions_HeaderKeyFormatValidationError is the validation error returned by Http1ProtocolOptions_HeaderKeyFormat.Validate if the designated constraints aren't met.
Http1ProtocolOptionsValidationError is the validation error returned by Http1ProtocolOptions.Validate if the designated constraints aren't met.
[#next-free-field: 14].
Defines a parameter to be sent in the SETTINGS frame.
Http2ProtocolOptions_SettingsParameterValidationError is the validation error returned by Http2ProtocolOptions_SettingsParameter.Validate if the designated constraints aren't met.
Http2ProtocolOptionsValidationError is the validation error returned by Http2ProtocolOptions.Validate if the designated constraints aren't met.
[#next-free-field: 6].
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.
No description provided by the author
No description provided by the author
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.
Rate Limit settings to be applied for discovery requests made by Envoy.
RateLimitSettingsValidationError is the validation error returned by RateLimitSettings.Validate if the designated constraints aren't met.
The message specifies how to fetch data from remote and how to verify it.
RemoteDataSourceValidationError is the validation error returned by RemoteDataSource.Validate if the designated constraints aren't met.
The message specifies the retry policy of remote data source when fetching fails.
RetryPolicyValidationError is the validation error returned by RetryPolicy.Validate if the designated constraints aren't met.
Runtime derived double with a default when not specified.
RuntimeDoubleValidationError is the validation error returned by RuntimeDouble.Validate if the designated constraints aren't met.
Runtime derived bool with a default when not specified.
RuntimeFeatureFlagValidationError is the validation error returned by RuntimeFeatureFlag.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.
[#not-implemented-hide:] Self-referencing config source options.
SelfConfigSourceValidationError is the validation error returned by SelfConfigSource.Validate if the designated constraints aren't met.
[#next-free-field: 7].
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>`.
No description provided by the author
No description provided by the author
TransportSocketValidationError is the validation error returned by TransportSocket.Validate if the designated constraints aren't met.
No description provided by the author
UpstreamHttpProtocolOptionsValidationError is the validation error returned by UpstreamHttpProtocolOptions.Validate if the designated constraints aren't met.

# Type aliases

APIs may be fetched via either REST or gRPC.
xDS API version.
Endpoint health status.
Action to take when Envoy receives client request with header names containing underscore characters.
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
Identifies the direction of the traffic relative to the local Envoy.