Package io.envoyproxy.envoy.extensions.filters.http.api_key_auth.v3

Interface ForwardingOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Forwarding, Forwarding.Builder
public interface ForwardingOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getHeader()
    The header name in which to store the client information.
    com.google.protobuf.ByteString
    getHeaderBytes()
    The header name in which to store the client information.
    boolean
    getHideCredentials()
    If true, remove the API key from the request before forwarding upstream.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getHeader

      String getHeader()
       The header name in which to store the client information. If this field is non-empty,
 the client string associated with the matched credential will be injected into
 the request before forwarding upstream.
      string header = 1 [(.validate.rules) = { ... }
      Returns:
      The header.

    • getHeaderBytes

      com.google.protobuf.ByteString getHeaderBytes()
       The header name in which to store the client information. If this field is non-empty,
 the client string associated with the matched credential will be injected into
 the request before forwarding upstream.
      string header = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for header.

    • getHideCredentials

      boolean getHideCredentials()
       If true, remove the API key from the request before forwarding upstream.

 This applies to all configured key sources: ``header``, ``query``, and ``cookie``.
      bool hide_credentials = 2;
      Returns:
      The hideCredentials.