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

Interface RBACOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Matcher
    getMatcher()
    Match tree for evaluating RBAC actions on incoming requests.
    MatcherOrBuilder
    getMatcherOrBuilder()
    Match tree for evaluating RBAC actions on incoming requests.
    RBAC
    getRules()
    The primary RBAC policy which will be applied globally, to all the incoming requests
    RBACOrBuilder
    getRulesOrBuilder()
    The primary RBAC policy which will be applied globally, to all the incoming requests
    String
    getRulesStatPrefix()
    If specified, rules will emit stats with the given prefix.
    com.google.protobuf.ByteString
    getRulesStatPrefixBytes()
    If specified, rules will emit stats with the given prefix.
    Matcher
    getShadowMatcher()
    If absent, no shadow matcher will be applied.
    MatcherOrBuilder
    getShadowMatcherOrBuilder()
    If absent, no shadow matcher will be applied.
    RBAC
    getShadowRules()
    Shadow policy for testing RBAC rules without enforcing them.
    RBACOrBuilder
    getShadowRulesOrBuilder()
    Shadow policy for testing RBAC rules without enforcing them.
    String
    getShadowRulesStatPrefix()
    If specified, shadow rules will emit stats with the given prefix.
    com.google.protobuf.ByteString
    getShadowRulesStatPrefixBytes()
    If specified, shadow rules will emit stats with the given prefix.
    boolean
    getTrackPerRuleStats()
    If ``track_per_rule_stats`` is ``true``, counters will be published for each rule and shadow rule.
    boolean
    hasMatcher()
    Match tree for evaluating RBAC actions on incoming requests.
    boolean
    hasRules()
    The primary RBAC policy which will be applied globally, to all the incoming requests
    boolean
    hasShadowMatcher()
    If absent, no shadow matcher will be applied.
    boolean
    hasShadowRules()
    Shadow policy for testing RBAC rules without enforcing them.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasRules

      boolean hasRules()
       The primary RBAC policy which will be applied globally, to all the incoming requests.

 * If absent, no RBAC enforcement occurs.
 * If set but empty, all requests are denied.

 .. note::

   When both ``rules`` and ``matcher`` are configured, ``rules`` will be ignored.
      .envoy.config.rbac.v3.RBAC rules = 1 [(.udpa.annotations.field_migrate) = { ... }
      Returns:
      Whether the rules field is set.

    • getRules

      RBAC getRules()
       The primary RBAC policy which will be applied globally, to all the incoming requests.

 * If absent, no RBAC enforcement occurs.
 * If set but empty, all requests are denied.

 .. note::

   When both ``rules`` and ``matcher`` are configured, ``rules`` will be ignored.
      .envoy.config.rbac.v3.RBAC rules = 1 [(.udpa.annotations.field_migrate) = { ... }
      Returns:
      The rules.

    • getRulesOrBuilder

      RBACOrBuilder getRulesOrBuilder()
       The primary RBAC policy which will be applied globally, to all the incoming requests.

 * If absent, no RBAC enforcement occurs.
 * If set but empty, all requests are denied.

 .. note::

   When both ``rules`` and ``matcher`` are configured, ``rules`` will be ignored.
      .envoy.config.rbac.v3.RBAC rules = 1 [(.udpa.annotations.field_migrate) = { ... }

    • getRulesStatPrefix

      String getRulesStatPrefix()
       If specified, rules will emit stats with the given prefix.
 This is useful for distinguishing metrics when multiple RBAC filters are configured.
      string rules_stat_prefix = 6;
      Returns:
      The rulesStatPrefix.

    • getRulesStatPrefixBytes

      com.google.protobuf.ByteString getRulesStatPrefixBytes()
       If specified, rules will emit stats with the given prefix.
 This is useful for distinguishing metrics when multiple RBAC filters are configured.
      string rules_stat_prefix = 6;
      Returns:
      The bytes for rulesStatPrefix.

    • hasMatcher

      boolean hasMatcher()
       Match tree for evaluating RBAC actions on incoming requests. Requests not matching any matcher will be denied.

 * If absent, no RBAC enforcement occurs.
 * If set but empty, all requests are denied.
      .xds.type.matcher.v3.Matcher matcher = 4 [(.udpa.annotations.field_migrate) = { ... }
      Returns:
      Whether the matcher field is set.

    • getMatcher

      Matcher getMatcher()
       Match tree for evaluating RBAC actions on incoming requests. Requests not matching any matcher will be denied.

 * If absent, no RBAC enforcement occurs.
 * If set but empty, all requests are denied.
      .xds.type.matcher.v3.Matcher matcher = 4 [(.udpa.annotations.field_migrate) = { ... }
      Returns:
      The matcher.

    • getMatcherOrBuilder

      MatcherOrBuilder getMatcherOrBuilder()
       Match tree for evaluating RBAC actions on incoming requests. Requests not matching any matcher will be denied.

 * If absent, no RBAC enforcement occurs.
 * If set but empty, all requests are denied.
      .xds.type.matcher.v3.Matcher matcher = 4 [(.udpa.annotations.field_migrate) = { ... }

    • hasShadowRules

      boolean hasShadowRules()
       Shadow policy for testing RBAC rules without enforcing them. These rules generate stats and logs but do not deny
 requests. If absent, no shadow RBAC policy will be applied.

 .. note::

   When both ``shadow_rules`` and ``shadow_matcher`` are configured, ``shadow_rules`` will be ignored.
      .envoy.config.rbac.v3.RBAC shadow_rules = 2 [(.udpa.annotations.field_migrate) = { ... }
      Returns:
      Whether the shadowRules field is set.

    • getShadowRules

      RBAC getShadowRules()
       Shadow policy for testing RBAC rules without enforcing them. These rules generate stats and logs but do not deny
 requests. If absent, no shadow RBAC policy will be applied.

 .. note::

   When both ``shadow_rules`` and ``shadow_matcher`` are configured, ``shadow_rules`` will be ignored.
      .envoy.config.rbac.v3.RBAC shadow_rules = 2 [(.udpa.annotations.field_migrate) = { ... }
      Returns:
      The shadowRules.

    • getShadowRulesOrBuilder

      RBACOrBuilder getShadowRulesOrBuilder()
       Shadow policy for testing RBAC rules without enforcing them. These rules generate stats and logs but do not deny
 requests. If absent, no shadow RBAC policy will be applied.

 .. note::

   When both ``shadow_rules`` and ``shadow_matcher`` are configured, ``shadow_rules`` will be ignored.
      .envoy.config.rbac.v3.RBAC shadow_rules = 2 [(.udpa.annotations.field_migrate) = { ... }

    • hasShadowMatcher

      boolean hasShadowMatcher()
       If absent, no shadow matcher will be applied.
 Match tree for testing RBAC rules through stats and logs without enforcing them.
 If absent, no shadow matching occurs.
      .xds.type.matcher.v3.Matcher shadow_matcher = 5 [(.udpa.annotations.field_migrate) = { ... }
      Returns:
      Whether the shadowMatcher field is set.

    • getShadowMatcher

      Matcher getShadowMatcher()
       If absent, no shadow matcher will be applied.
 Match tree for testing RBAC rules through stats and logs without enforcing them.
 If absent, no shadow matching occurs.
      .xds.type.matcher.v3.Matcher shadow_matcher = 5 [(.udpa.annotations.field_migrate) = { ... }
      Returns:
      The shadowMatcher.

    • getShadowMatcherOrBuilder

      MatcherOrBuilder getShadowMatcherOrBuilder()
       If absent, no shadow matcher will be applied.
 Match tree for testing RBAC rules through stats and logs without enforcing them.
 If absent, no shadow matching occurs.
      .xds.type.matcher.v3.Matcher shadow_matcher = 5 [(.udpa.annotations.field_migrate) = { ... }

    • getShadowRulesStatPrefix

      String getShadowRulesStatPrefix()
       If specified, shadow rules will emit stats with the given prefix.
 This is useful for distinguishing metrics when multiple RBAC filters use shadow rules.
      string shadow_rules_stat_prefix = 3;
      Returns:
      The shadowRulesStatPrefix.

    • getShadowRulesStatPrefixBytes

      com.google.protobuf.ByteString getShadowRulesStatPrefixBytes()
       If specified, shadow rules will emit stats with the given prefix.
 This is useful for distinguishing metrics when multiple RBAC filters use shadow rules.
      string shadow_rules_stat_prefix = 3;
      Returns:
      The bytes for shadowRulesStatPrefix.

    • getTrackPerRuleStats

      boolean getTrackPerRuleStats()
       If ``track_per_rule_stats`` is ``true``, counters will be published for each rule and shadow rule.
      bool track_per_rule_stats = 7;
      Returns:
      The trackPerRuleStats.