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

Class JwtAuthentication.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, JwtAuthenticationOrBuilder, Cloneable
    Enclosing class:
    JwtAuthentication
    public static final class JwtAuthentication.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>
implements JwtAuthenticationOrBuilder
     This is the Envoy HTTP filter config for JWT authentication.
 For example:
 .. code-block:: yaml
   providers:
      provider1:
        issuer: issuer1
        audiences:
        - audience1
        - audience2
        remote_jwks:
          http_uri:
            uri: https://example.com/.well-known/jwks.json
            cluster: example_jwks_cluster
            timeout: 1s
      provider2:
        issuer: issuer2
        local_jwks:
          inline_string: jwks_string
   rules:
      # Not jwt verification is required for /health path
      - match:
          prefix: /health
      # Jwt verification for provider1 is required for path prefixed with "prefix"
      - match:
          prefix: /prefix
        requires:
          provider_name: provider1
      # Jwt verification for either provider1 or provider2 is required for all other requests.
      - match:
          prefix: /
        requires:
          requires_any:
            requirements:
              - provider_name: provider1
              - provider_name: provider2
 [#next-free-field: 6]
    Protobuf type envoy.extensions.filters.http.jwt_authn.v3.JwtAuthentication

    • Method Detail

      • getDescriptor

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

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<JwtAuthentication.Builder>

      • clear

        public JwtAuthentication.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<JwtAuthentication.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<JwtAuthentication.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public JwtAuthentication.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<JwtAuthentication.Builder>

      • setField

        public JwtAuthentication.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<JwtAuthentication.Builder>

      • clearField

        public JwtAuthentication.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<JwtAuthentication.Builder>

      • clearOneof

        public JwtAuthentication.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<JwtAuthentication.Builder>

      • setRepeatedField

        public JwtAuthentication.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<JwtAuthentication.Builder>

      • addRepeatedField

        public JwtAuthentication.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<JwtAuthentication.Builder>

      • mergeFrom

        public JwtAuthentication.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<JwtAuthentication.Builder>

      • isInitialized

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

      • mergeFrom

        public JwtAuthentication.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<JwtAuthentication.Builder>
        Throws:
        IOException

      • getProvidersCount

        public int getProvidersCount()
        Description copied from interface: JwtAuthenticationOrBuilder
         Map of provider names to JwtProviders.
 .. code-block:: yaml
   providers:
     provider1:
        issuer: issuer1
        audiences:
        - audience1
        - audience2
        remote_jwks:
          http_uri:
            uri: https://example.com/.well-known/jwks.json
            cluster: example_jwks_cluster
            timeout: 1s
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtProvider> providers = 1;
        Specified by:
        getProvidersCount in interface JwtAuthenticationOrBuilder

      • containsProviders

        public boolean containsProviders​(String key)
         Map of provider names to JwtProviders.
 .. code-block:: yaml
   providers:
     provider1:
        issuer: issuer1
        audiences:
        - audience1
        - audience2
        remote_jwks:
          http_uri:
            uri: https://example.com/.well-known/jwks.json
            cluster: example_jwks_cluster
            timeout: 1s
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtProvider> providers = 1;
        Specified by:
        containsProviders in interface JwtAuthenticationOrBuilder

      • getProvidersMap

        public Map<String,​JwtProvider> getProvidersMap()
         Map of provider names to JwtProviders.
 .. code-block:: yaml
   providers:
     provider1:
        issuer: issuer1
        audiences:
        - audience1
        - audience2
        remote_jwks:
          http_uri:
            uri: https://example.com/.well-known/jwks.json
            cluster: example_jwks_cluster
            timeout: 1s
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtProvider> providers = 1;
        Specified by:
        getProvidersMap in interface JwtAuthenticationOrBuilder

      • getProvidersOrDefault

        public JwtProvider getProvidersOrDefault​(String key,
                                         JwtProvider defaultValue)
         Map of provider names to JwtProviders.
 .. code-block:: yaml
   providers:
     provider1:
        issuer: issuer1
        audiences:
        - audience1
        - audience2
        remote_jwks:
          http_uri:
            uri: https://example.com/.well-known/jwks.json
            cluster: example_jwks_cluster
            timeout: 1s
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtProvider> providers = 1;
        Specified by:
        getProvidersOrDefault in interface JwtAuthenticationOrBuilder

      • getProvidersOrThrow

        public JwtProvider getProvidersOrThrow​(String key)
         Map of provider names to JwtProviders.
 .. code-block:: yaml
   providers:
     provider1:
        issuer: issuer1
        audiences:
        - audience1
        - audience2
        remote_jwks:
          http_uri:
            uri: https://example.com/.well-known/jwks.json
            cluster: example_jwks_cluster
            timeout: 1s
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtProvider> providers = 1;
        Specified by:
        getProvidersOrThrow in interface JwtAuthenticationOrBuilder

      • removeProviders

        public JwtAuthentication.Builder removeProviders​(String key)
         Map of provider names to JwtProviders.
 .. code-block:: yaml
   providers:
     provider1:
        issuer: issuer1
        audiences:
        - audience1
        - audience2
        remote_jwks:
          http_uri:
            uri: https://example.com/.well-known/jwks.json
            cluster: example_jwks_cluster
            timeout: 1s
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtProvider> providers = 1;

      • putProviders

        public JwtAuthentication.Builder putProviders​(String key,
                                              JwtProvider value)
         Map of provider names to JwtProviders.
 .. code-block:: yaml
   providers:
     provider1:
        issuer: issuer1
        audiences:
        - audience1
        - audience2
        remote_jwks:
          http_uri:
            uri: https://example.com/.well-known/jwks.json
            cluster: example_jwks_cluster
            timeout: 1s
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtProvider> providers = 1;

      • putAllProviders

        public JwtAuthentication.Builder putAllProviders​(Map<String,​JwtProvider> values)
         Map of provider names to JwtProviders.
 .. code-block:: yaml
   providers:
     provider1:
        issuer: issuer1
        audiences:
        - audience1
        - audience2
        remote_jwks:
          http_uri:
            uri: https://example.com/.well-known/jwks.json
            cluster: example_jwks_cluster
            timeout: 1s
      provider2:
        issuer: provider2
        local_jwks:
          inline_string: jwks_string
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtProvider> providers = 1;

      • getRulesList

        public List<RequirementRule> getRulesList()
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;
        Specified by:
        getRulesList in interface JwtAuthenticationOrBuilder

      • getRulesCount

        public int getRulesCount()
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;
        Specified by:
        getRulesCount in interface JwtAuthenticationOrBuilder

      • getRules

        public RequirementRule getRules​(int index)
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;
        Specified by:
        getRules in interface JwtAuthenticationOrBuilder

      • setRules

        public JwtAuthentication.Builder setRules​(int index,
                                          RequirementRule value)
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • setRules

        public JwtAuthentication.Builder setRules​(int index,
                                          RequirementRule.Builder builderForValue)
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • addRules

        public JwtAuthentication.Builder addRules​(RequirementRule value)
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • addRules

        public JwtAuthentication.Builder addRules​(int index,
                                          RequirementRule value)
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • addRules

        public JwtAuthentication.Builder addRules​(RequirementRule.Builder builderForValue)
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • addRules

        public JwtAuthentication.Builder addRules​(int index,
                                          RequirementRule.Builder builderForValue)
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • addAllRules

        public JwtAuthentication.Builder addAllRules​(Iterable<? extends RequirementRule> values)
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • clearRules

        public JwtAuthentication.Builder clearRules()
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • removeRules

        public JwtAuthentication.Builder removeRules​(int index)
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • getRulesBuilder

        public RequirementRule.Builder getRulesBuilder​(int index)
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • getRulesOrBuilder

        public RequirementRuleOrBuilder getRulesOrBuilder​(int index)
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;
        Specified by:
        getRulesOrBuilder in interface JwtAuthenticationOrBuilder

      • getRulesOrBuilderList

        public List<? extends RequirementRuleOrBuilder> getRulesOrBuilderList()
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;
        Specified by:
        getRulesOrBuilderList in interface JwtAuthenticationOrBuilder

      • addRulesBuilder

        public RequirementRule.Builder addRulesBuilder()
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • addRulesBuilder

        public RequirementRule.Builder addRulesBuilder​(int index)
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • getRulesBuilderList

        public List<RequirementRule.Builder> getRulesBuilderList()
         Specifies requirements based on the route matches. The first matched requirement will be
 applied. If there are overlapped match conditions, please put the most specific match first.
 Examples
 .. code-block:: yaml
   rules:
     - match:
         prefix: /healthz
     - match:
         prefix: /baz
       requires:
         provider_name: provider1
     - match:
         prefix: /foo
       requires:
         requires_any:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
     - match:
         prefix: /bar
       requires:
         requires_all:
           requirements:
             - provider_name: provider1
             - provider_name: provider2
        repeated .envoy.extensions.filters.http.jwt_authn.v3.RequirementRule rules = 2;

      • hasFilterStateRules

        public boolean hasFilterStateRules()
         This message specifies Jwt requirements based on stream_info.filterState.
 Other HTTP filters can use it to specify Jwt requirements dynamically.
 The ``rules`` field above is checked first, if it could not find any matches,
 check this one.
        .envoy.extensions.filters.http.jwt_authn.v3.FilterStateRule filter_state_rules = 3;
        Specified by:
        hasFilterStateRules in interface JwtAuthenticationOrBuilder
        Returns:
        Whether the filterStateRules field is set.

      • getFilterStateRules

        public FilterStateRule getFilterStateRules()
         This message specifies Jwt requirements based on stream_info.filterState.
 Other HTTP filters can use it to specify Jwt requirements dynamically.
 The ``rules`` field above is checked first, if it could not find any matches,
 check this one.
        .envoy.extensions.filters.http.jwt_authn.v3.FilterStateRule filter_state_rules = 3;
        Specified by:
        getFilterStateRules in interface JwtAuthenticationOrBuilder
        Returns:
        The filterStateRules.

      • setFilterStateRules

        public JwtAuthentication.Builder setFilterStateRules​(FilterStateRule value)
         This message specifies Jwt requirements based on stream_info.filterState.
 Other HTTP filters can use it to specify Jwt requirements dynamically.
 The ``rules`` field above is checked first, if it could not find any matches,
 check this one.
        .envoy.extensions.filters.http.jwt_authn.v3.FilterStateRule filter_state_rules = 3;

      • setFilterStateRules

        public JwtAuthentication.Builder setFilterStateRules​(FilterStateRule.Builder builderForValue)
         This message specifies Jwt requirements based on stream_info.filterState.
 Other HTTP filters can use it to specify Jwt requirements dynamically.
 The ``rules`` field above is checked first, if it could not find any matches,
 check this one.
        .envoy.extensions.filters.http.jwt_authn.v3.FilterStateRule filter_state_rules = 3;

      • mergeFilterStateRules

        public JwtAuthentication.Builder mergeFilterStateRules​(FilterStateRule value)
         This message specifies Jwt requirements based on stream_info.filterState.
 Other HTTP filters can use it to specify Jwt requirements dynamically.
 The ``rules`` field above is checked first, if it could not find any matches,
 check this one.
        .envoy.extensions.filters.http.jwt_authn.v3.FilterStateRule filter_state_rules = 3;

      • clearFilterStateRules

        public JwtAuthentication.Builder clearFilterStateRules()
         This message specifies Jwt requirements based on stream_info.filterState.
 Other HTTP filters can use it to specify Jwt requirements dynamically.
 The ``rules`` field above is checked first, if it could not find any matches,
 check this one.
        .envoy.extensions.filters.http.jwt_authn.v3.FilterStateRule filter_state_rules = 3;

      • getFilterStateRulesBuilder

        public FilterStateRule.Builder getFilterStateRulesBuilder()
         This message specifies Jwt requirements based on stream_info.filterState.
 Other HTTP filters can use it to specify Jwt requirements dynamically.
 The ``rules`` field above is checked first, if it could not find any matches,
 check this one.
        .envoy.extensions.filters.http.jwt_authn.v3.FilterStateRule filter_state_rules = 3;

      • getFilterStateRulesOrBuilder

        public FilterStateRuleOrBuilder getFilterStateRulesOrBuilder()
         This message specifies Jwt requirements based on stream_info.filterState.
 Other HTTP filters can use it to specify Jwt requirements dynamically.
 The ``rules`` field above is checked first, if it could not find any matches,
 check this one.
        .envoy.extensions.filters.http.jwt_authn.v3.FilterStateRule filter_state_rules = 3;
        Specified by:
        getFilterStateRulesOrBuilder in interface JwtAuthenticationOrBuilder

      • getBypassCorsPreflight

        public boolean getBypassCorsPreflight()
         When set to true, bypass the `CORS preflight request
 <http://www.w3.org/TR/cors/#cross-origin-request-with-preflight>`_ regardless of JWT
 requirements specified in the rules.
        bool bypass_cors_preflight = 4;
        Specified by:
        getBypassCorsPreflight in interface JwtAuthenticationOrBuilder
        Returns:
        The bypassCorsPreflight.

      • setBypassCorsPreflight

        public JwtAuthentication.Builder setBypassCorsPreflight​(boolean value)
         When set to true, bypass the `CORS preflight request
 <http://www.w3.org/TR/cors/#cross-origin-request-with-preflight>`_ regardless of JWT
 requirements specified in the rules.
        bool bypass_cors_preflight = 4;
        Parameters:
        value - The bypassCorsPreflight to set.
        Returns:
        This builder for chaining.

      • clearBypassCorsPreflight

        public JwtAuthentication.Builder clearBypassCorsPreflight()
         When set to true, bypass the `CORS preflight request
 <http://www.w3.org/TR/cors/#cross-origin-request-with-preflight>`_ regardless of JWT
 requirements specified in the rules.
        bool bypass_cors_preflight = 4;
        Returns:
        This builder for chaining.

      • getRequirementMapCount

        public int getRequirementMapCount()
        Description copied from interface: JwtAuthenticationOrBuilder
         A map of unique requirement_names to JwtRequirements.
 :ref:`requirement_name <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.PerRouteConfig.requirement_name>`
 in ``PerRouteConfig`` uses this map to specify a JwtRequirement.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requirement_map = 5;
        Specified by:
        getRequirementMapCount in interface JwtAuthenticationOrBuilder

      • containsRequirementMap

        public boolean containsRequirementMap​(String key)
         A map of unique requirement_names to JwtRequirements.
 :ref:`requirement_name <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.PerRouteConfig.requirement_name>`
 in ``PerRouteConfig`` uses this map to specify a JwtRequirement.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requirement_map = 5;
        Specified by:
        containsRequirementMap in interface JwtAuthenticationOrBuilder

      • getRequirementMapMap

        public Map<String,​JwtRequirement> getRequirementMapMap()
         A map of unique requirement_names to JwtRequirements.
 :ref:`requirement_name <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.PerRouteConfig.requirement_name>`
 in ``PerRouteConfig`` uses this map to specify a JwtRequirement.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requirement_map = 5;
        Specified by:
        getRequirementMapMap in interface JwtAuthenticationOrBuilder

      • getRequirementMapOrDefault

        public JwtRequirement getRequirementMapOrDefault​(String key,
                                                 JwtRequirement defaultValue)
         A map of unique requirement_names to JwtRequirements.
 :ref:`requirement_name <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.PerRouteConfig.requirement_name>`
 in ``PerRouteConfig`` uses this map to specify a JwtRequirement.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requirement_map = 5;
        Specified by:
        getRequirementMapOrDefault in interface JwtAuthenticationOrBuilder

      • getRequirementMapOrThrow

        public JwtRequirement getRequirementMapOrThrow​(String key)
         A map of unique requirement_names to JwtRequirements.
 :ref:`requirement_name <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.PerRouteConfig.requirement_name>`
 in ``PerRouteConfig`` uses this map to specify a JwtRequirement.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requirement_map = 5;
        Specified by:
        getRequirementMapOrThrow in interface JwtAuthenticationOrBuilder

      • removeRequirementMap

        public JwtAuthentication.Builder removeRequirementMap​(String key)
         A map of unique requirement_names to JwtRequirements.
 :ref:`requirement_name <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.PerRouteConfig.requirement_name>`
 in ``PerRouteConfig`` uses this map to specify a JwtRequirement.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requirement_map = 5;

      • putRequirementMap

        public JwtAuthentication.Builder putRequirementMap​(String key,
                                                   JwtRequirement value)
         A map of unique requirement_names to JwtRequirements.
 :ref:`requirement_name <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.PerRouteConfig.requirement_name>`
 in ``PerRouteConfig`` uses this map to specify a JwtRequirement.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requirement_map = 5;

      • putAllRequirementMap

        public JwtAuthentication.Builder putAllRequirementMap​(Map<String,​JwtRequirement> values)
         A map of unique requirement_names to JwtRequirements.
 :ref:`requirement_name <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.PerRouteConfig.requirement_name>`
 in ``PerRouteConfig`` uses this map to specify a JwtRequirement.
        map<string, .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement> requirement_map = 5;

      • setUnknownFields

        public final JwtAuthentication.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<JwtAuthentication.Builder>

      • mergeUnknownFields

        public final JwtAuthentication.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<JwtAuthentication.Builder>