io.envoyproxy.envoy.api.v2.route.VirtualCluster.scala Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of envoy-scala-control-plane_2.13 Show documentation
Show all versions of envoy-scala-control-plane_2.13 Show documentation
ScalaPB generated bindings for Envoy
// Generated by the Scala Plugin for the Protocol Buffer Compiler.
// Do not edit!
//
// Protofile syntax: PROTO3
package io.envoyproxy.envoy.api.v2.route
/** A virtual cluster is a way of specifying a regex matching rule against
* certain important endpoints such that statistics are generated explicitly for
* the matched requests. The reason this is useful is that when doing
* prefix/path matching Envoy does not always know what the application
* considers to be an endpoint. Thus, it’s impossible for Envoy to generically
* emit per endpoint statistics. However, often systems have highly critical
* endpoints that they wish to get “perfect” statistics on. Virtual cluster
* statistics are perfect in the sense that they are emitted on the downstream
* side such that they include network level failures.
*
* Documentation for :ref:`virtual cluster statistics <config_http_filters_router_vcluster_stats>`.
*
* .. note::
*
* Virtual clusters are a useful tool, but we do not recommend setting up a virtual cluster for
* every application endpoint. This is both not easily maintainable and as well the matching and
* statistics output are not free.
*
* @param pattern
* Specifies a regex pattern to use for matching requests. The entire path of the request
* must match the regex. The regex grammar used is defined `here
* <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
*
* Examples:
*
* * The regex ``/rides/&92;d+`` matches the path */rides/0*
* * The regex ``/rides/&92;d+`` matches the path */rides/123*
* * The regex ``/rides/&92;d+`` does not match the path */rides/123/456*
*
* .. attention::
* This field has been deprecated in favor of `headers` as it is not safe for use with
* untrusted input in all cases.
* @param headers
* Specifies a list of header matchers to use for matching requests. Each specified header must
* match. The pseudo-headers `:path` and `:method` can be used to match the request path and
* method, respectively.
* @param name
* Specifies the name of the virtual cluster. The virtual cluster name as well
* as the virtual host name are used when emitting statistics. The statistics are emitted by the
* router filter and are documented :ref:`here <config_http_filters_router_stats>`.
* @param method
* Optionally specifies the HTTP method to match on. For example GET, PUT,
* etc.
*
* .. attention::
* This field has been deprecated in favor of `headers`.
*/
@SerialVersionUID(0L)
final case class VirtualCluster(
@scala.deprecated(message="Marked as deprecated in proto file", "") pattern: _root_.scala.Predef.String = "",
headers: _root_.scala.Seq[io.envoyproxy.envoy.api.v2.route.HeaderMatcher] = _root_.scala.Seq.empty,
name: _root_.scala.Predef.String = "",
@scala.deprecated(message="Marked as deprecated in proto file", "") method: io.envoyproxy.envoy.api.v2.core.RequestMethod = io.envoyproxy.envoy.api.v2.core.RequestMethod.METHOD_UNSPECIFIED,
unknownFields: _root_.scalapb.UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty
) extends scalapb.GeneratedMessage with scalapb.lenses.Updatable[VirtualCluster] {
@transient
private[this] var __serializedSizeMemoized: _root_.scala.Int = 0
private[this] def __computeSerializedSize(): _root_.scala.Int = {
var __size = 0
{
val __value = pattern
if (!__value.isEmpty) {
__size += _root_.com.google.protobuf.CodedOutputStream.computeStringSize(1, __value)
}
};
headers.foreach { __item =>
val __value = __item
__size += 1 + _root_.com.google.protobuf.CodedOutputStream.computeUInt32SizeNoTag(__value.serializedSize) + __value.serializedSize
}
{
val __value = name
if (!__value.isEmpty) {
__size += _root_.com.google.protobuf.CodedOutputStream.computeStringSize(2, __value)
}
};
{
val __value = method.value
if (__value != 0) {
__size += _root_.com.google.protobuf.CodedOutputStream.computeEnumSize(3, __value)
}
};
__size += unknownFields.serializedSize
__size
}
override def serializedSize: _root_.scala.Int = {
var __size = __serializedSizeMemoized
if (__size == 0) {
__size = __computeSerializedSize() + 1
__serializedSizeMemoized = __size
}
__size - 1
}
def writeTo(`_output__`: _root_.com.google.protobuf.CodedOutputStream): _root_.scala.Unit = {
{
val __v = pattern
if (!__v.isEmpty) {
_output__.writeString(1, __v)
}
};
{
val __v = name
if (!__v.isEmpty) {
_output__.writeString(2, __v)
}
};
{
val __v = method.value
if (__v != 0) {
_output__.writeEnum(3, __v)
}
};
headers.foreach { __v =>
val __m = __v
_output__.writeTag(4, 2)
_output__.writeUInt32NoTag(__m.serializedSize)
__m.writeTo(_output__)
};
unknownFields.writeTo(_output__)
}
def withPattern(__v: _root_.scala.Predef.String): VirtualCluster = copy(pattern = __v)
def clearHeaders = copy(headers = _root_.scala.Seq.empty)
def addHeaders(__vs: io.envoyproxy.envoy.api.v2.route.HeaderMatcher *): VirtualCluster = addAllHeaders(__vs)
def addAllHeaders(__vs: Iterable[io.envoyproxy.envoy.api.v2.route.HeaderMatcher]): VirtualCluster = copy(headers = headers ++ __vs)
def withHeaders(__v: _root_.scala.Seq[io.envoyproxy.envoy.api.v2.route.HeaderMatcher]): VirtualCluster = copy(headers = __v)
def withName(__v: _root_.scala.Predef.String): VirtualCluster = copy(name = __v)
def withMethod(__v: io.envoyproxy.envoy.api.v2.core.RequestMethod): VirtualCluster = copy(method = __v)
def withUnknownFields(__v: _root_.scalapb.UnknownFieldSet) = copy(unknownFields = __v)
def discardUnknownFields = copy(unknownFields = _root_.scalapb.UnknownFieldSet.empty)
def getFieldByNumber(__fieldNumber: _root_.scala.Int): _root_.scala.Any = {
(__fieldNumber: @_root_.scala.unchecked) match {
case 1 => {
val __t = pattern
if (__t != "") __t else null
}
case 4 => headers
case 2 => {
val __t = name
if (__t != "") __t else null
}
case 3 => {
val __t = method.javaValueDescriptor
if (__t.getNumber() != 0) __t else null
}
}
}
def getField(__field: _root_.scalapb.descriptors.FieldDescriptor): _root_.scalapb.descriptors.PValue = {
_root_.scala.Predef.require(__field.containingMessage eq companion.scalaDescriptor)
(__field.number: @_root_.scala.unchecked) match {
case 1 => _root_.scalapb.descriptors.PString(pattern)
case 4 => _root_.scalapb.descriptors.PRepeated(headers.iterator.map(_.toPMessage).toVector)
case 2 => _root_.scalapb.descriptors.PString(name)
case 3 => _root_.scalapb.descriptors.PEnum(method.scalaValueDescriptor)
}
}
def toProtoString: _root_.scala.Predef.String = _root_.scalapb.TextFormat.printToUnicodeString(this)
def companion: io.envoyproxy.envoy.api.v2.route.VirtualCluster.type = io.envoyproxy.envoy.api.v2.route.VirtualCluster
// @@protoc_insertion_point(GeneratedMessage[envoy.api.v2.route.VirtualCluster])
}
object VirtualCluster extends scalapb.GeneratedMessageCompanion[io.envoyproxy.envoy.api.v2.route.VirtualCluster] {
implicit def messageCompanion: scalapb.GeneratedMessageCompanion[io.envoyproxy.envoy.api.v2.route.VirtualCluster] = this
def parseFrom(`_input__`: _root_.com.google.protobuf.CodedInputStream): io.envoyproxy.envoy.api.v2.route.VirtualCluster = {
var __pattern: _root_.scala.Predef.String = ""
val __headers: _root_.scala.collection.immutable.VectorBuilder[io.envoyproxy.envoy.api.v2.route.HeaderMatcher] = new _root_.scala.collection.immutable.VectorBuilder[io.envoyproxy.envoy.api.v2.route.HeaderMatcher]
var __name: _root_.scala.Predef.String = ""
var __method: io.envoyproxy.envoy.api.v2.core.RequestMethod = io.envoyproxy.envoy.api.v2.core.RequestMethod.METHOD_UNSPECIFIED
var `_unknownFields__`: _root_.scalapb.UnknownFieldSet.Builder = null
var _done__ = false
while (!_done__) {
val _tag__ = _input__.readTag()
_tag__ match {
case 0 => _done__ = true
case 10 =>
__pattern = _input__.readStringRequireUtf8()
case 34 =>
__headers += _root_.scalapb.LiteParser.readMessage[io.envoyproxy.envoy.api.v2.route.HeaderMatcher](_input__)
case 18 =>
__name = _input__.readStringRequireUtf8()
case 24 =>
__method = io.envoyproxy.envoy.api.v2.core.RequestMethod.fromValue(_input__.readEnum())
case tag =>
if (_unknownFields__ == null) {
_unknownFields__ = new _root_.scalapb.UnknownFieldSet.Builder()
}
_unknownFields__.parseField(tag, _input__)
}
}
io.envoyproxy.envoy.api.v2.route.VirtualCluster(
pattern = __pattern,
headers = __headers.result(),
name = __name,
method = __method,
unknownFields = if (_unknownFields__ == null) _root_.scalapb.UnknownFieldSet.empty else _unknownFields__.result()
)
}
implicit def messageReads: _root_.scalapb.descriptors.Reads[io.envoyproxy.envoy.api.v2.route.VirtualCluster] = _root_.scalapb.descriptors.Reads{
case _root_.scalapb.descriptors.PMessage(__fieldsMap) =>
_root_.scala.Predef.require(__fieldsMap.keys.forall(_.containingMessage eq scalaDescriptor), "FieldDescriptor does not match message type.")
io.envoyproxy.envoy.api.v2.route.VirtualCluster(
pattern = __fieldsMap.get(scalaDescriptor.findFieldByNumber(1).get).map(_.as[_root_.scala.Predef.String]).getOrElse(""),
headers = __fieldsMap.get(scalaDescriptor.findFieldByNumber(4).get).map(_.as[_root_.scala.Seq[io.envoyproxy.envoy.api.v2.route.HeaderMatcher]]).getOrElse(_root_.scala.Seq.empty),
name = __fieldsMap.get(scalaDescriptor.findFieldByNumber(2).get).map(_.as[_root_.scala.Predef.String]).getOrElse(""),
method = io.envoyproxy.envoy.api.v2.core.RequestMethod.fromValue(__fieldsMap.get(scalaDescriptor.findFieldByNumber(3).get).map(_.as[_root_.scalapb.descriptors.EnumValueDescriptor]).getOrElse(io.envoyproxy.envoy.api.v2.core.RequestMethod.METHOD_UNSPECIFIED.scalaValueDescriptor).number)
)
case _ => throw new RuntimeException("Expected PMessage")
}
def javaDescriptor: _root_.com.google.protobuf.Descriptors.Descriptor = RouteComponentsProto.javaDescriptor.getMessageTypes().get(13)
def scalaDescriptor: _root_.scalapb.descriptors.Descriptor = RouteComponentsProto.scalaDescriptor.messages(13)
def messageCompanionForFieldNumber(__number: _root_.scala.Int): _root_.scalapb.GeneratedMessageCompanion[_] = {
var __out: _root_.scalapb.GeneratedMessageCompanion[_] = null
(__number: @_root_.scala.unchecked) match {
case 4 => __out = io.envoyproxy.envoy.api.v2.route.HeaderMatcher
}
__out
}
lazy val nestedMessagesCompanions: Seq[_root_.scalapb.GeneratedMessageCompanion[_ <: _root_.scalapb.GeneratedMessage]] = Seq.empty
def enumCompanionForFieldNumber(__fieldNumber: _root_.scala.Int): _root_.scalapb.GeneratedEnumCompanion[_] = {
(__fieldNumber: @_root_.scala.unchecked) match {
case 3 => io.envoyproxy.envoy.api.v2.core.RequestMethod
}
}
lazy val defaultInstance = io.envoyproxy.envoy.api.v2.route.VirtualCluster(
pattern = "",
headers = _root_.scala.Seq.empty,
name = "",
method = io.envoyproxy.envoy.api.v2.core.RequestMethod.METHOD_UNSPECIFIED
)
implicit class VirtualClusterLens[UpperPB](_l: _root_.scalapb.lenses.Lens[UpperPB, io.envoyproxy.envoy.api.v2.route.VirtualCluster]) extends _root_.scalapb.lenses.ObjectLens[UpperPB, io.envoyproxy.envoy.api.v2.route.VirtualCluster](_l) {
def pattern: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Predef.String] = field(_.pattern)((c_, f_) => c_.copy(pattern = f_))
def headers: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Seq[io.envoyproxy.envoy.api.v2.route.HeaderMatcher]] = field(_.headers)((c_, f_) => c_.copy(headers = f_))
def name: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Predef.String] = field(_.name)((c_, f_) => c_.copy(name = f_))
def method: _root_.scalapb.lenses.Lens[UpperPB, io.envoyproxy.envoy.api.v2.core.RequestMethod] = field(_.method)((c_, f_) => c_.copy(method = f_))
}
final val PATTERN_FIELD_NUMBER = 1
final val HEADERS_FIELD_NUMBER = 4
final val NAME_FIELD_NUMBER = 2
final val METHOD_FIELD_NUMBER = 3
def of(
pattern: _root_.scala.Predef.String,
headers: _root_.scala.Seq[io.envoyproxy.envoy.api.v2.route.HeaderMatcher],
name: _root_.scala.Predef.String,
method: io.envoyproxy.envoy.api.v2.core.RequestMethod
): _root_.io.envoyproxy.envoy.api.v2.route.VirtualCluster = _root_.io.envoyproxy.envoy.api.v2.route.VirtualCluster(
pattern,
headers,
name,
method
)
// @@protoc_insertion_point(GeneratedMessageCompanion[envoy.api.v2.route.VirtualCluster])
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy