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

Interface MethodRestrictionsOrBuilder

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

  • Method Details

    • getRequestFieldRestrictionsCount

      int getRequestFieldRestrictionsCount()
       Restrictions that apply to request fields of the method.
 Key - field mask like path of the field e.g., foo.bar.baz
 Value - Restrictions map containing the mapping from restriction name to
 the restriction values.
      map<string, .envoy.extensions.filters.http.proto_api_scrubber.v3.RestrictionConfig> request_field_restrictions = 1;

    • containsRequestFieldRestrictions

      boolean containsRequestFieldRestrictions(String key)
       Restrictions that apply to request fields of the method.
 Key - field mask like path of the field e.g., foo.bar.baz
 Value - Restrictions map containing the mapping from restriction name to
 the restriction values.
      map<string, .envoy.extensions.filters.http.proto_api_scrubber.v3.RestrictionConfig> request_field_restrictions = 1;

    • getRequestFieldRestrictions

      @Deprecated Map<String,RestrictionConfig> getRequestFieldRestrictions()
      Deprecated.
      Use getRequestFieldRestrictionsMap() instead.

    • getRequestFieldRestrictionsMap

      Map<String,RestrictionConfig> getRequestFieldRestrictionsMap()
       Restrictions that apply to request fields of the method.
 Key - field mask like path of the field e.g., foo.bar.baz
 Value - Restrictions map containing the mapping from restriction name to
 the restriction values.
      map<string, .envoy.extensions.filters.http.proto_api_scrubber.v3.RestrictionConfig> request_field_restrictions = 1;

    • getRequestFieldRestrictionsOrDefault

      RestrictionConfig getRequestFieldRestrictionsOrDefault(String key, RestrictionConfig defaultValue)
       Restrictions that apply to request fields of the method.
 Key - field mask like path of the field e.g., foo.bar.baz
 Value - Restrictions map containing the mapping from restriction name to
 the restriction values.
      map<string, .envoy.extensions.filters.http.proto_api_scrubber.v3.RestrictionConfig> request_field_restrictions = 1;

    • getRequestFieldRestrictionsOrThrow

      RestrictionConfig getRequestFieldRestrictionsOrThrow(String key)
       Restrictions that apply to request fields of the method.
 Key - field mask like path of the field e.g., foo.bar.baz
 Value - Restrictions map containing the mapping from restriction name to
 the restriction values.
      map<string, .envoy.extensions.filters.http.proto_api_scrubber.v3.RestrictionConfig> request_field_restrictions = 1;

    • getResponseFieldRestrictionsCount

      int getResponseFieldRestrictionsCount()
       Restrictions that apply to response fields of the method.
 Key - field mask like path of the field e.g., foo.bar.baz
 Value - Restrictions map containing the mapping from restriction name to
 the restriction values.
      map<string, .envoy.extensions.filters.http.proto_api_scrubber.v3.RestrictionConfig> response_field_restrictions = 2;

    • containsResponseFieldRestrictions

      boolean containsResponseFieldRestrictions(String key)
       Restrictions that apply to response fields of the method.
 Key - field mask like path of the field e.g., foo.bar.baz
 Value - Restrictions map containing the mapping from restriction name to
 the restriction values.
      map<string, .envoy.extensions.filters.http.proto_api_scrubber.v3.RestrictionConfig> response_field_restrictions = 2;

    • getResponseFieldRestrictions

      @Deprecated Map<String,RestrictionConfig> getResponseFieldRestrictions()
      Deprecated.
      Use getResponseFieldRestrictionsMap() instead.

    • getResponseFieldRestrictionsMap

      Map<String,RestrictionConfig> getResponseFieldRestrictionsMap()
       Restrictions that apply to response fields of the method.
 Key - field mask like path of the field e.g., foo.bar.baz
 Value - Restrictions map containing the mapping from restriction name to
 the restriction values.
      map<string, .envoy.extensions.filters.http.proto_api_scrubber.v3.RestrictionConfig> response_field_restrictions = 2;

    • getResponseFieldRestrictionsOrDefault

      RestrictionConfig getResponseFieldRestrictionsOrDefault(String key, RestrictionConfig defaultValue)
       Restrictions that apply to response fields of the method.
 Key - field mask like path of the field e.g., foo.bar.baz
 Value - Restrictions map containing the mapping from restriction name to
 the restriction values.
      map<string, .envoy.extensions.filters.http.proto_api_scrubber.v3.RestrictionConfig> response_field_restrictions = 2;

    • getResponseFieldRestrictionsOrThrow

      RestrictionConfig getResponseFieldRestrictionsOrThrow(String key)
       Restrictions that apply to response fields of the method.
 Key - field mask like path of the field e.g., foo.bar.baz
 Value - Restrictions map containing the mapping from restriction name to
 the restriction values.
      map<string, .envoy.extensions.filters.http.proto_api_scrubber.v3.RestrictionConfig> response_field_restrictions = 2;

    • hasMethodRestriction

      boolean hasMethodRestriction()
       Optional restriction that applies to the entire method. If present, this
 rule takes precedence for the method itself over field-level or
 message-level rules. The 'matcher' within RestrictionConfig will determine
 if the method is denied/scrubbed. If the matcher evaluates to true:

 - The request is **denied**, and further processing is stopped.
 - The implementation should generate an immediate error response
   (e.g., an HTTP 403 Forbidden status) and send it to the client.
      .envoy.extensions.filters.http.proto_api_scrubber.v3.RestrictionConfig method_restriction = 3;
      Returns:
      Whether the methodRestriction field is set.

    • getMethodRestriction

      RestrictionConfig getMethodRestriction()
       Optional restriction that applies to the entire method. If present, this
 rule takes precedence for the method itself over field-level or
 message-level rules. The 'matcher' within RestrictionConfig will determine
 if the method is denied/scrubbed. If the matcher evaluates to true:

 - The request is **denied**, and further processing is stopped.
 - The implementation should generate an immediate error response
   (e.g., an HTTP 403 Forbidden status) and send it to the client.
      .envoy.extensions.filters.http.proto_api_scrubber.v3.RestrictionConfig method_restriction = 3;
      Returns:
      The methodRestriction.

    • getMethodRestrictionOrBuilder

      RestrictionConfigOrBuilder getMethodRestrictionOrBuilder()
       Optional restriction that applies to the entire method. If present, this
 rule takes precedence for the method itself over field-level or
 message-level rules. The 'matcher' within RestrictionConfig will determine
 if the method is denied/scrubbed. If the matcher evaluates to true:

 - The request is **denied**, and further processing is stopped.
 - The implementation should generate an immediate error response
   (e.g., an HTTP 403 Forbidden status) and send it to the client.
      .envoy.extensions.filters.http.proto_api_scrubber.v3.RestrictionConfig method_restriction = 3;