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

    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.
    envoy.type.matcher.StringMatcher.regex is deprecated.
    com.google.protobuf.ByteString
    getRegexBytes()
    Deprecated.
    envoy.type.matcher.StringMatcher.regex is 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
    hasExact()
    The input string must match exactly the string specified here.
    boolean
    hasPrefix()
    The input string must have the prefix specified here.
    boolean
    hasRegex()
    Deprecated.
    envoy.type.matcher.StringMatcher.regex is deprecated.
    boolean
    hasSafeRegex()
    The input string must match the regular expression specified here.
    boolean
    hasSuffix()
    The input string must have the suffix 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 Details

    • hasExact

      boolean hasExact()
       The input string must match exactly the string specified here.

 Examples:

 * *abc* only matches the value *abc*.
      string exact = 1;
      Returns:
      Whether the exact field is set.

    • getExact

      String getExact()
       The input string must match exactly the string specified here.

 Examples:

 * *abc* only matches the value *abc*.
      string exact = 1;
      Returns:
      The exact.

    • 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;
      Returns:
      The bytes for exact.

    • hasPrefix

      boolean hasPrefix()
       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) = { ... }
      Returns:
      Whether the prefix field is set.

    • 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) = { ... }
      Returns:
      The prefix.

    • 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) = { ... }
      Returns:
      The bytes for prefix.

    • hasSuffix

      boolean hasSuffix()
       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) = { ... }
      Returns:
      Whether the suffix field is set.

    • 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) = { ... }
      Returns:
      The suffix.

    • 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) = { ... }
      Returns:
      The bytes for suffix.

    • hasRegex

      @Deprecated boolean hasRegex()
      Deprecated.
      envoy.type.matcher.StringMatcher.regex is deprecated. See envoy/type/matcher/string.proto;l=60
       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) = { ... }
      Returns:
      Whether the regex field is set.

    • getRegex

      @Deprecated String getRegex()
      Deprecated.
      envoy.type.matcher.StringMatcher.regex is deprecated. See envoy/type/matcher/string.proto;l=60
       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) = { ... }
      Returns:
      The regex.

    • getRegexBytes

      @Deprecated com.google.protobuf.ByteString getRegexBytes()
      Deprecated.
      envoy.type.matcher.StringMatcher.regex is deprecated. See envoy/type/matcher/string.proto;l=60
       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) = { ... }
      Returns:
      The bytes for regex.

    • hasSafeRegex

      boolean hasSafeRegex()
       The input string must match the regular expression specified here.
      .envoy.type.matcher.RegexMatcher safe_regex = 5 [(.validate.rules) = { ... }
      Returns:
      Whether the safeRegex field is set.

    • getSafeRegex

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

    • 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;
      Returns:
      The ignoreCase.

    • getMatchPatternCase

      StringMatcher.MatchPatternCase getMatchPatternCase()