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

Class ApiKeyAuth.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ApiKeyAuth.Builder>
io.envoyproxy.envoy.extensions.filters.http.api_key_auth.v3.ApiKeyAuth.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ApiKeyAuthOrBuilder, Cloneable
Enclosing class:
ApiKeyAuth
public static final class ApiKeyAuth.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<ApiKeyAuth.Builder> implements ApiKeyAuthOrBuilder
 API Key HTTP authentication.

 For example, the following configuration configures the filter to authenticate the clients using
 the API key from the header ``X-API-KEY``. And only the clients with the key ``real-key`` are
 considered as authenticated. The client information is configured to be forwarded
 in the header ``x-client-id``.

 .. code-block:: yaml

    credentials:
    - key: real-key
      client: user
    key_sources:
     - header: "X-API-KEY"
    forwarding:
      header: "x-client-id"
      hide_credentials: false
Protobuf type envoy.extensions.filters.http.api_key_auth.v3.ApiKeyAuth

  • Method Details

    • 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.Builder<ApiKeyAuth.Builder>

    • clear

      public ApiKeyAuth.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<ApiKeyAuth.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<ApiKeyAuth.Builder>

    • getDefaultInstanceForType

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

    • build

      public ApiKeyAuth build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public ApiKeyAuth buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public ApiKeyAuth.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<ApiKeyAuth.Builder>

    • setField

      public ApiKeyAuth.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<ApiKeyAuth.Builder>

    • clearField

      public ApiKeyAuth.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<ApiKeyAuth.Builder>

    • clearOneof

      public ApiKeyAuth.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<ApiKeyAuth.Builder>

    • setRepeatedField

      public ApiKeyAuth.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ApiKeyAuth.Builder>

    • addRepeatedField

      public ApiKeyAuth.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<ApiKeyAuth.Builder>

    • mergeFrom

      public ApiKeyAuth.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ApiKeyAuth.Builder>

    • mergeFrom

      public ApiKeyAuth.Builder mergeFrom(ApiKeyAuth other)

    • isInitialized

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

    • mergeFrom

      public ApiKeyAuth.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<ApiKeyAuth.Builder>
      Throws:
      IOException

    • getCredentialsList

      public List<Credential> getCredentialsList()
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getCredentialsList in interface ApiKeyAuthOrBuilder

    • getCredentialsCount

      public int getCredentialsCount()
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getCredentialsCount in interface ApiKeyAuthOrBuilder

    • getCredentials

      public Credential getCredentials(int index)
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getCredentials in interface ApiKeyAuthOrBuilder

    • setCredentials

      public ApiKeyAuth.Builder setCredentials(int index, Credential value)
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • setCredentials

      public ApiKeyAuth.Builder setCredentials(int index, Credential.Builder builderForValue)
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • addCredentials

      public ApiKeyAuth.Builder addCredentials(Credential value)
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • addCredentials

      public ApiKeyAuth.Builder addCredentials(int index, Credential value)
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • addCredentials

      public ApiKeyAuth.Builder addCredentials(Credential.Builder builderForValue)
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • addCredentials

      public ApiKeyAuth.Builder addCredentials(int index, Credential.Builder builderForValue)
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • addAllCredentials

      public ApiKeyAuth.Builder addAllCredentials(Iterable<? extends Credential> values)
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • clearCredentials

      public ApiKeyAuth.Builder clearCredentials()
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • removeCredentials

      public ApiKeyAuth.Builder removeCredentials(int index)
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • getCredentialsBuilder

      public Credential.Builder getCredentialsBuilder(int index)
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • getCredentialsOrBuilder

      public CredentialOrBuilder getCredentialsOrBuilder(int index)
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getCredentialsOrBuilder in interface ApiKeyAuthOrBuilder

    • getCredentialsOrBuilderList

      public List<? extends CredentialOrBuilder> getCredentialsOrBuilderList()
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];
      Specified by:
      getCredentialsOrBuilderList in interface ApiKeyAuthOrBuilder

    • addCredentialsBuilder

      public Credential.Builder addCredentialsBuilder()
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • addCredentialsBuilder

      public Credential.Builder addCredentialsBuilder(int index)
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • getCredentialsBuilderList

      public List<Credential.Builder> getCredentialsBuilderList()
       The credentials that are used to authenticate the clients.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.Credential credentials = 1 [(.udpa.annotations.sensitive) = true];

    • getKeySourcesList

      public List<KeySource> getKeySourcesList()
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;
      Specified by:
      getKeySourcesList in interface ApiKeyAuthOrBuilder

    • getKeySourcesCount

      public int getKeySourcesCount()
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;
      Specified by:
      getKeySourcesCount in interface ApiKeyAuthOrBuilder

    • getKeySources

      public KeySource getKeySources(int index)
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;
      Specified by:
      getKeySources in interface ApiKeyAuthOrBuilder

    • setKeySources

      public ApiKeyAuth.Builder setKeySources(int index, KeySource value)
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • setKeySources

      public ApiKeyAuth.Builder setKeySources(int index, KeySource.Builder builderForValue)
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • addKeySources

      public ApiKeyAuth.Builder addKeySources(KeySource value)
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • addKeySources

      public ApiKeyAuth.Builder addKeySources(int index, KeySource value)
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • addKeySources

      public ApiKeyAuth.Builder addKeySources(KeySource.Builder builderForValue)
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • addKeySources

      public ApiKeyAuth.Builder addKeySources(int index, KeySource.Builder builderForValue)
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • addAllKeySources

      public ApiKeyAuth.Builder addAllKeySources(Iterable<? extends KeySource> values)
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • clearKeySources

      public ApiKeyAuth.Builder clearKeySources()
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • removeKeySources

      public ApiKeyAuth.Builder removeKeySources(int index)
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • getKeySourcesBuilder

      public KeySource.Builder getKeySourcesBuilder(int index)
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • getKeySourcesOrBuilder

      public KeySourceOrBuilder getKeySourcesOrBuilder(int index)
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;
      Specified by:
      getKeySourcesOrBuilder in interface ApiKeyAuthOrBuilder

    • getKeySourcesOrBuilderList

      public List<? extends KeySourceOrBuilder> getKeySourcesOrBuilderList()
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;
      Specified by:
      getKeySourcesOrBuilderList in interface ApiKeyAuthOrBuilder

    • addKeySourcesBuilder

      public KeySource.Builder addKeySourcesBuilder()
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • addKeySourcesBuilder

      public KeySource.Builder addKeySourcesBuilder(int index)
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • getKeySourcesBuilderList

      public List<KeySource.Builder> getKeySourcesBuilderList()
       The key sources to fetch the key from the coming request.
      repeated .envoy.extensions.filters.http.api_key_auth.v3.KeySource key_sources = 2;

    • hasForwarding

      public boolean hasForwarding()
       Optional configuration to control what information should be propagated to upstream services.
      .envoy.extensions.filters.http.api_key_auth.v3.Forwarding forwarding = 3;
      Specified by:
      hasForwarding in interface ApiKeyAuthOrBuilder
      Returns:
      Whether the forwarding field is set.

    • getForwarding

      public Forwarding getForwarding()
       Optional configuration to control what information should be propagated to upstream services.
      .envoy.extensions.filters.http.api_key_auth.v3.Forwarding forwarding = 3;
      Specified by:
      getForwarding in interface ApiKeyAuthOrBuilder
      Returns:
      The forwarding.

    • setForwarding

      public ApiKeyAuth.Builder setForwarding(Forwarding value)
       Optional configuration to control what information should be propagated to upstream services.
      .envoy.extensions.filters.http.api_key_auth.v3.Forwarding forwarding = 3;

    • setForwarding

      public ApiKeyAuth.Builder setForwarding(Forwarding.Builder builderForValue)
       Optional configuration to control what information should be propagated to upstream services.
      .envoy.extensions.filters.http.api_key_auth.v3.Forwarding forwarding = 3;

    • mergeForwarding

      public ApiKeyAuth.Builder mergeForwarding(Forwarding value)
       Optional configuration to control what information should be propagated to upstream services.
      .envoy.extensions.filters.http.api_key_auth.v3.Forwarding forwarding = 3;

    • clearForwarding

      public ApiKeyAuth.Builder clearForwarding()
       Optional configuration to control what information should be propagated to upstream services.
      .envoy.extensions.filters.http.api_key_auth.v3.Forwarding forwarding = 3;

    • getForwardingBuilder

      public Forwarding.Builder getForwardingBuilder()
       Optional configuration to control what information should be propagated to upstream services.
      .envoy.extensions.filters.http.api_key_auth.v3.Forwarding forwarding = 3;

    • getForwardingOrBuilder

      public ForwardingOrBuilder getForwardingOrBuilder()
       Optional configuration to control what information should be propagated to upstream services.
      .envoy.extensions.filters.http.api_key_auth.v3.Forwarding forwarding = 3;
      Specified by:
      getForwardingOrBuilder in interface ApiKeyAuthOrBuilder

    • setUnknownFields

      public final ApiKeyAuth.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ApiKeyAuth.Builder>

    • mergeUnknownFields

      public final ApiKeyAuth.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<ApiKeyAuth.Builder>