Package io.envoyproxy.envoy.config.filter.network.rbac.v2

Class RBAC.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<RBAC.Builder>
io.envoyproxy.envoy.config.filter.network.rbac.v2.RBAC.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RBACOrBuilder, Cloneable
Enclosing class:
RBAC
public static final class RBAC.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<RBAC.Builder> implements RBACOrBuilder
 RBAC network filter config.

 Header should not be used in rules/shadow_rules in RBAC network filter as
 this information is only available in :ref:`RBAC http filter <config_http_filters_rbac>`.
Protobuf type envoy.config.filter.network.rbac.v2.RBAC

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

    • clear

      public RBAC.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<RBAC.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<RBAC.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public RBAC.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<RBAC.Builder>

    • setField

      public RBAC.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<RBAC.Builder>

    • clearField

      public RBAC.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<RBAC.Builder>

    • clearOneof

      public RBAC.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<RBAC.Builder>

    • setRepeatedField

      public RBAC.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<RBAC.Builder>

    • addRepeatedField

      public RBAC.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<RBAC.Builder>

    • mergeFrom

      public RBAC.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<RBAC.Builder>

    • mergeFrom

      public RBAC.Builder mergeFrom(RBAC other)

    • isInitialized

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

    • mergeFrom

      public RBAC.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<RBAC.Builder>
      Throws:
      IOException

    • hasRules

      public boolean hasRules()
       Specify the RBAC rules to be applied globally.
 If absent, no enforcing RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC rules = 1;
      Specified by:
      hasRules in interface RBACOrBuilder
      Returns:
      Whether the rules field is set.

    • getRules

      public RBAC getRules()
       Specify the RBAC rules to be applied globally.
 If absent, no enforcing RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC rules = 1;
      Specified by:
      getRules in interface RBACOrBuilder
      Returns:
      The rules.

    • setRules

      public RBAC.Builder setRules(RBAC value)
       Specify the RBAC rules to be applied globally.
 If absent, no enforcing RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC rules = 1;

    • setRules

      public RBAC.Builder setRules(RBAC.Builder builderForValue)
       Specify the RBAC rules to be applied globally.
 If absent, no enforcing RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC rules = 1;

    • mergeRules

      public RBAC.Builder mergeRules(RBAC value)
       Specify the RBAC rules to be applied globally.
 If absent, no enforcing RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC rules = 1;

    • clearRules

      public RBAC.Builder clearRules()
       Specify the RBAC rules to be applied globally.
 If absent, no enforcing RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC rules = 1;

    • getRulesBuilder

      public RBAC.Builder getRulesBuilder()
       Specify the RBAC rules to be applied globally.
 If absent, no enforcing RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC rules = 1;

    • getRulesOrBuilder

      public RBACOrBuilder getRulesOrBuilder()
       Specify the RBAC rules to be applied globally.
 If absent, no enforcing RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC rules = 1;
      Specified by:
      getRulesOrBuilder in interface RBACOrBuilder

    • hasShadowRules

      public boolean hasShadowRules()
       Shadow rules are not enforced by the filter but will emit stats and logs
 and can be used for rule testing.
 If absent, no shadow RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC shadow_rules = 2;
      Specified by:
      hasShadowRules in interface RBACOrBuilder
      Returns:
      Whether the shadowRules field is set.

    • getShadowRules

      public RBAC getShadowRules()
       Shadow rules are not enforced by the filter but will emit stats and logs
 and can be used for rule testing.
 If absent, no shadow RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC shadow_rules = 2;
      Specified by:
      getShadowRules in interface RBACOrBuilder
      Returns:
      The shadowRules.

    • setShadowRules

      public RBAC.Builder setShadowRules(RBAC value)
       Shadow rules are not enforced by the filter but will emit stats and logs
 and can be used for rule testing.
 If absent, no shadow RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC shadow_rules = 2;

    • setShadowRules

      public RBAC.Builder setShadowRules(RBAC.Builder builderForValue)
       Shadow rules are not enforced by the filter but will emit stats and logs
 and can be used for rule testing.
 If absent, no shadow RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC shadow_rules = 2;

    • mergeShadowRules

      public RBAC.Builder mergeShadowRules(RBAC value)
       Shadow rules are not enforced by the filter but will emit stats and logs
 and can be used for rule testing.
 If absent, no shadow RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC shadow_rules = 2;

    • clearShadowRules

      public RBAC.Builder clearShadowRules()
       Shadow rules are not enforced by the filter but will emit stats and logs
 and can be used for rule testing.
 If absent, no shadow RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC shadow_rules = 2;

    • getShadowRulesBuilder

      public RBAC.Builder getShadowRulesBuilder()
       Shadow rules are not enforced by the filter but will emit stats and logs
 and can be used for rule testing.
 If absent, no shadow RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC shadow_rules = 2;

    • getShadowRulesOrBuilder

      public RBACOrBuilder getShadowRulesOrBuilder()
       Shadow rules are not enforced by the filter but will emit stats and logs
 and can be used for rule testing.
 If absent, no shadow RBAC policy will be applied.
      .envoy.config.rbac.v2.RBAC shadow_rules = 2;
      Specified by:
      getShadowRulesOrBuilder in interface RBACOrBuilder

    • getStatPrefix

      public String getStatPrefix()
       The prefix to use when emitting statistics.
      string stat_prefix = 3 [(.validate.rules) = { ... }
      Specified by:
      getStatPrefix in interface RBACOrBuilder
      Returns:
      The statPrefix.

    • getStatPrefixBytes

      public com.google.protobuf.ByteString getStatPrefixBytes()
       The prefix to use when emitting statistics.
      string stat_prefix = 3 [(.validate.rules) = { ... }
      Specified by:
      getStatPrefixBytes in interface RBACOrBuilder
      Returns:
      The bytes for statPrefix.

    • setStatPrefix

      public RBAC.Builder setStatPrefix(String value)
       The prefix to use when emitting statistics.
      string stat_prefix = 3 [(.validate.rules) = { ... }
      Parameters:
      value - The statPrefix to set.
      Returns:
      This builder for chaining.

    • clearStatPrefix

      public RBAC.Builder clearStatPrefix()
       The prefix to use when emitting statistics.
      string stat_prefix = 3 [(.validate.rules) = { ... }
      Returns:
      This builder for chaining.

    • setStatPrefixBytes

      public RBAC.Builder setStatPrefixBytes(com.google.protobuf.ByteString value)
       The prefix to use when emitting statistics.
      string stat_prefix = 3 [(.validate.rules) = { ... }
      Parameters:
      value - The bytes for statPrefix to set.
      Returns:
      This builder for chaining.

    • getEnforcementTypeValue

      public int getEnforcementTypeValue()
       RBAC enforcement strategy. By default RBAC will be enforced only once
 when the first byte of data arrives from the downstream. When used in
 conjunction with filters that emit dynamic metadata after decoding
 every payload (e.g., Mongo, MySQL, Kafka) set the enforcement type to
 CONTINUOUS to enforce RBAC policies on every message boundary.
      .envoy.config.filter.network.rbac.v2.RBAC.EnforcementType enforcement_type = 4;
      Specified by:
      getEnforcementTypeValue in interface RBACOrBuilder
      Returns:
      The enum numeric value on the wire for enforcementType.

    • setEnforcementTypeValue

      public RBAC.Builder setEnforcementTypeValue(int value)
       RBAC enforcement strategy. By default RBAC will be enforced only once
 when the first byte of data arrives from the downstream. When used in
 conjunction with filters that emit dynamic metadata after decoding
 every payload (e.g., Mongo, MySQL, Kafka) set the enforcement type to
 CONTINUOUS to enforce RBAC policies on every message boundary.
      .envoy.config.filter.network.rbac.v2.RBAC.EnforcementType enforcement_type = 4;
      Parameters:
      value - The enum numeric value on the wire for enforcementType to set.
      Returns:
      This builder for chaining.

    • getEnforcementType

      public RBAC.EnforcementType getEnforcementType()
       RBAC enforcement strategy. By default RBAC will be enforced only once
 when the first byte of data arrives from the downstream. When used in
 conjunction with filters that emit dynamic metadata after decoding
 every payload (e.g., Mongo, MySQL, Kafka) set the enforcement type to
 CONTINUOUS to enforce RBAC policies on every message boundary.
      .envoy.config.filter.network.rbac.v2.RBAC.EnforcementType enforcement_type = 4;
      Specified by:
      getEnforcementType in interface RBACOrBuilder
      Returns:
      The enforcementType.

    • setEnforcementType

      public RBAC.Builder setEnforcementType(RBAC.EnforcementType value)
       RBAC enforcement strategy. By default RBAC will be enforced only once
 when the first byte of data arrives from the downstream. When used in
 conjunction with filters that emit dynamic metadata after decoding
 every payload (e.g., Mongo, MySQL, Kafka) set the enforcement type to
 CONTINUOUS to enforce RBAC policies on every message boundary.
      .envoy.config.filter.network.rbac.v2.RBAC.EnforcementType enforcement_type = 4;
      Parameters:
      value - The enforcementType to set.
      Returns:
      This builder for chaining.

    • clearEnforcementType

      public RBAC.Builder clearEnforcementType()
       RBAC enforcement strategy. By default RBAC will be enforced only once
 when the first byte of data arrives from the downstream. When used in
 conjunction with filters that emit dynamic metadata after decoding
 every payload (e.g., Mongo, MySQL, Kafka) set the enforcement type to
 CONTINUOUS to enforce RBAC policies on every message boundary.
      .envoy.config.filter.network.rbac.v2.RBAC.EnforcementType enforcement_type = 4;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final RBAC.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<RBAC.Builder>

    • mergeUnknownFields

      public final RBAC.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<RBAC.Builder>