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

Class ApiKeyAuthPerRoute

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.api_key_auth.v3.ApiKeyAuthPerRoute
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ApiKeyAuthPerRouteOrBuilder, Serializable
public final class ApiKeyAuthPerRoute extends com.google.protobuf.GeneratedMessageV3 implements ApiKeyAuthPerRouteOrBuilder
 API key auth configuration of per route or per virtual host or per route configuration.
Protobuf type envoy.extensions.filters.http.api_key_auth.v3.ApiKeyAuthPerRoute
See Also:

  • Field Details

    • CREDENTIALS_FIELD_NUMBER

      public static final int CREDENTIALS_FIELD_NUMBER
      See Also:

    • KEY_SOURCES_FIELD_NUMBER

      public static final int KEY_SOURCES_FIELD_NUMBER
      See Also:

    • ALLOWED_CLIENTS_FIELD_NUMBER

      public static final int ALLOWED_CLIENTS_FIELD_NUMBER
      See Also:

    • FORWARDING_FIELD_NUMBER

      public static final int FORWARDING_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getCredentialsList

      public 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];
      Specified by:
      getCredentialsList in interface ApiKeyAuthPerRouteOrBuilder

    • getCredentialsOrBuilderList

      public 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];
      Specified by:
      getCredentialsOrBuilderList in interface ApiKeyAuthPerRouteOrBuilder

    • getCredentialsCount

      public 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];
      Specified by:
      getCredentialsCount in interface ApiKeyAuthPerRouteOrBuilder

    • getCredentials

      public 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];
      Specified by:
      getCredentials in interface ApiKeyAuthPerRouteOrBuilder

    • getCredentialsOrBuilder

      public 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];
      Specified by:
      getCredentialsOrBuilder in interface ApiKeyAuthPerRouteOrBuilder

    • getKeySourcesList

      public 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;
      Specified by:
      getKeySourcesList in interface ApiKeyAuthPerRouteOrBuilder

    • getKeySourcesOrBuilderList

      public 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;
      Specified by:
      getKeySourcesOrBuilderList in interface ApiKeyAuthPerRouteOrBuilder

    • getKeySourcesCount

      public 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;
      Specified by:
      getKeySourcesCount in interface ApiKeyAuthPerRouteOrBuilder

    • getKeySources

      public 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;
      Specified by:
      getKeySources in interface ApiKeyAuthPerRouteOrBuilder

    • getKeySourcesOrBuilder

      public 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;
      Specified by:
      getKeySourcesOrBuilder in interface ApiKeyAuthPerRouteOrBuilder

    • getAllowedClientsList

      public com.google.protobuf.ProtocolStringList 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;
      Specified by:
      getAllowedClientsList in interface ApiKeyAuthPerRouteOrBuilder
      Returns:
      A list containing the allowedClients.

    • getAllowedClientsCount

      public 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;
      Specified by:
      getAllowedClientsCount in interface ApiKeyAuthPerRouteOrBuilder
      Returns:
      The count of allowedClients.

    • getAllowedClients

      public 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;
      Specified by:
      getAllowedClients in interface ApiKeyAuthPerRouteOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The allowedClients at the given index.

    • getAllowedClientsBytes

      public 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;
      Specified by:
      getAllowedClientsBytes in interface ApiKeyAuthPerRouteOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the allowedClients at the given index.

    • hasForwarding

      public 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;
      Specified by:
      hasForwarding in interface ApiKeyAuthPerRouteOrBuilder
      Returns:
      Whether the forwarding field is set.

    • getForwarding

      public 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;
      Specified by:
      getForwarding in interface ApiKeyAuthPerRouteOrBuilder
      Returns:
      The forwarding.

    • getForwardingOrBuilder

      public 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;
      Specified by:
      getForwardingOrBuilder in interface ApiKeyAuthPerRouteOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ApiKeyAuthPerRoute parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ApiKeyAuthPerRoute parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ApiKeyAuthPerRoute parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ApiKeyAuthPerRoute parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ApiKeyAuthPerRoute parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ApiKeyAuthPerRoute parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ApiKeyAuthPerRoute parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ApiKeyAuthPerRoute parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ApiKeyAuthPerRoute parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ApiKeyAuthPerRoute parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ApiKeyAuthPerRoute parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ApiKeyAuthPerRoute parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ApiKeyAuthPerRoute.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ApiKeyAuthPerRoute.Builder newBuilder()

    • newBuilder

      public static ApiKeyAuthPerRoute.Builder newBuilder(ApiKeyAuthPerRoute prototype)

    • toBuilder

      public ApiKeyAuthPerRoute.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ApiKeyAuthPerRoute.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ApiKeyAuthPerRoute getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ApiKeyAuthPerRoute> parser()

    • getParserForType

      public com.google.protobuf.Parser<ApiKeyAuthPerRoute> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public ApiKeyAuthPerRoute getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder