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

Interface ActionOrBuilder

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

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      RBAC.Action getAction()
      The action to take if the matcher matches.
      int getActionValue()
      The action to take if the matcher matches.
      String getName()
      The name indicates the policy name.
      com.google.protobuf.ByteString getNameBytes()
      The name indicates the policy name.

      • 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

      • getName

        String getName()
         The name indicates the policy name.
        string name = 1 [(.validate.rules) = { ... }
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         The name indicates the policy name.
        string name = 1 [(.validate.rules) = { ... }
        Returns:
        The bytes for name.

      • getActionValue

        int getActionValue()
         The action to take if the matcher matches. Every action either allows or denies a request,
 and can also carry out action-specific operations.
 Actions:
  * ``ALLOW``: If the request gets matched on ALLOW, it is permitted.
  * ``DENY``: If the request gets matched on DENY, it is not permitted.
  * ``LOG``: If the request gets matched on LOG, it is permitted. Besides, the
    dynamic metadata key ``access_log_hint`` under the shared key namespace
    ``envoy.common`` will be set to the value ``true``.
  * If the request cannot get matched, it will fallback to ``DENY``.
 Log behavior:
  If the RBAC matcher contains at least one LOG action, the dynamic
  metadata key ``access_log_hint`` will be set based on if the request
  get matched on the LOG action.
        .envoy.config.rbac.v3.RBAC.Action action = 2;
        Returns:
        The enum numeric value on the wire for action.

      • getAction

        RBAC.Action getAction()
         The action to take if the matcher matches. Every action either allows or denies a request,
 and can also carry out action-specific operations.
 Actions:
  * ``ALLOW``: If the request gets matched on ALLOW, it is permitted.
  * ``DENY``: If the request gets matched on DENY, it is not permitted.
  * ``LOG``: If the request gets matched on LOG, it is permitted. Besides, the
    dynamic metadata key ``access_log_hint`` under the shared key namespace
    ``envoy.common`` will be set to the value ``true``.
  * If the request cannot get matched, it will fallback to ``DENY``.
 Log behavior:
  If the RBAC matcher contains at least one LOG action, the dynamic
  metadata key ``access_log_hint`` will be set based on if the request
  get matched on the LOG action.
        .envoy.config.rbac.v3.RBAC.Action action = 2;
        Returns:
        The action.