.. _envoy_v3_api_file_envoy/type/matcher/v3/string.proto: String matcher (proto) ====================== .. _envoy_v3_api_msg_type.matcher.v3.StringMatcher: type.matcher.v3.StringMatcher ----------------------------- :repo:`[type.matcher.v3.StringMatcher proto] ` Specifies the way to match a string. .. code-block:: json :force: { "exact": ..., "prefix": ..., "suffix": ..., "safe_regex": {...}, "contains": ..., "ignore_case": ... } .. _envoy_v3_api_field_type.matcher.v3.StringMatcher.exact: exact (`string `_) The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``. Precisely one of :ref:`exact `, :ref:`prefix `, :ref:`suffix `, :ref:`safe_regex `, :ref:`contains ` must be set. .. _envoy_v3_api_field_type.matcher.v3.StringMatcher.prefix: prefix (`string `_) 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`` Precisely one of :ref:`exact `, :ref:`prefix `, :ref:`suffix `, :ref:`safe_regex `, :ref:`contains ` must be set. .. _envoy_v3_api_field_type.matcher.v3.StringMatcher.suffix: suffix (`string `_) 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`` Precisely one of :ref:`exact `, :ref:`prefix `, :ref:`suffix `, :ref:`safe_regex `, :ref:`contains ` must be set. .. _envoy_v3_api_field_type.matcher.v3.StringMatcher.safe_regex: safe_regex (:ref:`type.matcher.v3.RegexMatcher `) The input string must match the regular expression specified here. Precisely one of :ref:`exact `, :ref:`prefix `, :ref:`suffix `, :ref:`safe_regex `, :ref:`contains ` must be set. .. _envoy_v3_api_field_type.matcher.v3.StringMatcher.contains: contains (`string `_) The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def`` Precisely one of :ref:`exact `, :ref:`prefix `, :ref:`suffix `, :ref:`safe_regex `, :ref:`contains ` must be set. .. _envoy_v3_api_field_type.matcher.v3.StringMatcher.ignore_case: ignore_case (`bool `_) If true, indicates the exact/prefix/suffix/contains 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. .. _envoy_v3_api_msg_type.matcher.v3.ListStringMatcher: type.matcher.v3.ListStringMatcher --------------------------------- :repo:`[type.matcher.v3.ListStringMatcher proto] ` Specifies a list of ways to match a string. .. code-block:: json :force: { "patterns": [] } .. _envoy_v3_api_field_type.matcher.v3.ListStringMatcher.patterns: patterns (**repeated** :ref:`type.matcher.v3.StringMatcher `, *REQUIRED*)