Package io.envoyproxy.envoy.config.filter.http.ext_authz.v2

Class CheckSettings.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<CheckSettings.Builder>
io.envoyproxy.envoy.config.filter.http.ext_authz.v2.CheckSettings.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CheckSettingsOrBuilder, Cloneable
Enclosing class:
CheckSettings
public static final class CheckSettings.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<CheckSettings.Builder> implements CheckSettingsOrBuilder
 Extra settings for the check request. You can use this to provide extra context for the
 external authorization server on specific virtual hosts \ routes. For example, adding a context
 extension on the virtual host level can give the ext-authz server information on what virtual
 host is used without needing to parse the host header. If CheckSettings is specified in multiple
 per-filter-configs, they will be merged in order, and the result will be used.
Protobuf type envoy.config.filter.http.ext_authz.v2.CheckSettings

  • Method Summary

    Modifier and Type
    Method
    Description
    CheckSettings.Builder
    addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    CheckSettings
    build()
     
    CheckSettings
    buildPartial()
     
    CheckSettings.Builder
    clear()
     
    CheckSettings.Builder
    clearContextExtensions()
     
    CheckSettings.Builder
    clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
     
    CheckSettings.Builder
    clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
     
    CheckSettings.Builder
    clone()
     
    boolean
    containsContextExtensions(String key)
    Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v2.AttributeContext.context_extensions>` Merge semantics for this field are such that keys from more specific configs override. .. note:: These settings are only applied to a filter configured with a :ref:`grpc_service<envoy_api_field_config.filter.http.ext_authz.v2.ExtAuthz.grpc_service>`.
    Map<String,String>
    getContextExtensions()
    Deprecated.
    int
    getContextExtensionsCount()
    Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v2.AttributeContext.context_extensions>` Merge semantics for this field are such that keys from more specific configs override. .. note:: These settings are only applied to a filter configured with a :ref:`grpc_service<envoy_api_field_config.filter.http.ext_authz.v2.ExtAuthz.grpc_service>`.
    Map<String,String>
    getContextExtensionsMap()
    Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v2.AttributeContext.context_extensions>` Merge semantics for this field are such that keys from more specific configs override. .. note:: These settings are only applied to a filter configured with a :ref:`grpc_service<envoy_api_field_config.filter.http.ext_authz.v2.ExtAuthz.grpc_service>`.
    String
    getContextExtensionsOrDefault(String key, String defaultValue)
    Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v2.AttributeContext.context_extensions>` Merge semantics for this field are such that keys from more specific configs override. .. note:: These settings are only applied to a filter configured with a :ref:`grpc_service<envoy_api_field_config.filter.http.ext_authz.v2.ExtAuthz.grpc_service>`.
    String
    getContextExtensionsOrThrow(String key)
    Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v2.AttributeContext.context_extensions>` Merge semantics for this field are such that keys from more specific configs override. .. note:: These settings are only applied to a filter configured with a :ref:`grpc_service<envoy_api_field_config.filter.http.ext_authz.v2.ExtAuthz.grpc_service>`.
    CheckSettings
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    Map<String,String>
    getMutableContextExtensions()
    Deprecated.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMutableMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    CheckSettings.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    CheckSettings.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    CheckSettings.Builder
    mergeFrom(CheckSettings other)
     
    final CheckSettings.Builder
    mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
     
    CheckSettings.Builder
    putAllContextExtensions(Map<String,String> values)
    Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v2.AttributeContext.context_extensions>` Merge semantics for this field are such that keys from more specific configs override. .. note:: These settings are only applied to a filter configured with a :ref:`grpc_service<envoy_api_field_config.filter.http.ext_authz.v2.ExtAuthz.grpc_service>`.
    CheckSettings.Builder
    putContextExtensions(String key, String value)
    Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v2.AttributeContext.context_extensions>` Merge semantics for this field are such that keys from more specific configs override. .. note:: These settings are only applied to a filter configured with a :ref:`grpc_service<envoy_api_field_config.filter.http.ext_authz.v2.ExtAuthz.grpc_service>`.
    CheckSettings.Builder
    removeContextExtensions(String key)
    Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v2.AttributeContext.context_extensions>` Merge semantics for this field are such that keys from more specific configs override. .. note:: These settings are only applied to a filter configured with a :ref:`grpc_service<envoy_api_field_config.filter.http.ext_authz.v2.ExtAuthz.grpc_service>`.
    CheckSettings.Builder
    setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
     
    CheckSettings.Builder
    setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
     
    final CheckSettings.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, internalGetMutableMapField, 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()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<CheckSettings.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessageV3.Builder<CheckSettings.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<CheckSettings.Builder>

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public CheckSettings.Builder mergeFrom(CheckSettings other)

    • isInitialized

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

    • mergeFrom

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

    • getContextExtensionsCount

      public int getContextExtensionsCount()
      Description copied from interface: CheckSettingsOrBuilder
       Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v2.AttributeContext.context_extensions>`

 Merge semantics for this field are such that keys from more specific configs override.

 .. note::

   These settings are only applied to a filter configured with a
   :ref:`grpc_service<envoy_api_field_config.filter.http.ext_authz.v2.ExtAuthz.grpc_service>`.
      map<string, string> context_extensions = 1;
      Specified by:
      getContextExtensionsCount in interface CheckSettingsOrBuilder

    • containsContextExtensions

      public boolean containsContextExtensions(String key)
       Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v2.AttributeContext.context_extensions>`

 Merge semantics for this field are such that keys from more specific configs override.

 .. note::

   These settings are only applied to a filter configured with a
   :ref:`grpc_service<envoy_api_field_config.filter.http.ext_authz.v2.ExtAuthz.grpc_service>`.
      map<string, string> context_extensions = 1;
      Specified by:
      containsContextExtensions in interface CheckSettingsOrBuilder

    • getContextExtensions

      @Deprecated public Map<String,String> getContextExtensions()
      Deprecated.
      Use getContextExtensionsMap() instead.
      Specified by:
      getContextExtensions in interface CheckSettingsOrBuilder

    • getContextExtensionsMap

      public Map<String,String> getContextExtensionsMap()
       Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v2.AttributeContext.context_extensions>`

 Merge semantics for this field are such that keys from more specific configs override.

 .. note::

   These settings are only applied to a filter configured with a
   :ref:`grpc_service<envoy_api_field_config.filter.http.ext_authz.v2.ExtAuthz.grpc_service>`.
      map<string, string> context_extensions = 1;
      Specified by:
      getContextExtensionsMap in interface CheckSettingsOrBuilder

    • getContextExtensionsOrDefault

      public String getContextExtensionsOrDefault(String key, String defaultValue)
       Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v2.AttributeContext.context_extensions>`

 Merge semantics for this field are such that keys from more specific configs override.

 .. note::

   These settings are only applied to a filter configured with a
   :ref:`grpc_service<envoy_api_field_config.filter.http.ext_authz.v2.ExtAuthz.grpc_service>`.
      map<string, string> context_extensions = 1;
      Specified by:
      getContextExtensionsOrDefault in interface CheckSettingsOrBuilder

    • getContextExtensionsOrThrow

      public String getContextExtensionsOrThrow(String key)
       Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v2.AttributeContext.context_extensions>`

 Merge semantics for this field are such that keys from more specific configs override.

 .. note::

   These settings are only applied to a filter configured with a
   :ref:`grpc_service<envoy_api_field_config.filter.http.ext_authz.v2.ExtAuthz.grpc_service>`.
      map<string, string> context_extensions = 1;
      Specified by:
      getContextExtensionsOrThrow in interface CheckSettingsOrBuilder

    • clearContextExtensions

      public CheckSettings.Builder clearContextExtensions()

    • removeContextExtensions

      public CheckSettings.Builder removeContextExtensions(String key)
       Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v2.AttributeContext.context_extensions>`

 Merge semantics for this field are such that keys from more specific configs override.

 .. note::

   These settings are only applied to a filter configured with a
   :ref:`grpc_service<envoy_api_field_config.filter.http.ext_authz.v2.ExtAuthz.grpc_service>`.
      map<string, string> context_extensions = 1;

    • getMutableContextExtensions

      @Deprecated public Map<String,String> getMutableContextExtensions()
      Deprecated.
      Use alternate mutation accessors instead.

    • putContextExtensions

      public CheckSettings.Builder putContextExtensions(String key, String value)
       Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v2.AttributeContext.context_extensions>`

 Merge semantics for this field are such that keys from more specific configs override.

 .. note::

   These settings are only applied to a filter configured with a
   :ref:`grpc_service<envoy_api_field_config.filter.http.ext_authz.v2.ExtAuthz.grpc_service>`.
      map<string, string> context_extensions = 1;

    • putAllContextExtensions

      public CheckSettings.Builder putAllContextExtensions(Map<String,String> values)
       Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v2.AttributeContext.context_extensions>`

 Merge semantics for this field are such that keys from more specific configs override.

 .. note::

   These settings are only applied to a filter configured with a
   :ref:`grpc_service<envoy_api_field_config.filter.http.ext_authz.v2.ExtAuthz.grpc_service>`.
      map<string, string> context_extensions = 1;

    • setUnknownFields

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

    • mergeUnknownFields

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