package envoy.type

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: api.v2.core.HealthCheck.HttpHealthCheck

• HTTP1 = 0

• HTTP2 = 1

• HTTP3 = 2

  [#not-implemented-hide:] QUIC implementation is not production ready yet. Use this enum with caution to prevent accidental execution of QUIC code. I.e. `!= HTTP2` is no longer sufficient to distinguish HTTP1 and HTTP2 traffic.

Specifies the double start and end of the range using half-open interval semantics [start, end).

Used in: matcher.DoubleMatcher

• double start = 1

  start of the range (inclusive)

• double end = 2

  end of the range (exclusive)

A fractional percentage is used in cases in which for performance reasons performing floating point to integer conversions during randomness calculations is undesirable. The message includes both a numerator and denominator that together determine the final fractional value. * **Example**: 1/100 = 1%. * **Example**: 3/10000 = 0.03%.

Used in: api.v2.ClusterLoadAssignment.Policy.DropOverload, api.v2.core.RuntimeFractionalPercent, api.v2.route.HedgePolicy, api.v2.route.Tracing, config.filter.accesslog.v2.RuntimeFilter, config.filter.fault.v2.FaultDelay, config.filter.fault.v2.FaultRateLimit, config.filter.http.fault.v2.FaultAbort

• uint32 numerator = 1

  Specifies the numerator. Defaults to 0.

• FractionalPercent.DenominatorType denominator = 2

  Specifies the denominator. If the denominator specified is less than the numerator, the final fractional percentage is capped at 1 (100%).

Fraction percentages support several fixed denominator values.

Used in: FractionalPercent

• HUNDRED = 0

  100. **Example**: 1/100 = 1%.

• TEN_THOUSAND = 1

  10,000. **Example**: 1/10000 = 0.01%.

• MILLION = 2

  1,000,000. **Example**: 1/1000000 = 0.0001%.

Specifies the hash policy

Used in: config.filter.network.tcp_proxy.v2.TcpProxy

• oneof policy_specifier

  • HashPolicy.SourceIp source_ip = 1

The source IP will be used to compute the hash used by hash-based load balancing algorithms.

Used in: HashPolicy

(message has no fields)

HTTP status.

Used in: config.filter.http.ext_authz.v2.ExtAuthz, service.auth.v2.DeniedHttpResponse

• StatusCode code = 1

  Supplies HTTP response code.

Specifies the int32 start and end of the range using half-open interval semantics [start, end).

Used in: api.v2.listener.ListenerFilterChainMatchPredicate

• int32 start = 1

  start of the range (inclusive)

• int32 end = 2

  end of the range (exclusive)

Specifies the int64 start and end of the range using half-open interval semantics [start, end).

Used in: api.v2.core.HealthCheck.HttpHealthCheck, api.v2.route.HeaderMatcher, config.filter.network.dubbo_proxy.v2alpha1.MethodMatch.ParameterMatchSpecifier

• int64 start = 1

  start of the range (inclusive)

• int64 end = 2

  end of the range (exclusive)

Identifies a percentage, in the range [0.0, 100.0].

Used in: admin.v2alpha.ClusterStatus, admin.v2alpha.HostStatus, api.v2.Cluster.CommonLbConfig, api.v2.Cluster.CommonLbConfig.ZoneAwareLbConfig, api.v2.cluster.CircuitBreakers.Thresholds.RetryBudget, config.filter.http.adaptive_concurrency.v2alpha.GradientControllerConfig, config.filter.http.adaptive_concurrency.v2alpha.GradientControllerConfig.MinimumRTTCalculationParams, config.filter.http.health_check.v2.HealthCheck, config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing

• double value = 1

Envoy uses SemVer (https://semver.org/). Major/minor versions indicate expected behaviors and APIs, the patch version field is used only for security fixes and can be generally ignored.

Used in: api.v2.core.BuildVersion

• uint32 major_number = 1

• uint32 minor_number = 2

• uint32 patch = 3

HTTP response codes supported in Envoy. For more details: https://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml

Used in: HttpStatus

• Empty = 0

  Empty - This code not part of the HTTP status code specification, but it is needed for proto `enum` type.

• Continue = 100

• OK = 200

• Created = 201

• Accepted = 202

• NonAuthoritativeInformation = 203

• NoContent = 204

• ResetContent = 205

• PartialContent = 206

• MultiStatus = 207

• AlreadyReported = 208

• IMUsed = 226

• MultipleChoices = 300

• MovedPermanently = 301

• Found = 302

• SeeOther = 303

• NotModified = 304

• UseProxy = 305

• TemporaryRedirect = 307

• PermanentRedirect = 308

• BadRequest = 400

• Unauthorized = 401

• PaymentRequired = 402

• Forbidden = 403

• NotFound = 404

• MethodNotAllowed = 405

• NotAcceptable = 406

• ProxyAuthenticationRequired = 407

• RequestTimeout = 408

• Conflict = 409

• Gone = 410

• LengthRequired = 411

• PreconditionFailed = 412

• PayloadTooLarge = 413

• URITooLong = 414

• UnsupportedMediaType = 415

• RangeNotSatisfiable = 416

• ExpectationFailed = 417

• MisdirectedRequest = 421

• UnprocessableEntity = 422

• Locked = 423

• FailedDependency = 424

• UpgradeRequired = 426

• PreconditionRequired = 428

• TooManyRequests = 429

• RequestHeaderFieldsTooLarge = 431

• InternalServerError = 500

• NotImplemented = 501

• BadGateway = 502

• ServiceUnavailable = 503

• GatewayTimeout = 504

• HTTPVersionNotSupported = 505

• VariantAlsoNegotiates = 506

• InsufficientStorage = 507

• LoopDetected = 508

• NotExtended = 510

• NetworkAuthenticationRequired = 511

Configures a token bucket, typically used for rate limiting.

Used in: config.filter.network.local_rate_limit.v2alpha.LocalRateLimit

• uint32 max_tokens = 1

  The maximum tokens that the bucket can hold. This is also the number of tokens that the bucket initially contains.

• optional google.protobuf.UInt32Value tokens_per_fill = 2

  The number of tokens added to the bucket during each fill interval. If not specified, defaults to a single token.

• optional google.protobuf.Duration fill_interval = 3

  The fill interval that tokens are added to the bucket. During each fill interval `tokens_per_fill` are added to the bucket. The bucket will never contain more than `max_tokens` tokens.