io.envoyproxy.envoy.admin.v3.ClusterStatus.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.admin.v3
/** Details an individual cluster's current status.
* [#next-free-field: 8]
*
* @param name
* Name of the cluster.
* @param addedViaApi
* Denotes whether this cluster was added via API or configured statically.
* @param successRateEjectionThreshold
* The success rate threshold used in the last interval.
* If
* :ref:`outlier_detection.split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
* is *false*, all errors: externally and locally generated were used to calculate the threshold.
* If
* :ref:`outlier_detection.split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
* is *true*, only externally generated errors were used to calculate the threshold.
* The threshold is used to eject hosts based on their success rate. See
* :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for details.
*
* Note: this field may be omitted in any of the three following cases:
*
* 1. There were not enough hosts with enough request volume to proceed with success rate based
* outlier ejection.
* 2. The threshold is computed to be < 0 because a negative value implies that there was no
* threshold for that interval.
* 3. Outlier detection is not enabled for this cluster.
* @param hostStatuses
* Mapping from host address to the host's current status.
* @param localOriginSuccessRateEjectionThreshold
* The success rate threshold used in the last interval when only locally originated failures were
* taken into account and externally originated errors were treated as success.
* This field should be interpreted only when
* :ref:`outlier_detection.split_external_local_origin_errors<envoy_v3_api_field_config.cluster.v3.OutlierDetection.split_external_local_origin_errors>`
* is *true*. The threshold is used to eject hosts based on their success rate.
* See :ref:`Cluster outlier detection <arch_overview_outlier_detection>` documentation for
* details.
*
* Note: this field may be omitted in any of the three following cases:
*
* 1. There were not enough hosts with enough request volume to proceed with success rate based
* outlier ejection.
* 2. The threshold is computed to be < 0 because a negative value implies that there was no
* threshold for that interval.
* 3. Outlier detection is not enabled for this cluster.
* @param circuitBreakers
* :ref:`Circuit breaking <arch_overview_circuit_break>` settings of the cluster.
* @param observabilityName
* Observability name of the cluster.
*/
@SerialVersionUID(0L)
final case class ClusterStatus(
name: _root_.scala.Predef.String = "",
addedViaApi: _root_.scala.Boolean = false,
successRateEjectionThreshold: _root_.scala.Option[io.envoyproxy.envoy.`type`.v3.Percent] = _root_.scala.None,
hostStatuses: _root_.scala.Seq[io.envoyproxy.envoy.admin.v3.HostStatus] = _root_.scala.Seq.empty,
localOriginSuccessRateEjectionThreshold: _root_.scala.Option[io.envoyproxy.envoy.`type`.v3.Percent] = _root_.scala.None,
circuitBreakers: _root_.scala.Option[io.envoyproxy.envoy.config.cluster.v3.CircuitBreakers] = _root_.scala.None,
observabilityName: _root_.scala.Predef.String = "",
unknownFields: _root_.scalapb.UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty
) extends scalapb.GeneratedMessage with scalapb.lenses.Updatable[ClusterStatus] {
@transient
private[this] var __serializedSizeMemoized: _root_.scala.Int = 0
private[this] def __computeSerializedSize(): _root_.scala.Int = {
var __size = 0
{
val __value = name
if (!__value.isEmpty) {
__size += _root_.com.google.protobuf.CodedOutputStream.computeStringSize(1, __value)
}
};
{
val __value = addedViaApi
if (__value != false) {
__size += _root_.com.google.protobuf.CodedOutputStream.computeBoolSize(2, __value)
}
};
if (successRateEjectionThreshold.isDefined) {
val __value = successRateEjectionThreshold.get
__size += 1 + _root_.com.google.protobuf.CodedOutputStream.computeUInt32SizeNoTag(__value.serializedSize) + __value.serializedSize
};
hostStatuses.foreach { __item =>
val __value = __item
__size += 1 + _root_.com.google.protobuf.CodedOutputStream.computeUInt32SizeNoTag(__value.serializedSize) + __value.serializedSize
}
if (localOriginSuccessRateEjectionThreshold.isDefined) {
val __value = localOriginSuccessRateEjectionThreshold.get
__size += 1 + _root_.com.google.protobuf.CodedOutputStream.computeUInt32SizeNoTag(__value.serializedSize) + __value.serializedSize
};
if (circuitBreakers.isDefined) {
val __value = circuitBreakers.get
__size += 1 + _root_.com.google.protobuf.CodedOutputStream.computeUInt32SizeNoTag(__value.serializedSize) + __value.serializedSize
};
{
val __value = observabilityName
if (!__value.isEmpty) {
__size += _root_.com.google.protobuf.CodedOutputStream.computeStringSize(7, __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 = name
if (!__v.isEmpty) {
_output__.writeString(1, __v)
}
};
{
val __v = addedViaApi
if (__v != false) {
_output__.writeBool(2, __v)
}
};
successRateEjectionThreshold.foreach { __v =>
val __m = __v
_output__.writeTag(3, 2)
_output__.writeUInt32NoTag(__m.serializedSize)
__m.writeTo(_output__)
};
hostStatuses.foreach { __v =>
val __m = __v
_output__.writeTag(4, 2)
_output__.writeUInt32NoTag(__m.serializedSize)
__m.writeTo(_output__)
};
localOriginSuccessRateEjectionThreshold.foreach { __v =>
val __m = __v
_output__.writeTag(5, 2)
_output__.writeUInt32NoTag(__m.serializedSize)
__m.writeTo(_output__)
};
circuitBreakers.foreach { __v =>
val __m = __v
_output__.writeTag(6, 2)
_output__.writeUInt32NoTag(__m.serializedSize)
__m.writeTo(_output__)
};
{
val __v = observabilityName
if (!__v.isEmpty) {
_output__.writeString(7, __v)
}
};
unknownFields.writeTo(_output__)
}
def withName(__v: _root_.scala.Predef.String): ClusterStatus = copy(name = __v)
def withAddedViaApi(__v: _root_.scala.Boolean): ClusterStatus = copy(addedViaApi = __v)
def getSuccessRateEjectionThreshold: io.envoyproxy.envoy.`type`.v3.Percent = successRateEjectionThreshold.getOrElse(io.envoyproxy.envoy.`type`.v3.Percent.defaultInstance)
def clearSuccessRateEjectionThreshold: ClusterStatus = copy(successRateEjectionThreshold = _root_.scala.None)
def withSuccessRateEjectionThreshold(__v: io.envoyproxy.envoy.`type`.v3.Percent): ClusterStatus = copy(successRateEjectionThreshold = Option(__v))
def clearHostStatuses = copy(hostStatuses = _root_.scala.Seq.empty)
def addHostStatuses(__vs: io.envoyproxy.envoy.admin.v3.HostStatus *): ClusterStatus = addAllHostStatuses(__vs)
def addAllHostStatuses(__vs: Iterable[io.envoyproxy.envoy.admin.v3.HostStatus]): ClusterStatus = copy(hostStatuses = hostStatuses ++ __vs)
def withHostStatuses(__v: _root_.scala.Seq[io.envoyproxy.envoy.admin.v3.HostStatus]): ClusterStatus = copy(hostStatuses = __v)
def getLocalOriginSuccessRateEjectionThreshold: io.envoyproxy.envoy.`type`.v3.Percent = localOriginSuccessRateEjectionThreshold.getOrElse(io.envoyproxy.envoy.`type`.v3.Percent.defaultInstance)
def clearLocalOriginSuccessRateEjectionThreshold: ClusterStatus = copy(localOriginSuccessRateEjectionThreshold = _root_.scala.None)
def withLocalOriginSuccessRateEjectionThreshold(__v: io.envoyproxy.envoy.`type`.v3.Percent): ClusterStatus = copy(localOriginSuccessRateEjectionThreshold = Option(__v))
def getCircuitBreakers: io.envoyproxy.envoy.config.cluster.v3.CircuitBreakers = circuitBreakers.getOrElse(io.envoyproxy.envoy.config.cluster.v3.CircuitBreakers.defaultInstance)
def clearCircuitBreakers: ClusterStatus = copy(circuitBreakers = _root_.scala.None)
def withCircuitBreakers(__v: io.envoyproxy.envoy.config.cluster.v3.CircuitBreakers): ClusterStatus = copy(circuitBreakers = Option(__v))
def withObservabilityName(__v: _root_.scala.Predef.String): ClusterStatus = copy(observabilityName = __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 = name
if (__t != "") __t else null
}
case 2 => {
val __t = addedViaApi
if (__t != false) __t else null
}
case 3 => successRateEjectionThreshold.orNull
case 4 => hostStatuses
case 5 => localOriginSuccessRateEjectionThreshold.orNull
case 6 => circuitBreakers.orNull
case 7 => {
val __t = observabilityName
if (__t != "") __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(name)
case 2 => _root_.scalapb.descriptors.PBoolean(addedViaApi)
case 3 => successRateEjectionThreshold.map(_.toPMessage).getOrElse(_root_.scalapb.descriptors.PEmpty)
case 4 => _root_.scalapb.descriptors.PRepeated(hostStatuses.iterator.map(_.toPMessage).toVector)
case 5 => localOriginSuccessRateEjectionThreshold.map(_.toPMessage).getOrElse(_root_.scalapb.descriptors.PEmpty)
case 6 => circuitBreakers.map(_.toPMessage).getOrElse(_root_.scalapb.descriptors.PEmpty)
case 7 => _root_.scalapb.descriptors.PString(observabilityName)
}
}
def toProtoString: _root_.scala.Predef.String = _root_.scalapb.TextFormat.printToUnicodeString(this)
def companion: io.envoyproxy.envoy.admin.v3.ClusterStatus.type = io.envoyproxy.envoy.admin.v3.ClusterStatus
// @@protoc_insertion_point(GeneratedMessage[envoy.admin.v3.ClusterStatus])
}
object ClusterStatus extends scalapb.GeneratedMessageCompanion[io.envoyproxy.envoy.admin.v3.ClusterStatus] {
implicit def messageCompanion: scalapb.GeneratedMessageCompanion[io.envoyproxy.envoy.admin.v3.ClusterStatus] = this
def parseFrom(`_input__`: _root_.com.google.protobuf.CodedInputStream): io.envoyproxy.envoy.admin.v3.ClusterStatus = {
var __name: _root_.scala.Predef.String = ""
var __addedViaApi: _root_.scala.Boolean = false
var __successRateEjectionThreshold: _root_.scala.Option[io.envoyproxy.envoy.`type`.v3.Percent] = _root_.scala.None
val __hostStatuses: _root_.scala.collection.immutable.VectorBuilder[io.envoyproxy.envoy.admin.v3.HostStatus] = new _root_.scala.collection.immutable.VectorBuilder[io.envoyproxy.envoy.admin.v3.HostStatus]
var __localOriginSuccessRateEjectionThreshold: _root_.scala.Option[io.envoyproxy.envoy.`type`.v3.Percent] = _root_.scala.None
var __circuitBreakers: _root_.scala.Option[io.envoyproxy.envoy.config.cluster.v3.CircuitBreakers] = _root_.scala.None
var __observabilityName: _root_.scala.Predef.String = ""
var `_unknownFields__`: _root_.scalapb.UnknownFieldSet.Builder = null
var _done__ = false
while (!_done__) {
val _tag__ = _input__.readTag()
_tag__ match {
case 0 => _done__ = true
case 10 =>
__name = _input__.readStringRequireUtf8()
case 16 =>
__addedViaApi = _input__.readBool()
case 26 =>
__successRateEjectionThreshold = Option(__successRateEjectionThreshold.fold(_root_.scalapb.LiteParser.readMessage[io.envoyproxy.envoy.`type`.v3.Percent](_input__))(_root_.scalapb.LiteParser.readMessage(_input__, _)))
case 34 =>
__hostStatuses += _root_.scalapb.LiteParser.readMessage[io.envoyproxy.envoy.admin.v3.HostStatus](_input__)
case 42 =>
__localOriginSuccessRateEjectionThreshold = Option(__localOriginSuccessRateEjectionThreshold.fold(_root_.scalapb.LiteParser.readMessage[io.envoyproxy.envoy.`type`.v3.Percent](_input__))(_root_.scalapb.LiteParser.readMessage(_input__, _)))
case 50 =>
__circuitBreakers = Option(__circuitBreakers.fold(_root_.scalapb.LiteParser.readMessage[io.envoyproxy.envoy.config.cluster.v3.CircuitBreakers](_input__))(_root_.scalapb.LiteParser.readMessage(_input__, _)))
case 58 =>
__observabilityName = _input__.readStringRequireUtf8()
case tag =>
if (_unknownFields__ == null) {
_unknownFields__ = new _root_.scalapb.UnknownFieldSet.Builder()
}
_unknownFields__.parseField(tag, _input__)
}
}
io.envoyproxy.envoy.admin.v3.ClusterStatus(
name = __name,
addedViaApi = __addedViaApi,
successRateEjectionThreshold = __successRateEjectionThreshold,
hostStatuses = __hostStatuses.result(),
localOriginSuccessRateEjectionThreshold = __localOriginSuccessRateEjectionThreshold,
circuitBreakers = __circuitBreakers,
observabilityName = __observabilityName,
unknownFields = if (_unknownFields__ == null) _root_.scalapb.UnknownFieldSet.empty else _unknownFields__.result()
)
}
implicit def messageReads: _root_.scalapb.descriptors.Reads[io.envoyproxy.envoy.admin.v3.ClusterStatus] = _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.admin.v3.ClusterStatus(
name = __fieldsMap.get(scalaDescriptor.findFieldByNumber(1).get).map(_.as[_root_.scala.Predef.String]).getOrElse(""),
addedViaApi = __fieldsMap.get(scalaDescriptor.findFieldByNumber(2).get).map(_.as[_root_.scala.Boolean]).getOrElse(false),
successRateEjectionThreshold = __fieldsMap.get(scalaDescriptor.findFieldByNumber(3).get).flatMap(_.as[_root_.scala.Option[io.envoyproxy.envoy.`type`.v3.Percent]]),
hostStatuses = __fieldsMap.get(scalaDescriptor.findFieldByNumber(4).get).map(_.as[_root_.scala.Seq[io.envoyproxy.envoy.admin.v3.HostStatus]]).getOrElse(_root_.scala.Seq.empty),
localOriginSuccessRateEjectionThreshold = __fieldsMap.get(scalaDescriptor.findFieldByNumber(5).get).flatMap(_.as[_root_.scala.Option[io.envoyproxy.envoy.`type`.v3.Percent]]),
circuitBreakers = __fieldsMap.get(scalaDescriptor.findFieldByNumber(6).get).flatMap(_.as[_root_.scala.Option[io.envoyproxy.envoy.config.cluster.v3.CircuitBreakers]]),
observabilityName = __fieldsMap.get(scalaDescriptor.findFieldByNumber(7).get).map(_.as[_root_.scala.Predef.String]).getOrElse("")
)
case _ => throw new RuntimeException("Expected PMessage")
}
def javaDescriptor: _root_.com.google.protobuf.Descriptors.Descriptor = ClustersProto.javaDescriptor.getMessageTypes().get(1)
def scalaDescriptor: _root_.scalapb.descriptors.Descriptor = ClustersProto.scalaDescriptor.messages(1)
def messageCompanionForFieldNumber(__number: _root_.scala.Int): _root_.scalapb.GeneratedMessageCompanion[_] = {
var __out: _root_.scalapb.GeneratedMessageCompanion[_] = null
(__number: @_root_.scala.unchecked) match {
case 3 => __out = io.envoyproxy.envoy.`type`.v3.Percent
case 4 => __out = io.envoyproxy.envoy.admin.v3.HostStatus
case 5 => __out = io.envoyproxy.envoy.`type`.v3.Percent
case 6 => __out = io.envoyproxy.envoy.config.cluster.v3.CircuitBreakers
}
__out
}
lazy val nestedMessagesCompanions: Seq[_root_.scalapb.GeneratedMessageCompanion[_ <: _root_.scalapb.GeneratedMessage]] = Seq.empty
def enumCompanionForFieldNumber(__fieldNumber: _root_.scala.Int): _root_.scalapb.GeneratedEnumCompanion[_] = throw new MatchError(__fieldNumber)
lazy val defaultInstance = io.envoyproxy.envoy.admin.v3.ClusterStatus(
name = "",
addedViaApi = false,
successRateEjectionThreshold = _root_.scala.None,
hostStatuses = _root_.scala.Seq.empty,
localOriginSuccessRateEjectionThreshold = _root_.scala.None,
circuitBreakers = _root_.scala.None,
observabilityName = ""
)
implicit class ClusterStatusLens[UpperPB](_l: _root_.scalapb.lenses.Lens[UpperPB, io.envoyproxy.envoy.admin.v3.ClusterStatus]) extends _root_.scalapb.lenses.ObjectLens[UpperPB, io.envoyproxy.envoy.admin.v3.ClusterStatus](_l) {
def name: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Predef.String] = field(_.name)((c_, f_) => c_.copy(name = f_))
def addedViaApi: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Boolean] = field(_.addedViaApi)((c_, f_) => c_.copy(addedViaApi = f_))
def successRateEjectionThreshold: _root_.scalapb.lenses.Lens[UpperPB, io.envoyproxy.envoy.`type`.v3.Percent] = field(_.getSuccessRateEjectionThreshold)((c_, f_) => c_.copy(successRateEjectionThreshold = Option(f_)))
def optionalSuccessRateEjectionThreshold: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Option[io.envoyproxy.envoy.`type`.v3.Percent]] = field(_.successRateEjectionThreshold)((c_, f_) => c_.copy(successRateEjectionThreshold = f_))
def hostStatuses: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Seq[io.envoyproxy.envoy.admin.v3.HostStatus]] = field(_.hostStatuses)((c_, f_) => c_.copy(hostStatuses = f_))
def localOriginSuccessRateEjectionThreshold: _root_.scalapb.lenses.Lens[UpperPB, io.envoyproxy.envoy.`type`.v3.Percent] = field(_.getLocalOriginSuccessRateEjectionThreshold)((c_, f_) => c_.copy(localOriginSuccessRateEjectionThreshold = Option(f_)))
def optionalLocalOriginSuccessRateEjectionThreshold: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Option[io.envoyproxy.envoy.`type`.v3.Percent]] = field(_.localOriginSuccessRateEjectionThreshold)((c_, f_) => c_.copy(localOriginSuccessRateEjectionThreshold = f_))
def circuitBreakers: _root_.scalapb.lenses.Lens[UpperPB, io.envoyproxy.envoy.config.cluster.v3.CircuitBreakers] = field(_.getCircuitBreakers)((c_, f_) => c_.copy(circuitBreakers = Option(f_)))
def optionalCircuitBreakers: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Option[io.envoyproxy.envoy.config.cluster.v3.CircuitBreakers]] = field(_.circuitBreakers)((c_, f_) => c_.copy(circuitBreakers = f_))
def observabilityName: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Predef.String] = field(_.observabilityName)((c_, f_) => c_.copy(observabilityName = f_))
}
final val NAME_FIELD_NUMBER = 1
final val ADDED_VIA_API_FIELD_NUMBER = 2
final val SUCCESS_RATE_EJECTION_THRESHOLD_FIELD_NUMBER = 3
final val HOST_STATUSES_FIELD_NUMBER = 4
final val LOCAL_ORIGIN_SUCCESS_RATE_EJECTION_THRESHOLD_FIELD_NUMBER = 5
final val CIRCUIT_BREAKERS_FIELD_NUMBER = 6
final val OBSERVABILITY_NAME_FIELD_NUMBER = 7
def of(
name: _root_.scala.Predef.String,
addedViaApi: _root_.scala.Boolean,
successRateEjectionThreshold: _root_.scala.Option[io.envoyproxy.envoy.`type`.v3.Percent],
hostStatuses: _root_.scala.Seq[io.envoyproxy.envoy.admin.v3.HostStatus],
localOriginSuccessRateEjectionThreshold: _root_.scala.Option[io.envoyproxy.envoy.`type`.v3.Percent],
circuitBreakers: _root_.scala.Option[io.envoyproxy.envoy.config.cluster.v3.CircuitBreakers],
observabilityName: _root_.scala.Predef.String
): _root_.io.envoyproxy.envoy.admin.v3.ClusterStatus = _root_.io.envoyproxy.envoy.admin.v3.ClusterStatus(
name,
addedViaApi,
successRateEjectionThreshold,
hostStatuses,
localOriginSuccessRateEjectionThreshold,
circuitBreakers,
observabilityName
)
// @@protoc_insertion_point(GeneratedMessageCompanion[envoy.admin.v3.ClusterStatus])
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy