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

Interface ApiKeyAuthPerRouteOrBuilder

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

  • Method Details

    • getCredentialsList

      List<Credential> getCredentialsList()
       The credentials that are used to authenticate the clients. If this field is non-empty, then the
 credentials in the filter level configuration will be ignored and the credentials in this
 configuration will be used.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • getCredentials

      Credential getCredentials(int index)
       The credentials that are used to authenticate the clients. If this field is non-empty, then the
 credentials in the filter level configuration will be ignored and the credentials in this
 configuration will be used.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • getCredentialsCount

      int getCredentialsCount()
       The credentials that are used to authenticate the clients. If this field is non-empty, then the
 credentials in the filter level configuration will be ignored and the credentials in this
 configuration will be used.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • getCredentialsOrBuilderList

      List<? extends CredentialOrBuilder> getCredentialsOrBuilderList()
       The credentials that are used to authenticate the clients. If this field is non-empty, then the
 credentials in the filter level configuration will be ignored and the credentials in this
 configuration will be used.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • getCredentialsOrBuilder

      CredentialOrBuilder getCredentialsOrBuilder(int index)
       The credentials that are used to authenticate the clients. If this field is non-empty, then the
 credentials in the filter level configuration will be ignored and the credentials in this
 configuration will be used.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • getKeySourcesList

      List<KeySource> getKeySourcesList()
       The key sources to fetch the key from the coming request. If this field is non-empty, then the
 key sources in the filter level configuration will be ignored and the key sources in this
 configuration will be used.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • getKeySources

      KeySource getKeySources(int index)
       The key sources to fetch the key from the coming request. If this field is non-empty, then the
 key sources in the filter level configuration will be ignored and the key sources in this
 configuration will be used.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • getKeySourcesCount

      int getKeySourcesCount()
       The key sources to fetch the key from the coming request. If this field is non-empty, then the
 key sources in the filter level configuration will be ignored and the key sources in this
 configuration will be used.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • getKeySourcesOrBuilderList

      List<? extends KeySourceOrBuilder> getKeySourcesOrBuilderList()
       The key sources to fetch the key from the coming request. If this field is non-empty, then the
 key sources in the filter level configuration will be ignored and the key sources in this
 configuration will be used.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • getKeySourcesOrBuilder

      KeySourceOrBuilder getKeySourcesOrBuilder(int index)
       The key sources to fetch the key from the coming request. If this field is non-empty, then the
 key sources in the filter level configuration will be ignored and the key sources in this
 configuration will be used.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • getAllowedClientsList

      List<String> getAllowedClientsList()
       A list of clients that are allowed to access the route or vhost. The clients listed here
 should be subset of the clients listed in the ``credentials`` to provide authorization control
 after the authentication is successful. If the list is empty, then all authenticated clients
 are allowed. This provides very limited but simple authorization. If more complex authorization
 is required, then use the :ref:`HTTP RBAC filter <config_http_filters_rbac>` instead.

 .. note::
   Setting this field and ``credentials`` at the same configuration entry is not an error but
   also makes no much sense because they provide similar functionality. Please only use
   one of them at same configuration entry except for the case that you want to share the same
   credentials list across multiple routes but still use different allowed clients for each
   route.
      repeated string allowed_clients = 3;
      Returns:
      A list containing the allowedClients.

    • getAllowedClientsCount

      int getAllowedClientsCount()
       A list of clients that are allowed to access the route or vhost. The clients listed here
 should be subset of the clients listed in the ``credentials`` to provide authorization control
 after the authentication is successful. If the list is empty, then all authenticated clients
 are allowed. This provides very limited but simple authorization. If more complex authorization
 is required, then use the :ref:`HTTP RBAC filter <config_http_filters_rbac>` instead.

 .. note::
   Setting this field and ``credentials`` at the same configuration entry is not an error but
   also makes no much sense because they provide similar functionality. Please only use
   one of them at same configuration entry except for the case that you want to share the same
   credentials list across multiple routes but still use different allowed clients for each
   route.
      repeated string allowed_clients = 3;
      Returns:
      The count of allowedClients.

    • getAllowedClients

      String getAllowedClients(int index)
       A list of clients that are allowed to access the route or vhost. The clients listed here
 should be subset of the clients listed in the ``credentials`` to provide authorization control
 after the authentication is successful. If the list is empty, then all authenticated clients
 are allowed. This provides very limited but simple authorization. If more complex authorization
 is required, then use the :ref:`HTTP RBAC filter <config_http_filters_rbac>` instead.

 .. note::
   Setting this field and ``credentials`` at the same configuration entry is not an error but
   also makes no much sense because they provide similar functionality. Please only use
   one of them at same configuration entry except for the case that you want to share the same
   credentials list across multiple routes but still use different allowed clients for each
   route.
      repeated string allowed_clients = 3;
      Parameters:
      index - The index of the element to return.
      Returns:
      The allowedClients at the given index.

    • getAllowedClientsBytes

      com.google.protobuf.ByteString getAllowedClientsBytes(int index)
       A list of clients that are allowed to access the route or vhost. The clients listed here
 should be subset of the clients listed in the ``credentials`` to provide authorization control
 after the authentication is successful. If the list is empty, then all authenticated clients
 are allowed. This provides very limited but simple authorization. If more complex authorization
 is required, then use the :ref:`HTTP RBAC filter <config_http_filters_rbac>` instead.

 .. note::
   Setting this field and ``credentials`` at the same configuration entry is not an error but
   also makes no much sense because they provide similar functionality. Please only use
   one of them at same configuration entry except for the case that you want to share the same
   credentials list across multiple routes but still use different allowed clients for each
   route.
      repeated string allowed_clients = 3;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the allowedClients at the given index.

    • hasForwarding

      boolean hasForwarding()
       Optional configuration to control what information should be propagated to upstream services.
 If this field is non-empty, then the forwarding information in the filter level configuration
 will be ignored and the forwarding in this configuration will be used.
      .envoy.extensions.filters.http.api_key_auth.v3.Forwarding forwarding = 4;
      Returns:
      Whether the forwarding field is set.

    • getForwarding

      Forwarding getForwarding()
       Optional configuration to control what information should be propagated to upstream services.
 If this field is non-empty, then the forwarding information in the filter level configuration
 will be ignored and the forwarding in this configuration will be used.
      .envoy.extensions.filters.http.api_key_auth.v3.Forwarding forwarding = 4;
      Returns:
      The forwarding.

    • getForwardingOrBuilder

      ForwardingOrBuilder getForwardingOrBuilder()
       Optional configuration to control what information should be propagated to upstream services.
 If this field is non-empty, then the forwarding information in the filter level configuration
 will be ignored and the forwarding in this configuration will be used.
      .envoy.extensions.filters.http.api_key_auth.v3.Forwarding forwarding = 4;