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

Class MethodRestrictions

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.proto_api_scrubber.v3.MethodRestrictions
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MethodRestrictionsOrBuilder, Serializable
public final class MethodRestrictions extends com.google.protobuf.GeneratedMessageV3 implements MethodRestrictionsOrBuilder
 Contains the method restrictions which include the field level restrictions
 for the request and response fields.
Protobuf type envoy.extensions.filters.http.proto_api_scrubber.v3.MethodRestrictions
See Also:

  • Field Details

    • REQUEST_FIELD_RESTRICTIONS_FIELD_NUMBER

      public static final int REQUEST_FIELD_RESTRICTIONS_FIELD_NUMBER
      See Also:

    • RESPONSE_FIELD_RESTRICTIONS_FIELD_NUMBER

      public static final int RESPONSE_FIELD_RESTRICTIONS_FIELD_NUMBER
      See Also:

    • METHOD_RESTRICTION_FIELD_NUMBER

      public static final int METHOD_RESTRICTION_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getRequestFieldRestrictionsCount

      public int getRequestFieldRestrictionsCount()
      Description copied from interface: MethodRestrictionsOrBuilder
       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;
      Specified by:
      getRequestFieldRestrictionsCount in interface MethodRestrictionsOrBuilder

    • containsRequestFieldRestrictions

      public 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;
      Specified by:
      containsRequestFieldRestrictions in interface MethodRestrictionsOrBuilder

    • getRequestFieldRestrictions

      @Deprecated public Map<String,RestrictionConfig> getRequestFieldRestrictions()
      Deprecated.
      Use getRequestFieldRestrictionsMap() instead.
      Specified by:
      getRequestFieldRestrictions in interface MethodRestrictionsOrBuilder

    • getRequestFieldRestrictionsMap

      public 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;
      Specified by:
      getRequestFieldRestrictionsMap in interface MethodRestrictionsOrBuilder

    • getRequestFieldRestrictionsOrDefault

      public 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;
      Specified by:
      getRequestFieldRestrictionsOrDefault in interface MethodRestrictionsOrBuilder

    • getRequestFieldRestrictionsOrThrow

      public 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;
      Specified by:
      getRequestFieldRestrictionsOrThrow in interface MethodRestrictionsOrBuilder

    • getResponseFieldRestrictionsCount

      public int getResponseFieldRestrictionsCount()
      Description copied from interface: MethodRestrictionsOrBuilder
       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;
      Specified by:
      getResponseFieldRestrictionsCount in interface MethodRestrictionsOrBuilder

    • containsResponseFieldRestrictions

      public 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;
      Specified by:
      containsResponseFieldRestrictions in interface MethodRestrictionsOrBuilder

    • getResponseFieldRestrictions

      @Deprecated public Map<String,RestrictionConfig> getResponseFieldRestrictions()
      Deprecated.
      Use getResponseFieldRestrictionsMap() instead.
      Specified by:
      getResponseFieldRestrictions in interface MethodRestrictionsOrBuilder

    • getResponseFieldRestrictionsMap

      public 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;
      Specified by:
      getResponseFieldRestrictionsMap in interface MethodRestrictionsOrBuilder

    • getResponseFieldRestrictionsOrDefault

      public 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;
      Specified by:
      getResponseFieldRestrictionsOrDefault in interface MethodRestrictionsOrBuilder

    • getResponseFieldRestrictionsOrThrow

      public 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;
      Specified by:
      getResponseFieldRestrictionsOrThrow in interface MethodRestrictionsOrBuilder

    • hasMethodRestriction

      public 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;
      Specified by:
      hasMethodRestriction in interface MethodRestrictionsOrBuilder
      Returns:
      Whether the methodRestriction field is set.

    • getMethodRestriction

      public 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;
      Specified by:
      getMethodRestriction in interface MethodRestrictionsOrBuilder
      Returns:
      The methodRestriction.

    • getMethodRestrictionOrBuilder

      public 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;
      Specified by:
      getMethodRestrictionOrBuilder in interface MethodRestrictionsOrBuilder

    • isInitialized

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

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static MethodRestrictions parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MethodRestrictions parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MethodRestrictions parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MethodRestrictions parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MethodRestrictions parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MethodRestrictions parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static MethodRestrictions parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MethodRestrictions parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MethodRestrictions parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static MethodRestrictions parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MethodRestrictions parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static MethodRestrictions parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public MethodRestrictions.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static MethodRestrictions.Builder newBuilder()

    • newBuilder

      public static MethodRestrictions.Builder newBuilder(MethodRestrictions prototype)

    • toBuilder

      public MethodRestrictions.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected MethodRestrictions.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static MethodRestrictions getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<MethodRestrictions> parser()

    • getParserForType

      public com.google.protobuf.Parser<MethodRestrictions> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

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