Package io.envoyproxy.envoy.config.filter.network.rbac.v2

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
    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
    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 Details

    • hasRules

      boolean hasRules()
       Specify the RBAC rules to be applied globally.
 If absent, no enforcing RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC rules = 1;
      Returns:
      Whether the rules field is set.

    • getRules

      RBAC getRules()
       Specify the RBAC rules to be applied globally.
 If absent, no enforcing RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC rules = 1;
      Returns:
      The rules.

    • getRulesOrBuilder

      RBACOrBuilder getRulesOrBuilder()
       Specify the RBAC rules to be applied globally.
 If absent, no enforcing RBAC policy will be applied.
      .envoy.config.rbac.v2.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.v2.RBAC shadow_rules = 2;
      Returns:
      Whether the shadowRules field is set.

    • 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.v2.RBAC shadow_rules = 2;
      Returns:
      The shadowRules.

    • 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.v2.RBAC shadow_rules = 2;

    • getStatPrefix

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

    • getStatPrefixBytes

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

    • 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.config.filter.network.rbac.v2.RBAC.EnforcementType enforcement_type = 4;
      Returns:
      The enum numeric value on the wire for enforcementType.

    • 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.config.filter.network.rbac.v2.RBAC.EnforcementType enforcement_type = 4;
      Returns:
      The enforcementType.