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

Class RBAC

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.rbac.v3.RBAC
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RBACOrBuilder, Serializable
public final class RBAC extends com.google.protobuf.GeneratedMessageV3 implements RBACOrBuilder
 RBAC filter config.
 [#next-free-field: 8]
Protobuf type envoy.extensions.filters.http.rbac.v3.RBAC
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RBAC.Builder
    RBAC filter config.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    MATCHER_FIELD_NUMBER
     
    static final int
    RULES_FIELD_NUMBER
     
    static final int
    RULES_STAT_PREFIX_FIELD_NUMBER
     
    static final int
    SHADOW_MATCHER_FIELD_NUMBER
     
    static final int
    SHADOW_RULES_FIELD_NUMBER
     
    static final int
    SHADOW_RULES_STAT_PREFIX_FIELD_NUMBER
     
    static final int
    TRACK_PER_RULE_STATS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static RBAC
    getDefaultInstance()
     
    RBAC
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Matcher
    getMatcher()
    Match tree for evaluating RBAC actions on incoming requests.
    MatcherOrBuilder
    getMatcherOrBuilder()
    Match tree for evaluating RBAC actions on incoming requests.
    com.google.protobuf.Parser<RBAC>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    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.
    int
    hashCode()
     
    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.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static RBAC.Builder
    newBuilder()
     
    static RBAC.Builder
    newBuilder(RBAC prototype)
     
    RBAC.Builder
    newBuilderForType()
     
    protected RBAC.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static RBAC
    parseDelimitedFrom(InputStream input)
     
    static RBAC
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RBAC
    parseFrom(byte[] data)
     
    static RBAC
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RBAC
    parseFrom(com.google.protobuf.ByteString data)
     
    static RBAC
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RBAC
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RBAC
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RBAC
    parseFrom(InputStream input)
     
    static RBAC
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RBAC
    parseFrom(ByteBuffer data)
     
    static RBAC
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RBAC>
    parser()
     
    RBAC.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • RULES_FIELD_NUMBER

      public static final int RULES_FIELD_NUMBER
      See Also:

    • RULES_STAT_PREFIX_FIELD_NUMBER

      public static final int RULES_STAT_PREFIX_FIELD_NUMBER
      See Also:

    • MATCHER_FIELD_NUMBER

      public static final int MATCHER_FIELD_NUMBER
      See Also:

    • SHADOW_RULES_FIELD_NUMBER

      public static final int SHADOW_RULES_FIELD_NUMBER
      See Also:

    • SHADOW_MATCHER_FIELD_NUMBER

      public static final int SHADOW_MATCHER_FIELD_NUMBER
      See Also:

    • SHADOW_RULES_STAT_PREFIX_FIELD_NUMBER

      public static final int SHADOW_RULES_STAT_PREFIX_FIELD_NUMBER
      See Also:

    • TRACK_PER_RULE_STATS_FIELD_NUMBER

      public static final int TRACK_PER_RULE_STATS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasRules

      public 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) = { ... }
      Specified by:
      hasRules in interface RBACOrBuilder
      Returns:
      Whether the rules field is set.

    • getRules

      public 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) = { ... }
      Specified by:
      getRules in interface RBACOrBuilder
      Returns:
      The rules.

    • getRulesOrBuilder

      public 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) = { ... }
      Specified by:
      getRulesOrBuilder in interface RBACOrBuilder

    • getRulesStatPrefix

      public 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;
      Specified by:
      getRulesStatPrefix in interface RBACOrBuilder
      Returns:
      The rulesStatPrefix.

    • getRulesStatPrefixBytes

      public 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;
      Specified by:
      getRulesStatPrefixBytes in interface RBACOrBuilder
      Returns:
      The bytes for rulesStatPrefix.

    • hasMatcher

      public 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) = { ... }
      Specified by:
      hasMatcher in interface RBACOrBuilder
      Returns:
      Whether the matcher field is set.

    • getMatcher

      public 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) = { ... }
      Specified by:
      getMatcher in interface RBACOrBuilder
      Returns:
      The matcher.

    • getMatcherOrBuilder

      public 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) = { ... }
      Specified by:
      getMatcherOrBuilder in interface RBACOrBuilder

    • hasShadowRules

      public 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) = { ... }
      Specified by:
      hasShadowRules in interface RBACOrBuilder
      Returns:
      Whether the shadowRules field is set.

    • getShadowRules

      public 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) = { ... }
      Specified by:
      getShadowRules in interface RBACOrBuilder
      Returns:
      The shadowRules.

    • getShadowRulesOrBuilder

      public 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) = { ... }
      Specified by:
      getShadowRulesOrBuilder in interface RBACOrBuilder

    • hasShadowMatcher

      public 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) = { ... }
      Specified by:
      hasShadowMatcher in interface RBACOrBuilder
      Returns:
      Whether the shadowMatcher field is set.

    • getShadowMatcher

      public 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) = { ... }
      Specified by:
      getShadowMatcher in interface RBACOrBuilder
      Returns:
      The shadowMatcher.

    • getShadowMatcherOrBuilder

      public 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) = { ... }
      Specified by:
      getShadowMatcherOrBuilder in interface RBACOrBuilder

    • getShadowRulesStatPrefix

      public 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;
      Specified by:
      getShadowRulesStatPrefix in interface RBACOrBuilder
      Returns:
      The shadowRulesStatPrefix.

    • getShadowRulesStatPrefixBytes

      public 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;
      Specified by:
      getShadowRulesStatPrefixBytes in interface RBACOrBuilder
      Returns:
      The bytes for shadowRulesStatPrefix.

    • getTrackPerRuleStats

      public 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;
      Specified by:
      getTrackPerRuleStats in interface RBACOrBuilder
      Returns:
      The trackPerRuleStats.

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RBAC parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RBAC parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RBAC parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RBAC parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RBAC parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RBAC parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RBAC parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RBAC parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RBAC parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RBAC parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RBAC parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RBAC parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RBAC.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RBAC.Builder newBuilder()

    • newBuilder

      public static RBAC.Builder newBuilder(RBAC prototype)

    • toBuilder

      public RBAC.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RBAC.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static RBAC getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RBAC> parser()

    • getParserForType

      public com.google.protobuf.Parser<RBAC> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

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