Package io.envoyproxy.envoy.extensions.filters.http.ext_authz.v3

Class CheckSettings.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CheckSettingsOrBuilder, java.lang.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.
    Protobuf type envoy.extensions.filters.http.ext_authz.v3.CheckSettings

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      CheckSettings.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)  
      CheckSettings build()  
      CheckSettings buildPartial()  
      CheckSettings.Builder clear()  
      CheckSettings.Builder clearContextExtensions()  
      CheckSettings.Builder clearDisableRequestBodyBuffering()
      When set to true, disable the configured :ref:`with_request_body <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>` for a route.
      CheckSettings.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)  
      CheckSettings.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)  
      CheckSettings.Builder clone()  
      boolean containsContextExtensions​(java.lang.String key)
      Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_v3_api_field_service.auth.v3.AttributeContext.context_extensions>` You can use this to provide extra context for the external authorization server on specific virtual hosts/routes.
      java.util.Map<java.lang.String,​java.lang.String> getContextExtensions()
      Deprecated.
      int getContextExtensionsCount()
      Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_v3_api_field_service.auth.v3.AttributeContext.context_extensions>` You can use this to provide extra context for the external authorization server on specific virtual hosts/routes.
      java.util.Map<java.lang.String,​java.lang.String> getContextExtensionsMap()
      Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_v3_api_field_service.auth.v3.AttributeContext.context_extensions>` You can use this to provide extra context for the external authorization server on specific virtual hosts/routes.
      java.lang.String getContextExtensionsOrDefault​(java.lang.String key, java.lang.String defaultValue)
      Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_v3_api_field_service.auth.v3.AttributeContext.context_extensions>` You can use this to provide extra context for the external authorization server on specific virtual hosts/routes.
      java.lang.String getContextExtensionsOrThrow​(java.lang.String key)
      Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_v3_api_field_service.auth.v3.AttributeContext.context_extensions>` You can use this to provide extra context for the external authorization server on specific virtual hosts/routes.
      CheckSettings getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Descriptors.Descriptor getDescriptorForType()  
      boolean getDisableRequestBodyBuffering()
      When set to true, disable the configured :ref:`with_request_body <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>` for a route.
      java.util.Map<java.lang.String,​java.lang.String> getMutableContextExtensions()
      Deprecated.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      protected com.google.protobuf.MapField internalGetMapField​(int number)  
      protected com.google.protobuf.MapField internalGetMutableMapField​(int number)  
      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)  
      CheckSettings.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)  
      CheckSettings.Builder putAllContextExtensions​(java.util.Map<java.lang.String,​java.lang.String> values)
      Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_v3_api_field_service.auth.v3.AttributeContext.context_extensions>` You can use this to provide extra context for the external authorization server on specific virtual hosts/routes.
      CheckSettings.Builder putContextExtensions​(java.lang.String key, java.lang.String value)
      Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_v3_api_field_service.auth.v3.AttributeContext.context_extensions>` You can use this to provide extra context for the external authorization server on specific virtual hosts/routes.
      CheckSettings.Builder removeContextExtensions​(java.lang.String key)
      Context extensions to set on the CheckRequest's :ref:`AttributeContext.context_extensions<envoy_v3_api_field_service.auth.v3.AttributeContext.context_extensions>` You can use this to provide extra context for the external authorization server on specific virtual hosts/routes.
      CheckSettings.Builder setDisableRequestBodyBuffering​(boolean value)
      When set to true, disable the configured :ref:`with_request_body <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>` for a route.
      CheckSettings.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)  
      CheckSettings.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)  
      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, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

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

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

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

        addAll, addAll, 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.MessageLite.Builder

        mergeFrom

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

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

    • Method Detail

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<CheckSettings.Builder>

      • internalGetMutableMapField

        protected com.google.protobuf.MapField internalGetMutableMapField​(int number)
        Overrides:
        internalGetMutableMapField 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,
                                      java.lang.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,
                                              java.lang.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,
                                              java.lang.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>

      • 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 java.io.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:
        java.io.IOException

      • getContextExtensionsCount

        public int getContextExtensionsCount()
        Description copied from interface: CheckSettingsOrBuilder
         Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_v3_api_field_service.auth.v3.AttributeContext.context_extensions>`
 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.
 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_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.grpc_service>`.
        map<string, string> context_extensions = 1 [(.udpa.annotations.sensitive) = true];
        Specified by:
        getContextExtensionsCount in interface CheckSettingsOrBuilder

      • containsContextExtensions

        public boolean containsContextExtensions​(java.lang.String key)
         Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_v3_api_field_service.auth.v3.AttributeContext.context_extensions>`
 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.
 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_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.grpc_service>`.
        map<string, string> context_extensions = 1 [(.udpa.annotations.sensitive) = true];
        Specified by:
        containsContextExtensions in interface CheckSettingsOrBuilder

      • getContextExtensionsMap

        public java.util.Map<java.lang.String,​java.lang.String> getContextExtensionsMap()
         Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_v3_api_field_service.auth.v3.AttributeContext.context_extensions>`
 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.
 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_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.grpc_service>`.
        map<string, string> context_extensions = 1 [(.udpa.annotations.sensitive) = true];
        Specified by:
        getContextExtensionsMap in interface CheckSettingsOrBuilder

      • getContextExtensionsOrDefault

        public java.lang.String getContextExtensionsOrDefault​(java.lang.String key,
                                                      java.lang.String defaultValue)
         Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_v3_api_field_service.auth.v3.AttributeContext.context_extensions>`
 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.
 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_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.grpc_service>`.
        map<string, string> context_extensions = 1 [(.udpa.annotations.sensitive) = true];
        Specified by:
        getContextExtensionsOrDefault in interface CheckSettingsOrBuilder

      • getContextExtensionsOrThrow

        public java.lang.String getContextExtensionsOrThrow​(java.lang.String key)
         Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_v3_api_field_service.auth.v3.AttributeContext.context_extensions>`
 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.
 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_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.grpc_service>`.
        map<string, string> context_extensions = 1 [(.udpa.annotations.sensitive) = true];
        Specified by:
        getContextExtensionsOrThrow in interface CheckSettingsOrBuilder

      • removeContextExtensions

        public CheckSettings.Builder removeContextExtensions​(java.lang.String key)
         Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_v3_api_field_service.auth.v3.AttributeContext.context_extensions>`
 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.
 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_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.grpc_service>`.
        map<string, string> context_extensions = 1 [(.udpa.annotations.sensitive) = true];

      • getMutableContextExtensions

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

      • putContextExtensions

        public CheckSettings.Builder putContextExtensions​(java.lang.String key,
                                                  java.lang.String value)
         Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_v3_api_field_service.auth.v3.AttributeContext.context_extensions>`
 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.
 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_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.grpc_service>`.
        map<string, string> context_extensions = 1 [(.udpa.annotations.sensitive) = true];

      • putAllContextExtensions

        public CheckSettings.Builder putAllContextExtensions​(java.util.Map<java.lang.String,​java.lang.String> values)
         Context extensions to set on the CheckRequest's
 :ref:`AttributeContext.context_extensions<envoy_v3_api_field_service.auth.v3.AttributeContext.context_extensions>`
 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.
 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_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.grpc_service>`.
        map<string, string> context_extensions = 1 [(.udpa.annotations.sensitive) = true];

      • getDisableRequestBodyBuffering

        public boolean getDisableRequestBodyBuffering()
         When set to true, disable the configured :ref:`with_request_body
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>` for a route.
        bool disable_request_body_buffering = 2;
        Specified by:
        getDisableRequestBodyBuffering in interface CheckSettingsOrBuilder
        Returns:
        The disableRequestBodyBuffering.

      • setDisableRequestBodyBuffering

        public CheckSettings.Builder setDisableRequestBodyBuffering​(boolean value)
         When set to true, disable the configured :ref:`with_request_body
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>` for a route.
        bool disable_request_body_buffering = 2;
        Parameters:
        value - The disableRequestBodyBuffering to set.
        Returns:
        This builder for chaining.

      • clearDisableRequestBodyBuffering

        public CheckSettings.Builder clearDisableRequestBodyBuffering()
         When set to true, disable the configured :ref:`with_request_body
 <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>` for a route.
        bool disable_request_body_buffering = 2;
        Returns:
        This builder for chaining.

      • 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>