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

Interface KeySourceOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCookie()
    The cookie name to fetch the key.
    com.google.protobuf.ByteString
    getCookieBytes()
    The cookie name to fetch the key.
    String
    getHeader()
    The header name to fetch the key.
    com.google.protobuf.ByteString
    getHeaderBytes()
    The header name to fetch the key.
    String
    getQuery()
    The query parameter name to fetch the key.
    com.google.protobuf.ByteString
    getQueryBytes()
    The query parameter name to fetch the key.

    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 to fetch the key. If multiple header values are present, the first one will be
 used. If the header value starts with 'Bearer ', this prefix will be stripped to get the
 key value.

 If set, takes precedence over ``query`` and ``cookie``.
      string header = 1 [(.validate.rules) = { ... }
      Returns:
      The header.

    • getHeaderBytes

      com.google.protobuf.ByteString getHeaderBytes()
       The header name to fetch the key. If multiple header values are present, the first one will be
 used. If the header value starts with 'Bearer ', this prefix will be stripped to get the
 key value.

 If set, takes precedence over ``query`` and ``cookie``.
      string header = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for header.

    • getQuery

      String getQuery()
       The query parameter name to fetch the key. If multiple query values are present, the first one
 will be used.

 The field will be used if ``header`` is not set. If set, takes precedence over ``cookie``.
      string query = 2 [(.validate.rules) = { ... }
      Returns:
      The query.

    • getQueryBytes

      com.google.protobuf.ByteString getQueryBytes()
       The query parameter name to fetch the key. If multiple query values are present, the first one
 will be used.

 The field will be used if ``header`` is not set. If set, takes precedence over ``cookie``.
      string query = 2 [(.validate.rules) = { ... }
      Returns:
      The bytes for query.

    • getCookie

      String getCookie()
       The cookie name to fetch the key.

 The field will be used if the ``header`` and ``query`` are not set.
      string cookie = 3 [(.validate.rules) = { ... }
      Returns:
      The cookie.

    • getCookieBytes

      com.google.protobuf.ByteString getCookieBytes()
       The cookie name to fetch the key.

 The field will be used if the ``header`` and ``query`` are not set.
      string cookie = 3 [(.validate.rules) = { ... }
      Returns:
      The bytes for cookie.