All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.envoyproxy.envoy.service.auth.v3.OkHttpResponse.scala Maven / Gradle / Ivy

There is a newer version: 1.23.0-dev-f04150-1
Show newest version
// Generated by the Scala Plugin for the Protocol Buffer Compiler.
// Do not edit!
//
// Protofile syntax: PROTO3

package io.envoyproxy.envoy.service.auth.v3

/** HTTP attributes for an OK response.
  * [#next-free-field: 9]
  *
  * @param headers
  *   HTTP entity headers in addition to the original request headers. This allows the authorization
  *   service to append, to add or to override headers from the original request before
  *   dispatching it to the upstream. Note that the :ref:`append field in HeaderValueOption <envoy_v3_api_field_config.core.v3.HeaderValueOption.append>` defaults to
  *   false when used in this message. By setting the `append` field to `true`,
  *   the filter will append the correspondent header value to the matched request header.
  *   By leaving `append` as false, the filter will either add a new header, or override an existing
  *   one if there is a match.
  * @param headersToRemove
  *   HTTP entity headers to remove from the original request before dispatching
  *   it to the upstream. This allows the authorization service to act on auth
  *   related headers (like `Authorization`), process them, and consume them.
  *   Under this model, the upstream will either receive the request (if it's
  *   authorized) or not receive it (if it's not), but will not see headers
  *   containing authorization credentials.
  *  
  *   Pseudo headers (such as `:authority`, `:method`, `:path` etc), as well as
  *   the header `Host`, may not be removed as that would make the request
  *   malformed. If mentioned in `headers_to_remove` these special headers will
  *   be ignored.
  *  
  *   When using the HTTP service this must instead be set by the HTTP
  *   authorization service as a comma separated list like so:
  *   ``x-envoy-auth-headers-to-remove: one-auth-header, another-auth-header``.
  * @param dynamicMetadata
  *   This field has been deprecated in favor of :ref:`CheckResponse.dynamic_metadata
  *   <envoy_v3_api_field_service.auth.v3.CheckResponse.dynamic_metadata>`. Until it is removed,
  *   setting this field overrides :ref:`CheckResponse.dynamic_metadata
  *   <envoy_v3_api_field_service.auth.v3.CheckResponse.dynamic_metadata>`.
  * @param responseHeadersToAdd
  *   This field allows the authorization service to send HTTP response headers
  *   to the downstream client on success. Note that the :ref:`append field in HeaderValueOption <envoy_v3_api_field_config.core.v3.HeaderValueOption.append>`
  *   defaults to false when used in this message.
  * @param queryParametersToSet
  *   This field allows the authorization service to set (and overwrite) query
  *   string parameters on the original request before it is sent upstream.
  * @param queryParametersToRemove
  *   This field allows the authorization service to specify which query parameters
  *   should be removed from the original request before it is sent upstream. Each
  *   element in this list is a case-sensitive query parameter name to be removed.
  */
