io.envoyproxy.envoy.config.rbac.v3

Class Policy

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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, Serializable

public final class Policy
extends com.google.protobuf.GeneratedMessageV3
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 type envoy.config.rbac.v3.Policy

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHECKED_CONDITION_FIELD_NUMBER
static int	CONDITION_FIELD_NUMBER
static int	PERMISSIONS_FIELD_NUMBER
static int	PRINCIPALS_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 and Description
boolean	equals(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.
List<Permission>	getPermissionsList() Required.
PermissionOrBuilder	getPermissionsOrBuilder(int index) Required.
List<? extends PermissionOrBuilder>	getPermissionsOrBuilderList() Required.
Principal	getPrincipals(int index) Required.
int	getPrincipalsCount() Required.
List<Principal>	getPrincipalsList() Required.
PrincipalOrBuilder	getPrincipalsOrBuilder(int index) Required.
List<? extends PrincipalOrBuilder>	getPrincipalsOrBuilderList() Required.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
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.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Policy.Builder	newBuilder()
static Policy.Builder	newBuilder(Policy prototype)
Policy.Builder	newBuilderForType()
protected Policy.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Policy	parseDelimitedFrom(InputStream input)
static Policy	parseDelimitedFrom(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(ByteBuffer data)
static Policy	parseFrom(ByteBuffer 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(InputStream input)
static Policy	parseFrom(InputStream input, 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.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

PERMISSIONS_FIELD_NUMBER

public static final int PERMISSIONS_FIELD_NUMBER

See Also:

Constant Field Values

PRINCIPALS_FIELD_NUMBER

public static final int PRINCIPALS_FIELD_NUMBER

See Also:

Constant Field Values

CONDITION_FIELD_NUMBER

public static final int CONDITION_FIELD_NUMBER

See Also:

Constant Field Values

CHECKED_CONDITION_FIELD_NUMBER

public static final int CHECKED_CONDITION_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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

getPermissionsList

public 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 interface PolicyOrBuilder

getPermissionsOrBuilderList

public 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 interface PolicyOrBuilder

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 interface PolicyOrBuilder

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 interface PolicyOrBuilder

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 interface PolicyOrBuilder

getPrincipalsList

public 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 interface PolicyOrBuilder

getPrincipalsOrBuilderList

public 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 interface PolicyOrBuilder

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 interface PolicyOrBuilder

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 interface PolicyOrBuilder

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 interface PolicyOrBuilder

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 interface PolicyOrBuilder

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 interface PolicyOrBuilder

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 interface PolicyOrBuilder

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 interface PolicyOrBuilder

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 interface PolicyOrBuilder

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 interface PolicyOrBuilder

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 Policy parseFrom(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Policy parseFrom(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(InputStream input)
                        throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Policy parseDelimitedFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static Policy parseFrom(com.google.protobuf.CodedInputStream input)
                        throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Policy.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.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 interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Policy.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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 interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Policy getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder