Package io.envoyproxy.envoy.type.matcher

Interface StringMatcherOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    StringMatcher, StringMatcher.Builder
    public interface StringMatcherOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      String getExact()
      The input string must match exactly the string specified here.
      com.google.protobuf.ByteString getExactBytes()
      The input string must match exactly the string specified here.
      boolean getIgnoreCase()
      If true, indicates the exact/prefix/suffix matching should be case insensitive.
      StringMatcher.MatchPatternCase getMatchPatternCase()  
      String getPrefix()
      The input string must have the prefix specified here.
      com.google.protobuf.ByteString getPrefixBytes()
      The input string must have the prefix specified here.
      String getRegex()
      Deprecated.
      com.google.protobuf.ByteString getRegexBytes()
      Deprecated.
      RegexMatcher getSafeRegex()
      The input string must match the regular expression specified here.
      RegexMatcherOrBuilder getSafeRegexOrBuilder()
      The input string must match the regular expression specified here.
      String getSuffix()
      The input string must have the suffix specified here.
      com.google.protobuf.ByteString getSuffixBytes()
      The input string must have the suffix specified here.
      boolean hasSafeRegex()
      The input string must match the regular expression specified here.

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

      • getExact

        String getExact()
         The input string must match exactly the string specified here.
 Examples:
 * *abc* only matches the value *abc*.
        string exact = 1;

      • getExactBytes

        com.google.protobuf.ByteString getExactBytes()
         The input string must match exactly the string specified here.
 Examples:
 * *abc* only matches the value *abc*.
        string exact = 1;

      • getPrefix

        String getPrefix()
         The input string must have the prefix specified here.
 Note: empty prefix is not allowed, please use regex instead.
 Examples:
 * *abc* matches the value *abc.xyz*
        string prefix = 2 [(.validate.rules) = { ... }

      • getPrefixBytes

        com.google.protobuf.ByteString getPrefixBytes()
         The input string must have the prefix specified here.
 Note: empty prefix is not allowed, please use regex instead.
 Examples:
 * *abc* matches the value *abc.xyz*
        string prefix = 2 [(.validate.rules) = { ... }

      • getSuffix

        String getSuffix()
         The input string must have the suffix specified here.
 Note: empty prefix is not allowed, please use regex instead.
 Examples:
 * *abc* matches the value *xyz.abc*
        string suffix = 3 [(.validate.rules) = { ... }

      • getSuffixBytes

        com.google.protobuf.ByteString getSuffixBytes()
         The input string must have the suffix specified here.
 Note: empty prefix is not allowed, please use regex instead.
 Examples:
 * *abc* matches the value *xyz.abc*
        string suffix = 3 [(.validate.rules) = { ... }

      • getRegex

        @Deprecated
String getRegex()
        Deprecated.
         The input string must match the regular expression specified here.
 The regex grammar is defined `here
 <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex ``\d{3}`` matches the value *123*
 * The regex ``\d{3}`` does not match the value *1234*
 * The regex ``\d{3}`` does not match the value *123.456*
 .. attention::
   This field has been deprecated in favor of `safe_regex` as it is not safe for use with
   untrusted input in all cases.
        string regex = 4 [deprecated = true, (.validate.rules) = { ... }

      • getRegexBytes

        @Deprecated
com.google.protobuf.ByteString getRegexBytes()
        Deprecated.
         The input string must match the regular expression specified here.
 The regex grammar is defined `here
 <https://en.cppreference.com/w/cpp/regex/ecmascript>`_.
 Examples:
 * The regex ``\d{3}`` matches the value *123*
 * The regex ``\d{3}`` does not match the value *1234*
 * The regex ``\d{3}`` does not match the value *123.456*
 .. attention::
   This field has been deprecated in favor of `safe_regex` as it is not safe for use with
   untrusted input in all cases.
        string regex = 4 [deprecated = true, (.validate.rules) = { ... }

      • hasSafeRegex

        boolean hasSafeRegex()
         The input string must match the regular expression specified here.
        .envoy.type.matcher.RegexMatcher safe_regex = 5 [(.validate.rules) = { ... }

      • getSafeRegex

        RegexMatcher getSafeRegex()
         The input string must match the regular expression specified here.
        .envoy.type.matcher.RegexMatcher safe_regex = 5 [(.validate.rules) = { ... }

      • getSafeRegexOrBuilder

        RegexMatcherOrBuilder getSafeRegexOrBuilder()
         The input string must match the regular expression specified here.
        .envoy.type.matcher.RegexMatcher safe_regex = 5 [(.validate.rules) = { ... }

      • getIgnoreCase

        boolean getIgnoreCase()
         If true, indicates the exact/prefix/suffix matching should be case insensitive. This has no
 effect for the safe_regex match.
 For example, the matcher *data* will match both input string *Data* and *data* if set to true.
        bool ignore_case = 6;