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

Interface RequirementRuleOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    RequirementRule, RequirementRule.Builder
    public interface RequirementRuleOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • hasMatch

        boolean hasMatch()
         The route matching parameter. Only when the match is satisfied, the "requires" field will
 apply.
 For example: following match will match all requests.
 .. code-block:: yaml
    match:
      prefix: /
        .envoy.config.route.v3.RouteMatch match = 1 [(.validate.rules) = { ... }
        Returns:
        Whether the match field is set.

      • getMatch

        RouteMatch getMatch()
         The route matching parameter. Only when the match is satisfied, the "requires" field will
 apply.
 For example: following match will match all requests.
 .. code-block:: yaml
    match:
      prefix: /
        .envoy.config.route.v3.RouteMatch match = 1 [(.validate.rules) = { ... }
        Returns:
        The match.

      • getMatchOrBuilder

        RouteMatchOrBuilder getMatchOrBuilder()
         The route matching parameter. Only when the match is satisfied, the "requires" field will
 apply.
 For example: following match will match all requests.
 .. code-block:: yaml
    match:
      prefix: /
        .envoy.config.route.v3.RouteMatch match = 1 [(.validate.rules) = { ... }

      • hasRequires

        boolean hasRequires()
         Specify a Jwt requirement. Please see detail comment in message JwtRequirement.
        .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement requires = 2;
        Returns:
        Whether the requires field is set.

      • getRequires

        JwtRequirement getRequires()
         Specify a Jwt requirement. Please see detail comment in message JwtRequirement.
        .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement requires = 2;
        Returns:
        The requires.

      • getRequiresOrBuilder

        JwtRequirementOrBuilder getRequiresOrBuilder()
         Specify a Jwt requirement. Please see detail comment in message JwtRequirement.
        .envoy.extensions.filters.http.jwt_authn.v3.JwtRequirement requires = 2;

      • hasRequirementName

        boolean hasRequirementName()
         Use requirement_name to specify a Jwt requirement.
 This requirement_name MUST be specified at the
 :ref:`requirement_map <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtAuthentication.requirement_map>`
 in ``JwtAuthentication``.
        string requirement_name = 3 [(.validate.rules) = { ... }
        Returns:
        Whether the requirementName field is set.

      • getRequirementName

        String getRequirementName()
         Use requirement_name to specify a Jwt requirement.
 This requirement_name MUST be specified at the
 :ref:`requirement_map <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtAuthentication.requirement_map>`
 in ``JwtAuthentication``.
        string requirement_name = 3 [(.validate.rules) = { ... }
        Returns:
        The requirementName.

      • getRequirementNameBytes

        com.google.protobuf.ByteString getRequirementNameBytes()
         Use requirement_name to specify a Jwt requirement.
 This requirement_name MUST be specified at the
 :ref:`requirement_map <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtAuthentication.requirement_map>`
 in ``JwtAuthentication``.
        string requirement_name = 3 [(.validate.rules) = { ... }
        Returns:
        The bytes for requirementName.