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
,java.io.Serializable
public final class RBAC extends com.google.protobuf.GeneratedMessage implements RBACOrBuilder
RBAC filter config. [#next-free-field: 8]
Protobuf typeenvoy.extensions.filters.http.rbac.v3.RBAC
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RBAC.Builder
RBAC filter config.-
Nested 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 extends java.lang.Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
-
-
Field Summary
Fields Modifier and Type Field Description private int
bitField0_
private static RBAC
DEFAULT_INSTANCE
private Matcher
matcher_
static int
MATCHER_FIELD_NUMBER
private byte
memoizedIsInitialized
private static com.google.protobuf.Parser<RBAC>
PARSER
private RBAC
rules_
static int
RULES_FIELD_NUMBER
static int
RULES_STAT_PREFIX_FIELD_NUMBER
private java.lang.Object
rulesStatPrefix_
private static long
serialVersionUID
static int
SHADOW_MATCHER_FIELD_NUMBER
static int
SHADOW_RULES_FIELD_NUMBER
static int
SHADOW_RULES_STAT_PREFIX_FIELD_NUMBER
private Matcher
shadowMatcher_
private RBAC
shadowRules_
private java.lang.Object
shadowRulesStatPrefix_
static int
TRACK_PER_RULE_STATS_FIELD_NUMBER
private boolean
trackPerRuleStats_
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
static RBAC
getDefaultInstance()
RBAC
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
Matcher
getMatcher()
The match tree to use when resolving RBAC action for incoming requests.MatcherOrBuilder
getMatcherOrBuilder()
The match tree to use when resolving RBAC action for incoming requests.com.google.protobuf.Parser<RBAC>
getParserForType()
RBAC
getRules()
Specify the RBAC rules to be applied globally.RBACOrBuilder
getRulesOrBuilder()
Specify the RBAC rules to be applied globally.java.lang.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()
The match tree to use for emitting stats and logs which can be used for rule testing for incoming requests.MatcherOrBuilder
getShadowMatcherOrBuilder()
The match tree to use for emitting stats and logs which can be used for rule testing for incoming requests.RBAC
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.RBACOrBuilder
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.java.lang.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()
The match tree to use when resolving RBAC action for incoming requests.boolean
hasRules()
Specify the RBAC rules to be applied globally.boolean
hasShadowMatcher()
The match tree to use for emitting stats and logs which can be used for rule testing for incoming requests.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.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static RBAC.Builder
newBuilder()
static RBAC.Builder
newBuilder(RBAC prototype)
RBAC.Builder
newBuilderForType()
protected RBAC.Builder
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static RBAC
parseDelimitedFrom(java.io.InputStream input)
static RBAC
parseDelimitedFrom(java.io.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(java.io.InputStream input)
static RBAC
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static RBAC
parseFrom(java.nio.ByteBuffer data)
static RBAC
parseFrom(java.nio.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.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
- See Also:
- Constant Field Values
-
bitField0_
private int bitField0_
-
RULES_FIELD_NUMBER
public static final int RULES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
rules_
private RBAC rules_
-
RULES_STAT_PREFIX_FIELD_NUMBER
public static final int RULES_STAT_PREFIX_FIELD_NUMBER
- See Also:
- Constant Field Values
-
rulesStatPrefix_
private volatile java.lang.Object rulesStatPrefix_
-
MATCHER_FIELD_NUMBER
public static final int MATCHER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
matcher_
private Matcher matcher_
-
SHADOW_RULES_FIELD_NUMBER
public static final int SHADOW_RULES_FIELD_NUMBER
- See Also:
- Constant Field Values
-
shadowRules_
private RBAC shadowRules_
-
SHADOW_MATCHER_FIELD_NUMBER
public static final int SHADOW_MATCHER_FIELD_NUMBER
- See Also:
- Constant Field Values
-
shadowMatcher_
private Matcher shadowMatcher_
-
SHADOW_RULES_STAT_PREFIX_FIELD_NUMBER
public static final int SHADOW_RULES_STAT_PREFIX_FIELD_NUMBER
- See Also:
- Constant Field Values
-
shadowRulesStatPrefix_
private volatile java.lang.Object shadowRulesStatPrefix_
-
TRACK_PER_RULE_STATS_FIELD_NUMBER
public static final int TRACK_PER_RULE_STATS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
trackPerRuleStats_
private boolean trackPerRuleStats_
-
memoizedIsInitialized
private byte memoizedIsInitialized
-
DEFAULT_INSTANCE
private static final RBAC DEFAULT_INSTANCE
-
PARSER
private static final com.google.protobuf.Parser<RBAC> PARSER
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTable
in 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:
hasRules
in interfaceRBACOrBuilder
- Returns:
- Whether the rules field is set.
-
getRules
public RBAC 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:
getRules
in interfaceRBACOrBuilder
- Returns:
- The rules.
-
getRulesOrBuilder
public RBACOrBuilder 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:
getRulesOrBuilder
in interfaceRBACOrBuilder
-
getRulesStatPrefix
public java.lang.String 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:
getRulesStatPrefix
in 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:
getRulesStatPrefixBytes
in 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:
hasMatcher
in interfaceRBACOrBuilder
- Returns:
- Whether the matcher field is set.
-
getMatcher
public Matcher 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:
getMatcher
in interfaceRBACOrBuilder
- Returns:
- The matcher.
-
getMatcherOrBuilder
public MatcherOrBuilder 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:
getMatcherOrBuilder
in 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:
hasShadowRules
in interfaceRBACOrBuilder
- Returns:
- Whether the shadowRules field is set.
-
getShadowRules
public RBAC 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:
getShadowRules
in interfaceRBACOrBuilder
- Returns:
- The shadowRules.
-
getShadowRulesOrBuilder
public RBACOrBuilder 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:
getShadowRulesOrBuilder
in 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:
hasShadowMatcher
in interfaceRBACOrBuilder
- Returns:
- Whether the shadowMatcher field is set.
-
getShadowMatcher
public Matcher 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:
getShadowMatcher
in interfaceRBACOrBuilder
- Returns:
- The shadowMatcher.
-
getShadowMatcherOrBuilder
public MatcherOrBuilder 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:
getShadowMatcherOrBuilder
in interfaceRBACOrBuilder
-
getShadowRulesStatPrefix
public java.lang.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 = 3;
- Specified by:
getShadowRulesStatPrefix
in 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:
getShadowRulesStatPrefixBytes
in 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:
getTrackPerRuleStats
in interfaceRBACOrBuilder
- Returns:
- The trackPerRuleStats.
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage
-
writeTo
public void writeTo(com.google.protobuf.CodedOutputStream output) throws java.io.IOException
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessage
- Throws:
java.io.IOException
-
getSerializedSize
public int getSerializedSize()
- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessage
-
equals
public boolean equals(java.lang.Object obj)
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()
- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static RBAC parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static RBAC parseFrom(java.nio.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(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RBAC parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static RBAC parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static RBAC parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RBAC parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static RBAC parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public RBAC.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.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 interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected RBAC.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
- Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
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 interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
public RBAC getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-