@SerialVersionUID(0L)
final case class OkHttpResponse(
    headers: _root_.scala.Seq[io.envoyproxy.envoy.config.core.v3.HeaderValueOption] = _root_.scala.Seq.empty,
    headersToRemove: _root_.scala.Seq[_root_.scala.Predef.String] = _root_.scala.Seq.empty,
    @scala.deprecated(message="Marked as deprecated in proto file", "") dynamicMetadata: _root_.scala.Option[com.google.protobuf.struct.Struct] = _root_.scala.None,
    responseHeadersToAdd: _root_.scala.Seq[io.envoyproxy.envoy.config.core.v3.HeaderValueOption] = _root_.scala.Seq.empty,
    queryParametersToSet: _root_.scala.Seq[io.envoyproxy.envoy.config.core.v3.QueryParameter] = _root_.scala.Seq.empty,
    queryParametersToRemove: _root_.scala.Seq[_root_.scala.Predef.String] = _root_.scala.Seq.empty,
    unknownFields: _root_.scalapb.UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty
    ) extends scalapb.GeneratedMessage with scalapb.lenses.Updatable[OkHttpResponse] {
    @transient
    private[this] var __serializedSizeMemoized: _root_.scala.Int = 0
    private[this] def __computeSerializedSize(): _root_.scala.Int = {
      var __size = 0
      headers.foreach { __item =>
        val __value = __item
        __size += 1 + _root_.com.google.protobuf.CodedOutputStream.computeUInt32SizeNoTag(__value.serializedSize) + __value.serializedSize
      }
      headersToRemove.foreach { __item =>
        val __value = __item
        __size += _root_.com.google.protobuf.CodedOutputStream.computeStringSize(5, __value)
      }
      if (dynamicMetadata.isDefined) {
        val __value = dynamicMetadata.get
        __size += 1 + _root_.com.google.protobuf.CodedOutputStream.computeUInt32SizeNoTag(__value.serializedSize) + __value.serializedSize
      };
      responseHeadersToAdd.foreach { __item =>
        val __value = __item
        __size += 1 + _root_.com.google.protobuf.CodedOutputStream.computeUInt32SizeNoTag(__value.serializedSize) + __value.serializedSize
      }
      queryParametersToSet.foreach { __item =>
        val __value = __item
        __size += 1 + _root_.com.google.protobuf.CodedOutputStream.computeUInt32SizeNoTag(__value.serializedSize) + __value.serializedSize
      }
      queryParametersToRemove.foreach { __item =>
        val __value = __item
        __size += _root_.com.google.protobuf.CodedOutputStream.computeStringSize(8, __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 = {
      headers.foreach { __v =>
        val __m = __v
        _output__.writeTag(2, 2)
        _output__.writeUInt32NoTag(__m.serializedSize)
        __m.writeTo(_output__)
      };
      dynamicMetadata.foreach { __v =>
        val __m = __v
        _output__.writeTag(3, 2)
        _output__.writeUInt32NoTag(__m.serializedSize)
        __m.writeTo(_output__)
      };
      headersToRemove.foreach { __v =>
        val __m = __v
        _output__.writeString(5, __m)
      };
      responseHeadersToAdd.foreach { __v =>
        val __m = __v
        _output__.writeTag(6, 2)
        _output__.writeUInt32NoTag(__m.serializedSize)
        __m.writeTo(_output__)
      };
      queryParametersToSet.foreach { __v =>
        val __m = __v
        _output__.writeTag(7, 2)
        _output__.writeUInt32NoTag(__m.serializedSize)
        __m.writeTo(_output__)
      };
      queryParametersToRemove.foreach { __v =>
        val __m = __v
        _output__.writeString(8, __m)
      };
      unknownFields.writeTo(_output__)
    }
    def clearHeaders = copy(headers = _root_.scala.Seq.empty)
    def addHeaders(__vs: io.envoyproxy.envoy.config.core.v3.HeaderValueOption *): OkHttpResponse = addAllHeaders(__vs)
    def addAllHeaders(__vs: Iterable[io.envoyproxy.envoy.config.core.v3.HeaderValueOption]): OkHttpResponse = copy(headers = headers ++ __vs)
    def withHeaders(__v: _root_.scala.Seq[io.envoyproxy.envoy.config.core.v3.HeaderValueOption]): OkHttpResponse = copy(headers = __v)
    def clearHeadersToRemove = copy(headersToRemove = _root_.scala.Seq.empty)
    def addHeadersToRemove(__vs: _root_.scala.Predef.String *): OkHttpResponse = addAllHeadersToRemove(__vs)
    def addAllHeadersToRemove(__vs: Iterable[_root_.scala.Predef.String]): OkHttpResponse = copy(headersToRemove = headersToRemove ++ __vs)
    def withHeadersToRemove(__v: _root_.scala.Seq[_root_.scala.Predef.String]): OkHttpResponse = copy(headersToRemove = __v)
    def getDynamicMetadata: com.google.protobuf.struct.Struct = dynamicMetadata.getOrElse(com.google.protobuf.struct.Struct.defaultInstance)
    def clearDynamicMetadata: OkHttpResponse = copy(dynamicMetadata = _root_.scala.None)
    def withDynamicMetadata(__v: com.google.protobuf.struct.Struct): OkHttpResponse = copy(dynamicMetadata = Option(__v))
    def clearResponseHeadersToAdd = copy(responseHeadersToAdd = _root_.scala.Seq.empty)
    def addResponseHeadersToAdd(__vs: io.envoyproxy.envoy.config.core.v3.HeaderValueOption *): OkHttpResponse = addAllResponseHeadersToAdd(__vs)
    def addAllResponseHeadersToAdd(__vs: Iterable[io.envoyproxy.envoy.config.core.v3.HeaderValueOption]): OkHttpResponse = copy(responseHeadersToAdd = responseHeadersToAdd ++ __vs)
    def withResponseHeadersToAdd(__v: _root_.scala.Seq[io.envoyproxy.envoy.config.core.v3.HeaderValueOption]): OkHttpResponse = copy(responseHeadersToAdd = __v)
    def clearQueryParametersToSet = copy(queryParametersToSet = _root_.scala.Seq.empty)
    def addQueryParametersToSet(__vs: io.envoyproxy.envoy.config.core.v3.QueryParameter *): OkHttpResponse = addAllQueryParametersToSet(__vs)
    def addAllQueryParametersToSet(__vs: Iterable[io.envoyproxy.envoy.config.core.v3.QueryParameter]): OkHttpResponse = copy(queryParametersToSet = queryParametersToSet ++ __vs)
    def withQueryParametersToSet(__v: _root_.scala.Seq[io.envoyproxy.envoy.config.core.v3.QueryParameter]): OkHttpResponse = copy(queryParametersToSet = __v)
    def clearQueryParametersToRemove = copy(queryParametersToRemove = _root_.scala.Seq.empty)
    def addQueryParametersToRemove(__vs: _root_.scala.Predef.String *): OkHttpResponse = addAllQueryParametersToRemove(__vs)
    def addAllQueryParametersToRemove(__vs: Iterable[_root_.scala.Predef.String]): OkHttpResponse = copy(queryParametersToRemove = queryParametersToRemove ++ __vs)
    def withQueryParametersToRemove(__v: _root_.scala.Seq[_root_.scala.Predef.String]): OkHttpResponse = copy(queryParametersToRemove = __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 2 => headers
        case 5 => headersToRemove
        case 3 => dynamicMetadata.orNull
        case 6 => responseHeadersToAdd
        case 7 => queryParametersToSet
        case 8 => queryParametersToRemove
      }
    }
    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 2 => _root_.scalapb.descriptors.PRepeated(headers.iterator.map(_.toPMessage).toVector)
        case 5 => _root_.scalapb.descriptors.PRepeated(headersToRemove.iterator.map(_root_.scalapb.descriptors.PString(_)).toVector)
        case 3 => dynamicMetadata.map(_.toPMessage).getOrElse(_root_.scalapb.descriptors.PEmpty)
        case 6 => _root_.scalapb.descriptors.PRepeated(responseHeadersToAdd.iterator.map(_.toPMessage).toVector)
        case 7 => _root_.scalapb.descriptors.PRepeated(queryParametersToSet.iterator.map(_.toPMessage).toVector)
        case 8 => _root_.scalapb.descriptors.PRepeated(queryParametersToRemove.iterator.map(_root_.scalapb.descriptors.PString(_)).toVector)
      }
    }
    def toProtoString: _root_.scala.Predef.String = _root_.scalapb.TextFormat.printToUnicodeString(this)
    def companion: io.envoyproxy.envoy.service.auth.v3.OkHttpResponse.type = io.envoyproxy.envoy.service.auth.v3.OkHttpResponse
    // @@protoc_insertion_point(GeneratedMessage[envoy.service.auth.v3.OkHttpResponse])
}

