![[Google Cloud Documentation]](https://www.gstatic.com/devrel-devsite/prod/v0f3a5b8b76e4a120372a69044e02756e703b6140f9f1812c6e4a0407b19864b7/clouddocs/images/lockup_full_color.svg){kind=link}
![[]](https://docs.cloud.google.com/_static/clouddocs/images/icons/categories/devops-color.svg){kind=link}
Reports whether a string contains a match of a regular expression.
Arguments
| Arguments | |
|---|---|
source |
The string that will be searched. |
regexp |
The regular expression that is matched. Uses RE2 syntax. |
Returns
True if regexp matches a substring in source and false otherwise.
Raised exceptions
| Exceptions | |
|---|---|
TypeError |
If either source or regexp is not a string. |
ValueError |
If regexp is not UTF-8 encoded or is an invalid regular expression. |
Examples
Example 1
# Test match of regular expression; returns `true` - returnStep: return: ${text.match_regex("HelloWorld", "Hello|Goodbye")}
Example 2
# Test match of regular expression; returns `false` - returnStep: return: ${text.match_regex("HelloWorld", "Goodbye")}