Reference documentation and code samples for the Compute V1 Client class UrlRewrite.
The spec for modifying the path before sending the request to the matched backend service.
Generated from protobuf message google.cloud.compute.v1.UrlRewrite
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ host_rewrite
string
Before forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be from 1 to 255 characters.
↳ path_prefix_rewrite
string
Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be from 1 to 1024 characters.
↳ path_template_rewrite
string
If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax. A corresponding path_template_match must be specified. Any template variables must exist in the path_template_match field. - -At least one variable must be specified in the path_template_match field - You can omit variables from the rewritten URL - The * and ** operators cannot be matched unless they have a corresponding variable name - e.g. {format=} or {var=}. For example, a path_template_match of /static/{format=} could be rewritten as /static/content/{format} to prefix /content to the URL. Variables can also be re-ordered in a rewrite, so that /{country}/{format}/{suffix=*} can be rewritten as /content/{format}/{country}/{suffix}. At least one non-empty routeRules[].matchRules[].path_template_match is required. Only one of path_prefix_rewrite or path_template_rewrite may be specified.
getHostRewrite
Before forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be from 1 to 255 characters.
Returns
Type
Description
string
hasHostRewrite
clearHostRewrite
setHostRewrite
Before forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be from 1 to 255 characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPathPrefixRewrite
Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be from 1 to 1024 characters.
Returns
Type
Description
string
hasPathPrefixRewrite
clearPathPrefixRewrite
setPathPrefixRewrite
Before forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be from 1 to 1024 characters.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPathTemplateRewrite
If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax. A corresponding path_template_match must be specified. Any template variables must exist in the path_template_match field. - -At least one variable must be specified in the path_template_match field - You can omit variables from the rewritten URL - The * and ** operators cannot be matched unless they have a corresponding variable name - e.g. {format=} or {var=}. For example, a path_template_match of /static/{format=} could be rewritten as /static/content/{format} to prefix /content to the URL. Variables can also be re-ordered in a rewrite, so that /{country}/{format}/{suffix=*} can be rewritten as /content/{format}/{country}/{suffix}. At least one non-empty routeRules[].matchRules[].path_template_match is required. Only one of path_prefix_rewrite or path_template_rewrite may be specified.
Returns
Type
Description
string
hasPathTemplateRewrite
clearPathTemplateRewrite
setPathTemplateRewrite
If specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax. A corresponding path_template_match must be specified. Any template variables must exist in the path_template_match field. - -At least one variable must be specified in the path_template_match field - You can omit variables from the rewritten URL - The * and ** operators cannot be matched unless they have a corresponding variable name - e.g. {format=} or {var=}. For example, a path_template_match of /static/{format=} could be rewritten as /static/content/{format} to prefix /content to the URL. Variables can also be re-ordered in a rewrite, so that /{country}/{format}/{suffix=*} can be rewritten as /content/{format}/{country}/{suffix}. At least one non-empty routeRules[].matchRules[].path_template_match is required. Only one of path_prefix_rewrite or path_template_rewrite may be specified.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Compute V1 Client - Class UrlRewrite (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.UrlRewrite)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.UrlRewrite)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.UrlRewrite)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.UrlRewrite)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.UrlRewrite)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.UrlRewrite)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.UrlRewrite)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.UrlRewrite)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.UrlRewrite)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.UrlRewrite)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.UrlRewrite)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.UrlRewrite)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.UrlRewrite)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.UrlRewrite)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.UrlRewrite)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.UrlRewrite)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.UrlRewrite)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.UrlRewrite)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.UrlRewrite)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.UrlRewrite)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.UrlRewrite)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.UrlRewrite)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.UrlRewrite)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.UrlRewrite)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.UrlRewrite)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.UrlRewrite)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.UrlRewrite)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.UrlRewrite)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.UrlRewrite)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.UrlRewrite) \nReference documentation and code samples for the Compute V1 Client class UrlRewrite.\n\nThe spec for modifying the path before sending the request to the matched backend service.\n\nGenerated from protobuf message `google.cloud.compute.v1.UrlRewrite`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getHostRewrite\n\nBefore forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be from 1 to 255 characters.\n\n### hasHostRewrite\n\n### clearHostRewrite\n\n### setHostRewrite\n\nBefore forwarding the request to the selected service, the request's host header is replaced with contents of hostRewrite. The value must be from 1 to 255 characters.\n\n### getPathPrefixRewrite\n\nBefore forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be from 1 to 1024 characters.\n\n### hasPathPrefixRewrite\n\n### clearPathPrefixRewrite\n\n### setPathPrefixRewrite\n\nBefore forwarding the request to the selected backend service, the matching portion of the request's path is replaced by pathPrefixRewrite. The value must be from 1 to 1024 characters.\n\n### getPathTemplateRewrite\n\nIf specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax. A corresponding path_template_match must be specified. Any template variables must exist in the path_template_match field. - -At least one variable must be specified in the path_template_match field - You can omit variables from the rewritten URL - The \\* and \\*\\* operators cannot be matched unless they have a corresponding variable name - e.g. {format=*} or {var=* *}. For example, a path_template_match of /static/{format=* *} could be rewritten as /static/content/{format} to prefix /content to the URL. Variables can also be re-ordered in a rewrite, so that /{country}/{format}/{suffix=*\\*} can be rewritten as /content/{format}/{country}/{suffix}. At least one non-empty routeRules\\[\\].matchRules\\[\\].path_template_match is required. Only one of path_prefix_rewrite or path_template_rewrite may be specified.\n\n### hasPathTemplateRewrite\n\n### clearPathTemplateRewrite\n\n### setPathTemplateRewrite\n\nIf specified, the pattern rewrites the URL path (based on the :path header) using the HTTP template syntax. A corresponding path_template_match must be specified. Any template variables must exist in the path_template_match field. - -At least one variable must be specified in the path_template_match field - You can omit variables from the rewritten URL - The \\* and \\*\\* operators cannot be matched unless they have a corresponding variable name - e.g. {format=*} or {var=* *}. For example, a path_template_match of /static/{format=* *} could be rewritten as /static/content/{format} to prefix /content to the URL. Variables can also be re-ordered in a rewrite, so that /{country}/{format}/{suffix=*\\*} can be rewritten as /content/{format}/{country}/{suffix}. At least one non-empty routeRules\\[\\].matchRules\\[\\].path_template_match is required. Only one of path_prefix_rewrite or path_template_rewrite may be specified."]]
