Class Policy
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite
-
- com.google.protobuf.AbstractMessage
-
- com.google.protobuf.GeneratedMessage
-
- io.envoyproxy.envoy.config.rbac.v3.Policy
-
- All Implemented Interfaces:
com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,PolicyOrBuilder
,java.io.Serializable
public final class Policy extends com.google.protobuf.GeneratedMessage implements PolicyOrBuilder
Policy specifies a role and the principals that are assigned/denied the role. A policy matches if and only if at least one of its permissions match the action taking place AND at least one of its principals match the downstream AND the condition is true if specified.
Protobuf typeenvoy.config.rbac.v3.Policy
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Policy.Builder
Policy specifies a role and the principals that are assigned/denied the role.-
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_
static int
CHECKED_CONDITION_FIELD_NUMBER
private CheckedExpr
checkedCondition_
private Expr
condition_
static int
CONDITION_FIELD_NUMBER
private static Policy
DEFAULT_INSTANCE
private byte
memoizedIsInitialized
private static com.google.protobuf.Parser<Policy>
PARSER
private java.util.List<Permission>
permissions_
static int
PERMISSIONS_FIELD_NUMBER
private java.util.List<Principal>
principals_
static int
PRINCIPALS_FIELD_NUMBER
private static long
serialVersionUID
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object obj)
CheckedExpr
getCheckedCondition()
[#not-implemented-hide:] An optional symbolic expression that has been successfully type checked.CheckedExprOrBuilder
getCheckedConditionOrBuilder()
[#not-implemented-hide:] An optional symbolic expression that has been successfully type checked.Expr
getCondition()
An optional symbolic expression specifying an access control :ref:`condition <arch_overview_condition>`.ExprOrBuilder
getConditionOrBuilder()
An optional symbolic expression specifying an access control :ref:`condition <arch_overview_condition>`.static Policy
getDefaultInstance()
Policy
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Parser<Policy>
getParserForType()
Permission
getPermissions(int index)
Required.int
getPermissionsCount()
Required.java.util.List<Permission>
getPermissionsList()
Required.PermissionOrBuilder
getPermissionsOrBuilder(int index)
Required.java.util.List<? extends PermissionOrBuilder>
getPermissionsOrBuilderList()
Required.Principal
getPrincipals(int index)
Required.int
getPrincipalsCount()
Required.java.util.List<Principal>
getPrincipalsList()
Required.PrincipalOrBuilder
getPrincipalsOrBuilder(int index)
Required.java.util.List<? extends PrincipalOrBuilder>
getPrincipalsOrBuilderList()
Required.int
getSerializedSize()
boolean
hasCheckedCondition()
[#not-implemented-hide:] An optional symbolic expression that has been successfully type checked.boolean
hasCondition()
An optional symbolic expression specifying an access control :ref:`condition <arch_overview_condition>`.int
hashCode()
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
static Policy.Builder
newBuilder()
static Policy.Builder
newBuilder(Policy prototype)
Policy.Builder
newBuilderForType()
protected Policy.Builder
newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Policy
parseDelimitedFrom(java.io.InputStream input)
static Policy
parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Policy
parseFrom(byte[] data)
static Policy
parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Policy
parseFrom(com.google.protobuf.ByteString data)
static Policy
parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Policy
parseFrom(com.google.protobuf.CodedInputStream input)
static Policy
parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Policy
parseFrom(java.io.InputStream input)
static Policy
parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Policy
parseFrom(java.nio.ByteBuffer data)
static Policy
parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Policy>
parser()
Policy.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_
-
PERMISSIONS_FIELD_NUMBER
public static final int PERMISSIONS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
permissions_
private java.util.List<Permission> permissions_
-
PRINCIPALS_FIELD_NUMBER
public static final int PRINCIPALS_FIELD_NUMBER
- See Also:
- Constant Field Values
-
principals_
private java.util.List<Principal> principals_
-
CONDITION_FIELD_NUMBER
public static final int CONDITION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
condition_
private Expr condition_
-
CHECKED_CONDITION_FIELD_NUMBER
public static final int CHECKED_CONDITION_FIELD_NUMBER
- See Also:
- Constant Field Values
-
checkedCondition_
private CheckedExpr checkedCondition_
-
memoizedIsInitialized
private byte memoizedIsInitialized
-
DEFAULT_INSTANCE
private static final Policy DEFAULT_INSTANCE
-
PARSER
private static final com.google.protobuf.Parser<Policy> 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
-
getPermissionsList
public java.util.List<Permission> getPermissionsList()
Required. The set of permissions that define a role. Each permission is matched with OR semantics. To match all actions for this policy, a single Permission with the ``any`` field set to true should be used.
repeated .envoy.config.rbac.v3.Permission permissions = 1 [(.validate.rules) = { ... }
- Specified by:
getPermissionsList
in interfacePolicyOrBuilder
-
getPermissionsOrBuilderList
public java.util.List<? extends PermissionOrBuilder> getPermissionsOrBuilderList()
Required. The set of permissions that define a role. Each permission is matched with OR semantics. To match all actions for this policy, a single Permission with the ``any`` field set to true should be used.
repeated .envoy.config.rbac.v3.Permission permissions = 1 [(.validate.rules) = { ... }
- Specified by:
getPermissionsOrBuilderList
in interfacePolicyOrBuilder
-
getPermissionsCount
public int getPermissionsCount()
Required. The set of permissions that define a role. Each permission is matched with OR semantics. To match all actions for this policy, a single Permission with the ``any`` field set to true should be used.
repeated .envoy.config.rbac.v3.Permission permissions = 1 [(.validate.rules) = { ... }
- Specified by:
getPermissionsCount
in interfacePolicyOrBuilder
-
getPermissions
public Permission getPermissions(int index)
Required. The set of permissions that define a role. Each permission is matched with OR semantics. To match all actions for this policy, a single Permission with the ``any`` field set to true should be used.
repeated .envoy.config.rbac.v3.Permission permissions = 1 [(.validate.rules) = { ... }
- Specified by:
getPermissions
in interfacePolicyOrBuilder
-
getPermissionsOrBuilder
public PermissionOrBuilder getPermissionsOrBuilder(int index)
Required. The set of permissions that define a role. Each permission is matched with OR semantics. To match all actions for this policy, a single Permission with the ``any`` field set to true should be used.
repeated .envoy.config.rbac.v3.Permission permissions = 1 [(.validate.rules) = { ... }
- Specified by:
getPermissionsOrBuilder
in interfacePolicyOrBuilder
-
getPrincipalsList
public java.util.List<Principal> getPrincipalsList()
Required. The set of principals that are assigned/denied the role based on “action”. Each principal is matched with OR semantics. To match all downstreams for this policy, a single Principal with the ``any`` field set to true should be used.
repeated .envoy.config.rbac.v3.Principal principals = 2 [(.validate.rules) = { ... }
- Specified by:
getPrincipalsList
in interfacePolicyOrBuilder
-
getPrincipalsOrBuilderList
public java.util.List<? extends PrincipalOrBuilder> getPrincipalsOrBuilderList()
Required. The set of principals that are assigned/denied the role based on “action”. Each principal is matched with OR semantics. To match all downstreams for this policy, a single Principal with the ``any`` field set to true should be used.
repeated .envoy.config.rbac.v3.Principal principals = 2 [(.validate.rules) = { ... }
- Specified by:
getPrincipalsOrBuilderList
in interfacePolicyOrBuilder
-
getPrincipalsCount
public int getPrincipalsCount()
Required. The set of principals that are assigned/denied the role based on “action”. Each principal is matched with OR semantics. To match all downstreams for this policy, a single Principal with the ``any`` field set to true should be used.
repeated .envoy.config.rbac.v3.Principal principals = 2 [(.validate.rules) = { ... }
- Specified by:
getPrincipalsCount
in interfacePolicyOrBuilder
-
getPrincipals
public Principal getPrincipals(int index)
Required. The set of principals that are assigned/denied the role based on “action”. Each principal is matched with OR semantics. To match all downstreams for this policy, a single Principal with the ``any`` field set to true should be used.
repeated .envoy.config.rbac.v3.Principal principals = 2 [(.validate.rules) = { ... }
- Specified by:
getPrincipals
in interfacePolicyOrBuilder
-
getPrincipalsOrBuilder
public PrincipalOrBuilder getPrincipalsOrBuilder(int index)
Required. The set of principals that are assigned/denied the role based on “action”. Each principal is matched with OR semantics. To match all downstreams for this policy, a single Principal with the ``any`` field set to true should be used.
repeated .envoy.config.rbac.v3.Principal principals = 2 [(.validate.rules) = { ... }
- Specified by:
getPrincipalsOrBuilder
in interfacePolicyOrBuilder
-
hasCondition
public boolean hasCondition()
An optional symbolic expression specifying an access control :ref:`condition <arch_overview_condition>`. The condition is combined with the permissions and the principals as a clause with AND semantics. Only be used when checked_condition is not used.
.google.api.expr.v1alpha1.Expr condition = 3 [(.udpa.annotations.field_migrate) = { ... }
- Specified by:
hasCondition
in interfacePolicyOrBuilder
- Returns:
- Whether the condition field is set.
-
getCondition
public Expr getCondition()
An optional symbolic expression specifying an access control :ref:`condition <arch_overview_condition>`. The condition is combined with the permissions and the principals as a clause with AND semantics. Only be used when checked_condition is not used.
.google.api.expr.v1alpha1.Expr condition = 3 [(.udpa.annotations.field_migrate) = { ... }
- Specified by:
getCondition
in interfacePolicyOrBuilder
- Returns:
- The condition.
-
getConditionOrBuilder
public ExprOrBuilder getConditionOrBuilder()
An optional symbolic expression specifying an access control :ref:`condition <arch_overview_condition>`. The condition is combined with the permissions and the principals as a clause with AND semantics. Only be used when checked_condition is not used.
.google.api.expr.v1alpha1.Expr condition = 3 [(.udpa.annotations.field_migrate) = { ... }
- Specified by:
getConditionOrBuilder
in interfacePolicyOrBuilder
-
hasCheckedCondition
public boolean hasCheckedCondition()
[#not-implemented-hide:] An optional symbolic expression that has been successfully type checked. Only be used when condition is not used.
.google.api.expr.v1alpha1.CheckedExpr checked_condition = 4 [(.udpa.annotations.field_migrate) = { ... }
- Specified by:
hasCheckedCondition
in interfacePolicyOrBuilder
- Returns:
- Whether the checkedCondition field is set.
-
getCheckedCondition
public CheckedExpr getCheckedCondition()
[#not-implemented-hide:] An optional symbolic expression that has been successfully type checked. Only be used when condition is not used.
.google.api.expr.v1alpha1.CheckedExpr checked_condition = 4 [(.udpa.annotations.field_migrate) = { ... }
- Specified by:
getCheckedCondition
in interfacePolicyOrBuilder
- Returns:
- The checkedCondition.
-
getCheckedConditionOrBuilder
public CheckedExprOrBuilder getCheckedConditionOrBuilder()
[#not-implemented-hide:] An optional symbolic expression that has been successfully type checked. Only be used when condition is not used.
.google.api.expr.v1alpha1.CheckedExpr checked_condition = 4 [(.udpa.annotations.field_migrate) = { ... }
- Specified by:
getCheckedConditionOrBuilder
in interfacePolicyOrBuilder
-
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 Policy parseFrom(java.nio.ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Policy parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Policy parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Policy parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Policy parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Policy parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
- Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Policy parseFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Policy parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Policy parseDelimitedFrom(java.io.InputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseDelimitedFrom
public static Policy parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Policy parseFrom(com.google.protobuf.CodedInputStream input) throws java.io.IOException
- Throws:
java.io.IOException
-
parseFrom
public static Policy parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
- Throws:
java.io.IOException
-
newBuilderForType
public Policy.Builder newBuilderForType()
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
public static Policy.Builder newBuilder()
-
newBuilder
public static Policy.Builder newBuilder(Policy prototype)
-
toBuilder
public Policy.Builder toBuilder()
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Policy.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
- Overrides:
newBuilderForType
in classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
public static Policy getDefaultInstance()
-
parser
public static com.google.protobuf.Parser<Policy> parser()
-
getParserForType
public com.google.protobuf.Parser<Policy> 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 Policy getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
-