Reference documentation and code samples for the Compute V1 Client class UrlMapTest.
Message for the expected URL mappings.
Generated from protobuf messagegoogle.cloud.compute.v1.UrlMapTest
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ description
string
Description of this test case.
↳ expected_output_url
string
The expected output URL evaluated by the load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by the load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl`s scheme is ignored. For rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer's redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to HTTPS. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters. expectedOutputUrl is optional when service is specified.
↳ expected_redirect_response_code
int
For rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode cannot be set when service is set.
HTTP headers for this request. If headers contains a host header, then host must also match the header value.
↳ host
string
Host portion of the URL. If headers contains a host header, then host must also match the header value.
↳ path
string
Path portion of the URL.
↳ service
string
Expected BackendService or BackendBucket resource the given URL should be mapped to. The service field cannot be set if expectedRedirectResponseCode is set.
getDescription
Description of this test case.
Returns
Type
Description
string
hasDescription
clearDescription
setDescription
Description of this test case.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getExpectedOutputUrl
The expected output URL evaluated by the load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by the load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl`s scheme is ignored. For rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer's redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to HTTPS. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters. expectedOutputUrl is optional when service is specified.
Returns
Type
Description
string
hasExpectedOutputUrl
clearExpectedOutputUrl
setExpectedOutputUrl
The expected output URL evaluated by the load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by the load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl`s scheme is ignored. For rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer's redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to HTTPS. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters. expectedOutputUrl is optional when service is specified.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getExpectedRedirectResponseCode
For rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode cannot be set when service is set.
Returns
Type
Description
int
hasExpectedRedirectResponseCode
clearExpectedRedirectResponseCode
setExpectedRedirectResponseCode
For rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode cannot be set when service is set.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getHeaders
HTTP headers for this request. If headers contains a host header, then host must also match the header value.
Host portion of the URL. If headers contains a host header, then host must also match the header value.
Returns
Type
Description
string
hasHost
clearHost
setHost
Host portion of the URL. If headers contains a host header, then host must also match the header value.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPath
Path portion of the URL.
Returns
Type
Description
string
hasPath
clearPath
setPath
Path portion of the URL.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getService
Expected BackendService or BackendBucket resource the given URL should be mapped to. The service field cannot be set if expectedRedirectResponseCode is set.
Returns
Type
Description
string
hasService
clearService
setService
Expected BackendService or BackendBucket resource the given URL should be mapped to. The service field cannot be set if expectedRedirectResponseCode is set.
[[["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-09-04 UTC."],[],[],null,["# Compute V1 Client - Class UrlMapTest (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.UrlMapTest)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.UrlMapTest)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.UrlMapTest)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.UrlMapTest)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.UrlMapTest)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.UrlMapTest)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.UrlMapTest)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.UrlMapTest)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.UrlMapTest)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.UrlMapTest)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.UrlMapTest)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.UrlMapTest)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.UrlMapTest)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.UrlMapTest)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.UrlMapTest)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.UrlMapTest)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.UrlMapTest)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.UrlMapTest)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.UrlMapTest)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.UrlMapTest)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.UrlMapTest)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.UrlMapTest)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.UrlMapTest)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.UrlMapTest)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.UrlMapTest)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.UrlMapTest)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.UrlMapTest)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.UrlMapTest)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.UrlMapTest)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.UrlMapTest) \nReference documentation and code samples for the Compute V1 Client class UrlMapTest.\n\nMessage for the expected URL mappings.\n\nGenerated from protobuf message `google.cloud.compute.v1.UrlMapTest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDescription\n\nDescription of this test case.\n\n### hasDescription\n\n### clearDescription\n\n### setDescription\n\nDescription of this test case.\n\n### getExpectedOutputUrl\n\nThe expected output URL evaluated by the load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by the load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl\\`s scheme is ignored. For rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer's redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to HTTPS. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters. expectedOutputUrl is optional when service is specified.\n\n### hasExpectedOutputUrl\n\n### clearExpectedOutputUrl\n\n### setExpectedOutputUrl\n\nThe expected output URL evaluated by the load balancer containing the scheme, host, path and query parameters. For rules that forward requests to backends, the test passes only when expectedOutputUrl matches the request forwarded by the load balancer to backends. For rules with urlRewrite, the test verifies that the forwarded request matches hostRewrite and pathPrefixRewrite in the urlRewrite action. When service is specified, expectedOutputUrl\\`s scheme is ignored. For rules with urlRedirect, the test passes only if expectedOutputUrl matches the URL in the load balancer's redirect response. If urlRedirect specifies https_redirect, the test passes only if the scheme in expectedOutputUrl is also set to HTTPS. If urlRedirect specifies strip_query, the test passes only if expectedOutputUrl does not contain any query parameters. expectedOutputUrl is optional when service is specified.\n\n### getExpectedRedirectResponseCode\n\nFor rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode cannot be set when service is set.\n\n### hasExpectedRedirectResponseCode\n\n### clearExpectedRedirectResponseCode\n\n### setExpectedRedirectResponseCode\n\nFor rules with urlRedirect, the test passes only if expectedRedirectResponseCode matches the HTTP status code in load balancer's redirect response. expectedRedirectResponseCode cannot be set when service is set.\n\n### getHeaders\n\nHTTP headers for this request. If headers contains a host header, then host must also match the header value.\n\n### setHeaders\n\nHTTP headers for this request. If headers contains a host header, then host must also match the header value.\n\n### getHost\n\nHost portion of the URL. If headers contains a host header, then host must also match the header value.\n\n### hasHost\n\n### clearHost\n\n### setHost\n\nHost portion of the URL. If headers contains a host header, then host must also match the header value.\n\n### getPath\n\nPath portion of the URL.\n\n### hasPath\n\n### clearPath\n\n### setPath\n\nPath portion of the URL.\n\n### getService\n\nExpected BackendService or BackendBucket resource the given URL should be mapped to. The service field cannot be set if expectedRedirectResponseCode is set.\n\n### hasService\n\n### clearService\n\n### setService\n\nExpected BackendService or BackendBucket resource the given URL should be mapped to. The service field cannot be set if expectedRedirectResponseCode is set."]]
