.. _envoy_v3_api_file_xds/type/matcher/v3/string.proto:

String matcher (proto)
======================




.. _envoy_v3_api_msg_.xds.type.matcher.v3.StringMatcher:

.xds.type.matcher.v3.StringMatcher
----------------------------------

`[.xds.type.matcher.v3.StringMatcher proto] <https://github.com/cncf/xds/blob/main/xds/type/matcher/v3/string.proto#L17>`_

Specifies the way to match a string.

.. code-block:: json
  :force:

  {
    "exact": ...,
    "prefix": ...,
    "suffix": ...,
    "safe_regex": {...},
    "contains": ...,
    "ignore_case": ...
  }

.. _envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.exact:

exact
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) The input string must match exactly the string specified here.
  
  Examples:
  
  * *abc* only matches the value *abc*.
  
  
  
  Precisely one of :ref:`exact <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.exact>`, :ref:`prefix <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.prefix>`, :ref:`suffix <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.suffix>`, :ref:`safe_regex <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.safe_regex>`, :ref:`contains <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.contains>` must be set.
  
.. _envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.prefix:

prefix
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) 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 <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.exact>`, :ref:`prefix <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.prefix>`, :ref:`suffix <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.suffix>`, :ref:`safe_regex <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.safe_regex>`, :ref:`contains <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.contains>` must be set.
  
.. _envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.suffix:

suffix
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) 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 <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.exact>`, :ref:`prefix <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.prefix>`, :ref:`suffix <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.suffix>`, :ref:`safe_regex <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.safe_regex>`, :ref:`contains <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.contains>` must be set.
  
.. _envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.safe_regex:

safe_regex
  (:ref:`.xds.type.matcher.v3.RegexMatcher <envoy_v3_api_msg_.xds.type.matcher.v3.RegexMatcher>`) The input string must match the regular expression specified here.
  
  
  
  Precisely one of :ref:`exact <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.exact>`, :ref:`prefix <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.prefix>`, :ref:`suffix <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.suffix>`, :ref:`safe_regex <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.safe_regex>`, :ref:`contains <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.contains>` must be set.
  
.. _envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.contains:

contains
  (`string <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) 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 <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.exact>`, :ref:`prefix <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.prefix>`, :ref:`suffix <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.suffix>`, :ref:`safe_regex <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.safe_regex>`, :ref:`contains <envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.contains>` must be set.
  
.. _envoy_v3_api_field_.xds.type.matcher.v3.StringMatcher.ignore_case:

ignore_case
  (`bool <https://developers.google.com/protocol-buffers/docs/proto#scalar>`_) 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.
  
  


.. _envoy_v3_api_msg_.xds.type.matcher.v3.ListStringMatcher:

.xds.type.matcher.v3.ListStringMatcher
--------------------------------------

`[.xds.type.matcher.v3.ListStringMatcher proto] <https://github.com/cncf/xds/blob/main/xds/type/matcher/v3/string.proto#L63>`_

Specifies a list of ways to match a string.

.. code-block:: json
  :force:

  {
    "patterns": []
  }

.. _envoy_v3_api_field_.xds.type.matcher.v3.ListStringMatcher.patterns:

patterns
  (**repeated** :ref:`.xds.type.matcher.v3.StringMatcher <envoy_v3_api_msg_.xds.type.matcher.v3.StringMatcher>`, *REQUIRED*)