object OkHttpResponse extends scalapb.GeneratedMessageCompanion[io.envoyproxy.envoy.service.auth.v3.OkHttpResponse] {
  implicit def messageCompanion: scalapb.GeneratedMessageCompanion[io.envoyproxy.envoy.service.auth.v3.OkHttpResponse] = this
  def parseFrom(`_input__`: _root_.com.google.protobuf.CodedInputStream): io.envoyproxy.envoy.service.auth.v3.OkHttpResponse = {
    val __headers: _root_.scala.collection.immutable.VectorBuilder[io.envoyproxy.envoy.config.core.v3.HeaderValueOption] = new _root_.scala.collection.immutable.VectorBuilder[io.envoyproxy.envoy.config.core.v3.HeaderValueOption]
    val __headersToRemove: _root_.scala.collection.immutable.VectorBuilder[_root_.scala.Predef.String] = new _root_.scala.collection.immutable.VectorBuilder[_root_.scala.Predef.String]
    var __dynamicMetadata: _root_.scala.Option[com.google.protobuf.struct.Struct] = _root_.scala.None
    val __responseHeadersToAdd: _root_.scala.collection.immutable.VectorBuilder[io.envoyproxy.envoy.config.core.v3.HeaderValueOption] = new _root_.scala.collection.immutable.VectorBuilder[io.envoyproxy.envoy.config.core.v3.HeaderValueOption]
    val __queryParametersToSet: _root_.scala.collection.immutable.VectorBuilder[io.envoyproxy.envoy.config.core.v3.QueryParameter] = new _root_.scala.collection.immutable.VectorBuilder[io.envoyproxy.envoy.config.core.v3.QueryParameter]
    val __queryParametersToRemove: _root_.scala.collection.immutable.VectorBuilder[_root_.scala.Predef.String] = new _root_.scala.collection.immutable.VectorBuilder[_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 18 =>
          __headers += _root_.scalapb.LiteParser.readMessage[io.envoyproxy.envoy.config.core.v3.HeaderValueOption](_input__)
        case 42 =>
          __headersToRemove += _input__.readStringRequireUtf8()
        case 26 =>
          __dynamicMetadata = Option(__dynamicMetadata.fold(_root_.scalapb.LiteParser.readMessage[com.google.protobuf.struct.Struct](_input__))(_root_.scalapb.LiteParser.readMessage(_input__, _)))
        case 50 =>
          __responseHeadersToAdd += _root_.scalapb.LiteParser.readMessage[io.envoyproxy.envoy.config.core.v3.HeaderValueOption](_input__)
        case 58 =>
          __queryParametersToSet += _root_.scalapb.LiteParser.readMessage[io.envoyproxy.envoy.config.core.v3.QueryParameter](_input__)
        case 66 =>
          __queryParametersToRemove += _input__.readStringRequireUtf8()
        case tag =>
          if (_unknownFields__ == null) {
            _unknownFields__ = new _root_.scalapb.UnknownFieldSet.Builder()
          }
          _unknownFields__.parseField(tag, _input__)
      }
    }
    io.envoyproxy.envoy.service.auth.v3.OkHttpResponse(
        headers = __headers.result(),
        headersToRemove = __headersToRemove.result(),
        dynamicMetadata = __dynamicMetadata,
        responseHeadersToAdd = __responseHeadersToAdd.result(),
        queryParametersToSet = __queryParametersToSet.result(),
        queryParametersToRemove = __queryParametersToRemove.result(),
        unknownFields = if (_unknownFields__ == null) _root_.scalapb.UnknownFieldSet.empty else _unknownFields__.result()
    )
  }
  implicit def messageReads: _root_.scalapb.descriptors.Reads[io.envoyproxy.envoy.service.auth.v3.OkHttpResponse] = _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.service.auth.v3.OkHttpResponse(
        headers = __fieldsMap.get(scalaDescriptor.findFieldByNumber(2).get).map(_.as[_root_.scala.Seq[io.envoyproxy.envoy.config.core.v3.HeaderValueOption]]).getOrElse(_root_.scala.Seq.empty),
        headersToRemove = __fieldsMap.get(scalaDescriptor.findFieldByNumber(5).get).map(_.as[_root_.scala.Seq[_root_.scala.Predef.String]]).getOrElse(_root_.scala.Seq.empty),
        dynamicMetadata = __fieldsMap.get(scalaDescriptor.findFieldByNumber(3).get).flatMap(_.as[_root_.scala.Option[com.google.protobuf.struct.Struct]]),
        responseHeadersToAdd = __fieldsMap.get(scalaDescriptor.findFieldByNumber(6).get).map(_.as[_root_.scala.Seq[io.envoyproxy.envoy.config.core.v3.HeaderValueOption]]).getOrElse(_root_.scala.Seq.empty),
        queryParametersToSet = __fieldsMap.get(scalaDescriptor.findFieldByNumber(7).get).map(_.as[_root_.scala.Seq[io.envoyproxy.envoy.config.core.v3.QueryParameter]]).getOrElse(_root_.scala.Seq.empty),
        queryParametersToRemove = __fieldsMap.get(scalaDescriptor.findFieldByNumber(8).get).map(_.as[_root_.scala.Seq[_root_.scala.Predef.String]]).getOrElse(_root_.scala.Seq.empty)
      )
    case _ => throw new RuntimeException("Expected PMessage")
  }
  def javaDescriptor: _root_.com.google.protobuf.Descriptors.Descriptor = ExternalAuthProto.javaDescriptor.getMessageTypes().get(2)
  def scalaDescriptor: _root_.scalapb.descriptors.Descriptor = ExternalAuthProto.scalaDescriptor.messages(2)
  def messageCompanionForFieldNumber(__number: _root_.scala.Int): _root_.scalapb.GeneratedMessageCompanion[_] = {
    var __out: _root_.scalapb.GeneratedMessageCompanion[_] = null
    (__number: @_root_.scala.unchecked) match {
      case 2 => __out = io.envoyproxy.envoy.config.core.v3.HeaderValueOption
      case 3 => __out = com.google.protobuf.struct.Struct
      case 6 => __out = io.envoyproxy.envoy.config.core.v3.HeaderValueOption
      case 7 => __out = io.envoyproxy.envoy.config.core.v3.QueryParameter
    }
    __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.service.auth.v3.OkHttpResponse(
    headers = _root_.scala.Seq.empty,
    headersToRemove = _root_.scala.Seq.empty,
    dynamicMetadata = _root_.scala.None,
    responseHeadersToAdd = _root_.scala.Seq.empty,
    queryParametersToSet = _root_.scala.Seq.empty,
    queryParametersToRemove = _root_.scala.Seq.empty
  )
  implicit class OkHttpResponseLens[UpperPB](_l: _root_.scalapb.lenses.Lens[UpperPB, io.envoyproxy.envoy.service.auth.v3.OkHttpResponse]) extends _root_.scalapb.lenses.ObjectLens[UpperPB, io.envoyproxy.envoy.service.auth.v3.OkHttpResponse](_l) {
    def headers: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Seq[io.envoyproxy.envoy.config.core.v3.HeaderValueOption]] = field(_.headers)((c_, f_) => c_.copy(headers = f_))
    def headersToRemove: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Seq[_root_.scala.Predef.String]] = field(_.headersToRemove)((c_, f_) => c_.copy(headersToRemove = f_))
    def dynamicMetadata: _root_.scalapb.lenses.Lens[UpperPB, com.google.protobuf.struct.Struct] = field(_.getDynamicMetadata)((c_, f_) => c_.copy(dynamicMetadata = Option(f_)))
    def optionalDynamicMetadata: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Option[com.google.protobuf.struct.Struct]] = field(_.dynamicMetadata)((c_, f_) => c_.copy(dynamicMetadata = f_))
    def responseHeadersToAdd: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Seq[io.envoyproxy.envoy.config.core.v3.HeaderValueOption]] = field(_.responseHeadersToAdd)((c_, f_) => c_.copy(responseHeadersToAdd = f_))
    def queryParametersToSet: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Seq[io.envoyproxy.envoy.config.core.v3.QueryParameter]] = field(_.queryParametersToSet)((c_, f_) => c_.copy(queryParametersToSet = f_))
    def queryParametersToRemove: _root_.scalapb.lenses.Lens[UpperPB, _root_.scala.Seq[_root_.scala.Predef.String]] = field(_.queryParametersToRemove)((c_, f_) => c_.copy(queryParametersToRemove = f_))
  }
  final val HEADERS_FIELD_NUMBER = 2
  final val HEADERS_TO_REMOVE_FIELD_NUMBER = 5
  final val DYNAMIC_METADATA_FIELD_NUMBER = 3
  final val RESPONSE_HEADERS_TO_ADD_FIELD_NUMBER = 6
  final val QUERY_PARAMETERS_TO_SET_FIELD_NUMBER = 7
  final val QUERY_PARAMETERS_TO_REMOVE_FIELD_NUMBER = 8
  def of(
    headers: _root_.scala.Seq[io.envoyproxy.envoy.config.core.v3.HeaderValueOption],
    headersToRemove: _root_.scala.Seq[_root_.scala.Predef.String],
    dynamicMetadata: _root_.scala.Option[com.google.protobuf.struct.Struct],
    responseHeadersToAdd: _root_.scala.Seq[io.envoyproxy.envoy.config.core.v3.HeaderValueOption],
    queryParametersToSet: _root_.scala.Seq[io.envoyproxy.envoy.config.core.v3.QueryParameter],
    queryParametersToRemove: _root_.scala.Seq[_root_.scala.Predef.String]
  ): _root_.io.envoyproxy.envoy.service.auth.v3.OkHttpResponse = _root_.io.envoyproxy.envoy.service.auth.v3.OkHttpResponse(
    headers,
    headersToRemove,
    dynamicMetadata,
    responseHeadersToAdd,
    queryParametersToSet,
    queryParametersToRemove
  )
  // @@protoc_insertion_point(GeneratedMessageCompanion[envoy.service.auth.v3.OkHttpResponse])
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy