Class RBAC
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
@Generated
public final class RBAC
extends com.google.protobuf.GeneratedMessage
implements RBACOrBuilder
RBAC filter config. [#next-free-field: 8]Protobuf type
envoy.extensions.filters.http.rbac.v3.RBAC- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate intprivate static final RBACprivate Matcherstatic final intprivate byteprivate static final com.google.protobuf.Parser<RBAC> private RBACstatic final intstatic final intprivate Objectprivate static final longstatic final intstatic final intstatic final intprivate Matcherprivate RBACprivate Objectstatic final intprivate booleanFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanstatic RBACstatic final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.DescriptorThe match tree to use when resolving RBAC action for incoming requests.The match tree to use when resolving RBAC action for incoming requests.com.google.protobuf.Parser<RBAC> getRules()Specify the RBAC rules to be applied globally.Specify the RBAC rules to be applied globally.If specified, rules will emit stats with the given prefix.com.google.protobuf.ByteStringIf specified, rules will emit stats with the given prefix.intThe match tree to use for emitting stats and logs which can be used for rule testing for incoming requests.The match tree to use for emitting stats and logs which can be used for rule testing for incoming requests.Shadow rules are not enforced by the filter (i.e., returning a 403) but will emit stats and logs and can be used for rule testing.Shadow rules are not enforced by the filter (i.e., returning a 403) but will emit stats and logs and can be used for rule testing.If specified, shadow rules will emit stats with the given prefix.com.google.protobuf.ByteStringIf specified, shadow rules will emit stats with the given prefix.booleanIf track_per_rule_stats is true, counters will be published for each rule and shadow rule.inthashCode()booleanThe match tree to use when resolving RBAC action for incoming requests.booleanhasRules()Specify the RBAC rules to be applied globally.booleanThe match tree to use for emitting stats and logs which can be used for rule testing for incoming requests.booleanShadow rules are not enforced by the filter (i.e., returning a 403) but will emit stats and logs and can be used for rule testing.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic RBAC.Builderstatic RBAC.BuildernewBuilder(RBAC prototype) protected RBAC.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static RBACparseDelimitedFrom(InputStream input) static RBACparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RBACparseFrom(byte[] data) static RBACparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RBACparseFrom(com.google.protobuf.ByteString data) static RBACparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RBACparseFrom(com.google.protobuf.CodedInputStream input) static RBACparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RBACparseFrom(InputStream input) static RBACparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static RBACparseFrom(ByteBuffer data) static RBACparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<RBAC> parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
bitField0_
private int bitField0_ -
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER- See Also:
-
rules_
-
RULES_STAT_PREFIX_FIELD_NUMBER
public static final int RULES_STAT_PREFIX_FIELD_NUMBER- See Also:
-
rulesStatPrefix_
-
MATCHER_FIELD_NUMBER
public static final int MATCHER_FIELD_NUMBER- See Also:
-
matcher_
-
SHADOW_RULES_FIELD_NUMBER
public static final int SHADOW_RULES_FIELD_NUMBER- See Also:
-
shadowRules_
-
SHADOW_MATCHER_FIELD_NUMBER
public static final int SHADOW_MATCHER_FIELD_NUMBER- See Also:
-
shadowMatcher_
-
SHADOW_RULES_STAT_PREFIX_FIELD_NUMBER
public static final int SHADOW_RULES_STAT_PREFIX_FIELD_NUMBER- See Also:
-
shadowRulesStatPrefix_
-
TRACK_PER_RULE_STATS_FIELD_NUMBER
public static final int TRACK_PER_RULE_STATS_FIELD_NUMBER- See Also:
-
trackPerRuleStats_
private boolean trackPerRuleStats_ -
memoizedIsInitialized
private byte memoizedIsInitialized -
DEFAULT_INSTANCE
-
PARSER
-
-
Constructor Details
-
RBAC
private RBAC(com.google.protobuf.GeneratedMessage.Builder<?> builder) -
RBAC
private RBAC()
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
hasRules
public boolean hasRules()Specify the RBAC rules to be applied globally. If absent, no enforcing RBAC policy will be applied. If present and empty, DENY. If both rules and matcher are configured, rules will be ignored.
.envoy.config.rbac.v3.RBAC rules = 1 [(.udpa.annotations.field_migrate) = { ... }- Specified by:
hasRulesin interfaceRBACOrBuilder- Returns:
- Whether the rules field is set.
-
getRules
Specify the RBAC rules to be applied globally. If absent, no enforcing RBAC policy will be applied. If present and empty, DENY. If both rules and matcher are configured, rules will be ignored.
.envoy.config.rbac.v3.RBAC rules = 1 [(.udpa.annotations.field_migrate) = { ... }- Specified by:
getRulesin interfaceRBACOrBuilder- Returns:
- The rules.
-
getRulesOrBuilder
Specify the RBAC rules to be applied globally. If absent, no enforcing RBAC policy will be applied. If present and empty, DENY. If both rules and matcher are configured, rules will be ignored.
.envoy.config.rbac.v3.RBAC rules = 1 [(.udpa.annotations.field_migrate) = { ... }- Specified by:
getRulesOrBuilderin interfaceRBACOrBuilder
-
getRulesStatPrefix
If specified, 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 rules.
string rules_stat_prefix = 6;- Specified by:
getRulesStatPrefixin interfaceRBACOrBuilder- Returns:
- The rulesStatPrefix.
-
getRulesStatPrefixBytes
public com.google.protobuf.ByteString getRulesStatPrefixBytes()If specified, 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 rules.
string rules_stat_prefix = 6;- Specified by:
getRulesStatPrefixBytesin interfaceRBACOrBuilder- Returns:
- The bytes for rulesStatPrefix.
-
hasMatcher
public boolean hasMatcher()The match tree to use when resolving RBAC action for incoming requests. Requests do not match any matcher will be denied. If absent, no enforcing RBAC matcher will be applied. If present and empty, deny all requests.
.xds.type.matcher.v3.Matcher matcher = 4 [(.udpa.annotations.field_migrate) = { ... }- Specified by:
hasMatcherin interfaceRBACOrBuilder- Returns:
- Whether the matcher field is set.
-
getMatcher
The match tree to use when resolving RBAC action for incoming requests. Requests do not match any matcher will be denied. If absent, no enforcing RBAC matcher will be applied. If present and empty, deny all requests.
.xds.type.matcher.v3.Matcher matcher = 4 [(.udpa.annotations.field_migrate) = { ... }- Specified by:
getMatcherin interfaceRBACOrBuilder- Returns:
- The matcher.
-
getMatcherOrBuilder
The match tree to use when resolving RBAC action for incoming requests. Requests do not match any matcher will be denied. If absent, no enforcing RBAC matcher will be applied. If present and empty, deny all requests.
.xds.type.matcher.v3.Matcher matcher = 4 [(.udpa.annotations.field_migrate) = { ... }- Specified by:
getMatcherOrBuilderin interfaceRBACOrBuilder
-
hasShadowRules
public boolean hasShadowRules()Shadow rules are not enforced by the filter (i.e., returning a 403) but will emit stats and logs and can be used for rule testing. If absent, no shadow RBAC policy will be applied. If 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:
hasShadowRulesin interfaceRBACOrBuilder- Returns:
- Whether the shadowRules field is set.
-
getShadowRules
Shadow rules are not enforced by the filter (i.e., returning a 403) but will emit stats and logs and can be used for rule testing. If absent, no shadow RBAC policy will be applied. If 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:
getShadowRulesin interfaceRBACOrBuilder- Returns:
- The shadowRules.
-
getShadowRulesOrBuilder
Shadow rules are not enforced by the filter (i.e., returning a 403) but will emit stats and logs and can be used for rule testing. If absent, no shadow RBAC policy will be applied. If 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:
getShadowRulesOrBuilderin interfaceRBACOrBuilder
-
hasShadowMatcher
public boolean hasShadowMatcher()The match tree to use for emitting stats and logs which can be used for rule testing for incoming requests. If absent, no shadow matcher will be applied.
.xds.type.matcher.v3.Matcher shadow_matcher = 5 [(.udpa.annotations.field_migrate) = { ... }- Specified by:
hasShadowMatcherin interfaceRBACOrBuilder- Returns:
- Whether the shadowMatcher field is set.
-
getShadowMatcher
The match tree to use for emitting stats and logs which can be used for rule testing for incoming requests. If absent, no shadow matcher will be applied.
.xds.type.matcher.v3.Matcher shadow_matcher = 5 [(.udpa.annotations.field_migrate) = { ... }- Specified by:
getShadowMatcherin interfaceRBACOrBuilder- Returns:
- The shadowMatcher.
-
getShadowMatcherOrBuilder
The match tree to use for emitting stats and logs which can be used for rule testing for incoming requests. If absent, no shadow matcher will be applied.
.xds.type.matcher.v3.Matcher shadow_matcher = 5 [(.udpa.annotations.field_migrate) = { ... }- Specified by:
getShadowMatcherOrBuilderin interfaceRBACOrBuilder
-
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 = 3;- Specified by:
getShadowRulesStatPrefixin interfaceRBACOrBuilder- Returns:
- The shadowRulesStatPrefix.
-
getShadowRulesStatPrefixBytes
public 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 = 3;- Specified by:
getShadowRulesStatPrefixBytesin interfaceRBACOrBuilder- 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:
getTrackPerRuleStatsin interfaceRBACOrBuilder- Returns:
- The trackPerRuleStats.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- 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
- Throws:
IOException
-
parseFrom
public static RBAC parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static RBAC parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static RBAC parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
- Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-