Package io.envoyproxy.envoy.config.rbac.v3

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, 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 type envoy.config.rbac.v3.Policy
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final 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>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private int
    bitField0_
     
    static final int
    CHECKED_CONDITION_FIELD_NUMBER
     
    private CheckedExpr
    checkedCondition_
     
    private Expr
    condition_
     
    static final int
    CONDITION_FIELD_NUMBER
     
    private static final Policy
    DEFAULT_INSTANCE
     
    private byte
    memoizedIsInitialized
     
    private static final com.google.protobuf.Parser<Policy>
    PARSER
     
    private List<Permission>
    permissions_
     
    static final int
    PERMISSIONS_FIELD_NUMBER
     
    private List<Principal>
    principals_
     
    static final int
    PRINCIPALS_FIELD_NUMBER
     
    private static final long
    serialVersionUID
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    Policy()
     
    private
    Policy(com.google.protobuf.GeneratedMessage.Builder<?> builder)
     

  • Method Summary

    Modifier and Type
    Method
    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 final 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()
     
    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()
     
    final 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(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(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 Policy
    parseFrom(ByteBuffer data)
     
    static Policy
    parseFrom(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

    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

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • PERMISSIONS_FIELD_NUMBER

      public static final int PERMISSIONS_FIELD_NUMBER
      See Also:

    • permissions_

      private List<Permission> permissions_

    • PRINCIPALS_FIELD_NUMBER

      public static final int PRINCIPALS_FIELD_NUMBER
      See Also:

    • principals_

      private List<Principal> principals_

    • CONDITION_FIELD_NUMBER

      public static final int CONDITION_FIELD_NUMBER
      See Also:

    • condition_

      private Expr condition_

    • CHECKED_CONDITION_FIELD_NUMBER

      public static final int CHECKED_CONDITION_FIELD_NUMBER
      See Also:

    • 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

  • Constructor Details

    • Policy

      private Policy(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • Policy

      private Policy()

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

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

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.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 interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

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