Package io.envoyproxy.envoy.extensions.filters.network.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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      RBAC.EnforcementType getEnforcementType()
      RBAC enforcement strategy.
      int getEnforcementTypeValue()
      RBAC enforcement strategy.
      RBAC getRules()
      Specify the RBAC rules to be applied globally.
      RBACOrBuilder getRulesOrBuilder()
      Specify the RBAC rules to be applied globally.
      RBAC getShadowRules()
      Shadow rules are not enforced by the filter but will emit stats and logs and can be used for rule testing.
      RBACOrBuilder getShadowRulesOrBuilder()
      Shadow rules are not enforced by the filter but will emit stats and logs and can be used for rule testing.
      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.
      String getStatPrefix()
      The prefix to use when emitting statistics.
      com.google.protobuf.ByteString getStatPrefixBytes()
      The prefix to use when emitting statistics.
      boolean hasRules()
      Specify the RBAC rules to be applied globally.
      boolean hasShadowRules()
      Shadow rules are not enforced by the filter but will emit stats and logs and can be used for rule testing.

      • 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 Detail

      • hasRules

        boolean hasRules()
         Specify the RBAC rules to be applied globally.
 If absent, no enforcing RBAC policy will be applied.
 If present and empty, DENY.
        .envoy.config.rbac.v3.RBAC rules = 1;

      • getRules

        RBAC getRules()
         Specify the RBAC rules to be applied globally.
 If absent, no enforcing RBAC policy will be applied.
 If present and empty, DENY.
        .envoy.config.rbac.v3.RBAC rules = 1;

      • getRulesOrBuilder

        RBACOrBuilder getRulesOrBuilder()
         Specify the RBAC rules to be applied globally.
 If absent, no enforcing RBAC policy will be applied.
 If present and empty, DENY.
        .envoy.config.rbac.v3.RBAC rules = 1;

      • hasShadowRules

        boolean hasShadowRules()
         Shadow rules are not enforced by the filter but will emit stats and logs
 and can be used for rule testing.
 If absent, no shadow RBAC policy will be applied.
        .envoy.config.rbac.v3.RBAC shadow_rules = 2;

      • getShadowRules

        RBAC getShadowRules()
         Shadow rules are not enforced by the filter but will emit stats and logs
 and can be used for rule testing.
 If absent, no shadow RBAC policy will be applied.
        .envoy.config.rbac.v3.RBAC shadow_rules = 2;

      • getShadowRulesOrBuilder

        RBACOrBuilder getShadowRulesOrBuilder()
         Shadow rules are not enforced by the filter but will emit stats and logs
 and can be used for rule testing.
 If absent, no shadow RBAC policy will be applied.
        .envoy.config.rbac.v3.RBAC shadow_rules = 2;

      • getShadowRulesStatPrefix

        String getShadowRulesStatPrefix()
         If specified, shadow rules will emit stats with the given prefix.
 This is useful to distinguish the stat when there are more than 1 RBAC filter configured with
 shadow rules.
        string shadow_rules_stat_prefix = 5;

      • getShadowRulesStatPrefixBytes

        com.google.protobuf.ByteString getShadowRulesStatPrefixBytes()
         If specified, shadow rules will emit stats with the given prefix.
 This is useful to distinguish the stat when there are more than 1 RBAC filter configured with
 shadow rules.
        string shadow_rules_stat_prefix = 5;

      • getStatPrefix

        String getStatPrefix()
         The prefix to use when emitting statistics.
        string stat_prefix = 3 [(.validate.rules) = { ... }

      • getStatPrefixBytes

        com.google.protobuf.ByteString getStatPrefixBytes()
         The prefix to use when emitting statistics.
        string stat_prefix = 3 [(.validate.rules) = { ... }

      • getEnforcementTypeValue

        int getEnforcementTypeValue()
         RBAC enforcement strategy. By default RBAC will be enforced only once
 when the first byte of data arrives from the downstream. When used in
 conjunction with filters that emit dynamic metadata after decoding
 every payload (e.g., Mongo, MySQL, Kafka) set the enforcement type to
 CONTINUOUS to enforce RBAC policies on every message boundary.
        .envoy.extensions.filters.network.rbac.v3.RBAC.EnforcementType enforcement_type = 4;

      • getEnforcementType

        RBAC.EnforcementType getEnforcementType()
         RBAC enforcement strategy. By default RBAC will be enforced only once
 when the first byte of data arrives from the downstream. When used in
 conjunction with filters that emit dynamic metadata after decoding
 every payload (e.g., Mongo, MySQL, Kafka) set the enforcement type to
 CONTINUOUS to enforce RBAC policies on every message boundary.
        .envoy.extensions.filters.network.rbac.v3.RBAC.EnforcementType enforcement_type = 4;