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

Interface RBACOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    RBAC, RBAC.Builder
    public interface RBACOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsPolicies​(java.lang.String key)
      Maps from policy name to policy.
      RBAC.Action getAction()
      The action to take if a policy matches.
      int getActionValue()
      The action to take if a policy matches.
      java.util.Map<java.lang.String,​Policy> getPolicies()
      Deprecated.
      int getPoliciesCount()
      Maps from policy name to policy.
      java.util.Map<java.lang.String,​Policy> getPoliciesMap()
      Maps from policy name to policy.
      Policy getPoliciesOrDefault​(java.lang.String key, Policy defaultValue)
      Maps from policy name to policy.
      Policy getPoliciesOrThrow​(java.lang.String key)
      Maps from policy name to policy.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getActionValue

        int getActionValue()
         The action to take if a policy matches. Every action either allows or denies a request,
 and can also carry out action-specific operations.
 Actions:
  * ``ALLOW``: Allows the request if and only if there is a policy that matches
    the request.
  * ``DENY``: Allows the request if and only if there are no policies that
    match the request.
  * ``LOG``: Allows all requests. If at least one policy matches, the dynamic
    metadata key ``access_log_hint`` is set to the value ``true`` under the shared
    key namespace ``envoy.common``. If no policies match, it is set to ``false``.
    Other actions do not modify this key.
        .envoy.config.rbac.v3.RBAC.Action action = 1 [(.validate.rules) = { ... }
        Returns:
        The enum numeric value on the wire for action.

      • getAction

        RBAC.Action getAction()
         The action to take if a policy matches. Every action either allows or denies a request,
 and can also carry out action-specific operations.
 Actions:
  * ``ALLOW``: Allows the request if and only if there is a policy that matches
    the request.
  * ``DENY``: Allows the request if and only if there are no policies that
    match the request.
  * ``LOG``: Allows all requests. If at least one policy matches, the dynamic
    metadata key ``access_log_hint`` is set to the value ``true`` under the shared
    key namespace ``envoy.common``. If no policies match, it is set to ``false``.
    Other actions do not modify this key.
        .envoy.config.rbac.v3.RBAC.Action action = 1 [(.validate.rules) = { ... }
        Returns:
        The action.

      • getPoliciesCount

        int getPoliciesCount()
         Maps from policy name to policy. A match occurs when at least one policy matches the request.
 The policies are evaluated in lexicographic order of the policy name.
        map<string, .envoy.config.rbac.v3.Policy> policies = 2;

      • containsPolicies

        boolean containsPolicies​(java.lang.String key)
         Maps from policy name to policy. A match occurs when at least one policy matches the request.
 The policies are evaluated in lexicographic order of the policy name.
        map<string, .envoy.config.rbac.v3.Policy> policies = 2;

      • getPolicies

        @Deprecated
java.util.Map<java.lang.String,​Policy> getPolicies()
        Deprecated.
        Use getPoliciesMap() instead.

      • getPoliciesMap

        java.util.Map<java.lang.String,​Policy> getPoliciesMap()
         Maps from policy name to policy. A match occurs when at least one policy matches the request.
 The policies are evaluated in lexicographic order of the policy name.
        map<string, .envoy.config.rbac.v3.Policy> policies = 2;

      • getPoliciesOrDefault

        Policy getPoliciesOrDefault​(java.lang.String key,
                            Policy defaultValue)
         Maps from policy name to policy. A match occurs when at least one policy matches the request.
 The policies are evaluated in lexicographic order of the policy name.
        map<string, .envoy.config.rbac.v3.Policy> policies = 2;

      • getPoliciesOrThrow

        Policy getPoliciesOrThrow​(java.lang.String key)
         Maps from policy name to policy. A match occurs when at least one policy matches the request.
 The policies are evaluated in lexicographic order of the policy name.
        map<string, .envoy.config.rbac.v3.Policy> policies = 2;