Class HttpGenericBodyMatch

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.common.matcher.v3.HttpGenericBodyMatch
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HttpGenericBodyMatchOrBuilder, Serializable

public final class HttpGenericBodyMatch extends com.google.protobuf.GeneratedMessageV3 implements HttpGenericBodyMatchOrBuilder
 HTTP generic body match configuration.
 List of text strings and hex strings to be located in HTTP body.
 All specified strings must be found in the HTTP body for positive match.
 The search may be limited to specified number of bytes from the body start.

 .. attention::

   Searching for patterns in HTTP body is potentially CPU-intensive. For each specified pattern, HTTP body is scanned byte by byte to find a match.
   If multiple patterns are specified, the process is repeated for each pattern. If location of a pattern is known, ``bytes_limit`` should be specified
   to scan only part of the HTTP body.
 
Protobuf type envoy.config.common.matcher.v3.HttpGenericBodyMatch
See Also:
  • Field Details

    • BYTES_LIMIT_FIELD_NUMBER

      public static final int BYTES_LIMIT_FIELD_NUMBER
      See Also:
    • PATTERNS_FIELD_NUMBER

      public static final int PATTERNS_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()
    • internalGetFieldAccessorTable

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

      public int getBytesLimit()
       Limits search to specified number of bytes - default zero (no limit - match entire captured buffer).
       
      uint32 bytes_limit = 1;
      Specified by:
      getBytesLimit in interface HttpGenericBodyMatchOrBuilder
      Returns:
      The bytesLimit.
    • getPatternsList

      public List<HttpGenericBodyMatch.GenericTextMatch> getPatternsList()
       List of patterns to match.
       
      repeated .envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch patterns = 2 [(.validate.rules) = { ... }
      Specified by:
      getPatternsList in interface HttpGenericBodyMatchOrBuilder
    • getPatternsOrBuilderList

      public List<? extends HttpGenericBodyMatch.GenericTextMatchOrBuilder> getPatternsOrBuilderList()
       List of patterns to match.
       
      repeated .envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch patterns = 2 [(.validate.rules) = { ... }
      Specified by:
      getPatternsOrBuilderList in interface HttpGenericBodyMatchOrBuilder
    • getPatternsCount

      public int getPatternsCount()
       List of patterns to match.
       
      repeated .envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch patterns = 2 [(.validate.rules) = { ... }
      Specified by:
      getPatternsCount in interface HttpGenericBodyMatchOrBuilder
    • getPatterns

      public HttpGenericBodyMatch.GenericTextMatch getPatterns(int index)
       List of patterns to match.
       
      repeated .envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch patterns = 2 [(.validate.rules) = { ... }
      Specified by:
      getPatterns in interface HttpGenericBodyMatchOrBuilder
    • getPatternsOrBuilder

      public HttpGenericBodyMatch.GenericTextMatchOrBuilder getPatternsOrBuilder(int index)
       List of patterns to match.
       
      repeated .envoy.config.common.matcher.v3.HttpGenericBodyMatch.GenericTextMatch patterns = 2 [(.validate.rules) = { ... }
      Specified by:
      getPatternsOrBuilder in interface HttpGenericBodyMatchOrBuilder
    • 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 HttpGenericBodyMatch parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

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

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

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

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

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

      public static HttpGenericBodyMatch parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static HttpGenericBodyMatch parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static HttpGenericBodyMatch.Builder newBuilder()
    • newBuilder

      public static HttpGenericBodyMatch.Builder newBuilder(HttpGenericBodyMatch prototype)
    • toBuilder

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

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

      public static HttpGenericBodyMatch getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<HttpGenericBodyMatch> parser()
    • getParserForType

      public com.google.protobuf.Parser<HttpGenericBodyMatch> 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 HttpGenericBodyMatch getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder