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

Interface CheckSettingsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CheckSettings, CheckSettings.Builder
public interface CheckSettingsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsContextExtensions(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.
    Map<String,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.
    Map<String,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.
    String
    getContextExtensionsOrDefault(String key, 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.
    String
    getContextExtensionsOrThrow(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.
    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 specific route.
    GrpcService
    getGrpcService()
    Override with a gRPC service configuration.
    GrpcServiceOrBuilder
    getGrpcServiceOrBuilder()
    Override with a gRPC service configuration.
    HttpService
    getHttpService()
    Override with an HTTP service configuration.
    HttpServiceOrBuilder
    getHttpServiceOrBuilder()
    Override with an HTTP service configuration.
    CheckSettings.ServiceOverrideCase
    getServiceOverrideCase()
     
    BufferSettings
    getWithRequestBody()
    Enable or override request body buffering, which is configured using the :ref:`with_request_body <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>` option for a specific route.
    BufferSettingsOrBuilder
    getWithRequestBodyOrBuilder()
    Enable or override request body buffering, which is configured using the :ref:`with_request_body <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>` option for a specific route.
    boolean
    hasGrpcService()
    Override with a gRPC service configuration.
    boolean
    hasHttpService()
    Override with an HTTP service configuration.
    boolean
    hasWithRequestBody()
    Enable or override request body buffering, which is configured using the :ref:`with_request_body <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>` option for a specific route.

    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 Details

    • getContextExtensionsCount

      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. 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];

    • containsContextExtensions

      boolean containsContextExtensions(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];

    • getContextExtensions

      @Deprecated Map<String,String> getContextExtensions()
      Deprecated.
      Use getContextExtensionsMap() instead.

    • getContextExtensionsMap

      Map<String,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];

    • getContextExtensionsOrDefault

      String getContextExtensionsOrDefault(String key, 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];

    • getContextExtensionsOrThrow

      String getContextExtensionsOrThrow(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];

    • getDisableRequestBodyBuffering

      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 specific route.

 Only one of ``disable_request_body_buffering`` and
 :ref:`with_request_body <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.CheckSettings.with_request_body>`
 may be specified.
      bool disable_request_body_buffering = 2;
      Returns:
      The disableRequestBodyBuffering.

    • hasWithRequestBody

      boolean hasWithRequestBody()
       Enable or override request body buffering, which is configured using the
 :ref:`with_request_body <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>`
 option for a specific route.

 Only one of ``with_request_body`` and
 :ref:`disable_request_body_buffering <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.CheckSettings.disable_request_body_buffering>`
 may be specified.
      .envoy.extensions.filters.http.ext_authz.v3.BufferSettings with_request_body = 3;
      Returns:
      Whether the withRequestBody field is set.

    • getWithRequestBody

      BufferSettings getWithRequestBody()
       Enable or override request body buffering, which is configured using the
 :ref:`with_request_body <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>`
 option for a specific route.

 Only one of ``with_request_body`` and
 :ref:`disable_request_body_buffering <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.CheckSettings.disable_request_body_buffering>`
 may be specified.
      .envoy.extensions.filters.http.ext_authz.v3.BufferSettings with_request_body = 3;
      Returns:
      The withRequestBody.

    • getWithRequestBodyOrBuilder

      BufferSettingsOrBuilder getWithRequestBodyOrBuilder()
       Enable or override request body buffering, which is configured using the
 :ref:`with_request_body <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>`
 option for a specific route.

 Only one of ``with_request_body`` and
 :ref:`disable_request_body_buffering <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.CheckSettings.disable_request_body_buffering>`
 may be specified.
      .envoy.extensions.filters.http.ext_authz.v3.BufferSettings with_request_body = 3;

    • hasGrpcService

      boolean hasGrpcService()
       Override with a gRPC service configuration.
      .envoy.config.core.v3.GrpcService grpc_service = 4;
      Returns:
      Whether the grpcService field is set.

    • getGrpcService

      GrpcService getGrpcService()
       Override with a gRPC service configuration.
      .envoy.config.core.v3.GrpcService grpc_service = 4;
      Returns:
      The grpcService.

    • getGrpcServiceOrBuilder

      GrpcServiceOrBuilder getGrpcServiceOrBuilder()
       Override with a gRPC service configuration.
      .envoy.config.core.v3.GrpcService grpc_service = 4;

    • hasHttpService

      boolean hasHttpService()
       Override with an HTTP service configuration.
      .envoy.extensions.filters.http.ext_authz.v3.HttpService http_service = 5;
      Returns:
      Whether the httpService field is set.

    • getHttpService

      HttpService getHttpService()
       Override with an HTTP service configuration.
      .envoy.extensions.filters.http.ext_authz.v3.HttpService http_service = 5;
      Returns:
      The httpService.

    • getHttpServiceOrBuilder

      HttpServiceOrBuilder getHttpServiceOrBuilder()
       Override with an HTTP service configuration.
      .envoy.extensions.filters.http.ext_authz.v3.HttpService http_service = 5;

    • getServiceOverrideCase

      CheckSettings.ServiceOverrideCase getServiceOverrideCase()