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

Class Action.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Action.Builder>
io.envoyproxy.envoy.config.rbac.v3.Action.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ActionOrBuilder, Cloneable
Enclosing class:
Action
public static final class Action.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Action.Builder> implements ActionOrBuilder
 Action defines the result of allowance or denial when a request matches the matcher.
Protobuf type envoy.config.rbac.v3.Action

  • Method Summary

    Modifier and Type
    Method
    Description
    Action.Builder
    addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    Action
    build()
     
    Action
    buildPartial()
     
    Action.Builder
    clear()
     
    Action.Builder
    clearAction()
    The action to take if the matcher matches.
    Action.Builder
    clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
     
    Action.Builder
    clearName()
    The name indicates the policy name.
    Action.Builder
    clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
     
    Action.Builder
    clone()
     
    RBAC.Action
    getAction()
    The action to take if the matcher matches.
    int
    getActionValue()
    The action to take if the matcher matches.
    Action
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    String
    getName()
    The name indicates the policy name.
    com.google.protobuf.ByteString
    getNameBytes()
    The name indicates the policy name.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    Action.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    Action.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    Action.Builder
    mergeFrom(Action other)
     
    final Action.Builder
    mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     
    Action.Builder
    setAction(RBAC.Action value)
    The action to take if the matcher matches.
    Action.Builder
    setActionValue(int value)
    The action to take if the matcher matches.
    Action.Builder
    setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    Action.Builder
    setName(String value)
    The name indicates the policy name.
    Action.Builder
    setNameBytes(com.google.protobuf.ByteString value)
    The name indicates the policy name.
    Action.Builder
    setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
     
    final Action.Builder
    setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

    getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • 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.Builder<Action.Builder>

    • clear

      public Action.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessageV3.Builder<Action.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Action.Builder>

    • getDefaultInstanceForType

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

    • build

      public Action build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Action buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • clone

      public Action.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<Action.Builder>

    • setField

      public Action.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<Action.Builder>

    • clearField

      public Action.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Action.Builder>

    • clearOneof

      public Action.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Action.Builder>

    • setRepeatedField

      public Action.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Action.Builder>

    • addRepeatedField

      public Action.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Action.Builder>

    • mergeFrom

      public Action.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Action.Builder>

    • mergeFrom

      public Action.Builder mergeFrom(Action other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Action.Builder>

    • mergeFrom

      public Action.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Action.Builder>
      Throws:
      IOException

    • getName

      public String getName()
       The name indicates the policy name.
      string name = 1 [(.validate.rules) = { ... }
      Specified by:
      getName in interface ActionOrBuilder
      Returns:
      The name.

    • getNameBytes

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

    • setName

      public Action.Builder setName(String value)
       The name indicates the policy name.
      string name = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Action.Builder clearName()
       The name indicates the policy name.
      string name = 1 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setNameBytes

      public Action.Builder setNameBytes(com.google.protobuf.ByteString value)
       The name indicates the policy name.
      string name = 1 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getActionValue

      public 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;
      Specified by:
      getActionValue in interface ActionOrBuilder
      Returns:
      The enum numeric value on the wire for action.

    • setActionValue

      public Action.Builder setActionValue(int value)
       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;
      Parameters:
      value - The enum numeric value on the wire for action to set.
      Returns:
      This builder for chaining.

    • getAction

      public 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;
      Specified by:
      getAction in interface ActionOrBuilder
      Returns:
      The action.

    • setAction

      public Action.Builder setAction(RBAC.Action value)
       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;
      Parameters:
      value - The action to set.
      Returns:
      This builder for chaining.

    • clearAction

      public Action.Builder clearAction()
       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:
      This builder for chaining.

    • setUnknownFields

      public final Action.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Action.Builder>

    • mergeUnknownFields

      public final Action.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Action.Builder>