Reference documentation and code samples for the Compute V1 Client class CustomErrorResponsePolicyCustomErrorResponseRule.
Specifies the mapping between the response code that will be returned along with the custom error content and the response code returned by the backend service.
Generated from protobuf message google.cloud.compute.v1.CustomErrorResponsePolicyCustomErrorResponseRule
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ match_response_codes
array
Valid values include: - A number between 400 and 599: For example 401 or 503, in which case the load balancer applies the policy if the error code exactly matches this value. - 5xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 500 to 599. - 4xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 400 to 499. Values must be unique within matchResponseCodes and across all errorResponseRules of CustomErrorResponsePolicy.
↳ override_response_code
int
The HTTP status code returned with the response containing the custom error content. If overrideResponseCode is not supplied, the same response code returned by the original backend bucket or backend service is returned to the client.
↳ path
string
The full path to a file within backendBucket . For example: /errors/defaultError.html path must start with a leading slash. path cannot have trailing slashes. If the file is not available in backendBucket or the load balancer cannot reach the BackendBucket, a simple Not Found Error is returned to the client. The value must be from 1 to 1024 characters
getMatchResponseCodes
Valid values include: - A number between 400 and 599: For example 401 or 503, in which case the load balancer applies the policy if the error code exactly matches this value. - 5xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 500 to 599. - 4xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 400 to 499. Values must be unique within matchResponseCodes and across all errorResponseRules of CustomErrorResponsePolicy.
Valid values include: - A number between 400 and 599: For example 401 or 503, in which case the load balancer applies the policy if the error code exactly matches this value. - 5xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 500 to 599. - 4xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 400 to 499. Values must be unique within matchResponseCodes and across all errorResponseRules of CustomErrorResponsePolicy.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getOverrideResponseCode
The HTTP status code returned with the response containing the custom error content. If overrideResponseCode is not supplied, the same response code returned by the original backend bucket or backend service is returned to the client.
Returns
Type
Description
int
hasOverrideResponseCode
clearOverrideResponseCode
setOverrideResponseCode
The HTTP status code returned with the response containing the custom error content. If overrideResponseCode is not supplied, the same response code returned by the original backend bucket or backend service is returned to the client.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getPath
The full path to a file within backendBucket . For example: /errors/defaultError.html path must start with a leading slash. path cannot have trailing slashes. If the file is not available in backendBucket or the load balancer cannot reach the BackendBucket, a simple Not Found Error is returned to the client. The value must be from 1 to 1024 characters
Returns
Type
Description
string
hasPath
clearPath
setPath
The full path to a file within backendBucket . For example: /errors/defaultError.html path must start with a leading slash. path cannot have trailing slashes. If the file is not available in backendBucket or the load balancer cannot reach the BackendBucket, a simple Not Found Error is returned to the client. The value must be from 1 to 1024 characters
[[["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 CustomErrorResponsePolicyCustomErrorResponseRule (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.CustomErrorResponsePolicyCustomErrorResponseRule)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.CustomErrorResponsePolicyCustomErrorResponseRule) \nReference documentation and code samples for the Compute V1 Client class CustomErrorResponsePolicyCustomErrorResponseRule.\n\nSpecifies the mapping between the response code that will be returned along with the custom error content and the response code returned by the backend service.\n\nGenerated from protobuf message `google.cloud.compute.v1.CustomErrorResponsePolicyCustomErrorResponseRule`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getMatchResponseCodes\n\nValid values include: - A number between 400 and 599: For example 401 or 503, in which case the load balancer applies the policy if the error code exactly matches this value. - 5xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 500 to 599. - 4xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 400 to 499. Values must be unique within matchResponseCodes and across all errorResponseRules of CustomErrorResponsePolicy.\n\n### setMatchResponseCodes\n\nValid values include: - A number between 400 and 599: For example 401 or 503, in which case the load balancer applies the policy if the error code exactly matches this value. - 5xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 500 to 599. - 4xx: Load Balancer will apply the policy if the backend service responds with any response code in the range of 400 to 499. Values must be unique within matchResponseCodes and across all errorResponseRules of CustomErrorResponsePolicy.\n\n### getOverrideResponseCode\n\nThe HTTP status code returned with the response containing the custom error content. If overrideResponseCode is not supplied, the same response code returned by the original backend bucket or backend service is returned to the client.\n\n### hasOverrideResponseCode\n\n### clearOverrideResponseCode\n\n### setOverrideResponseCode\n\nThe HTTP status code returned with the response containing the custom error content. If overrideResponseCode is not supplied, the same response code returned by the original backend bucket or backend service is returned to the client.\n\n### getPath\n\nThe full path to a file within backendBucket . For example: /errors/defaultError.html path must start with a leading slash. path cannot have trailing slashes. If the file is not available in backendBucket or the load balancer cannot reach the BackendBucket, a simple Not Found Error is returned to the client. The value must be from 1 to 1024 characters\n\n### hasPath\n\n### clearPath\n\n### setPath\n\nThe full path to a file within backendBucket . For example: /errors/defaultError.html path must start with a leading slash. path cannot have trailing slashes. If the file is not available in backendBucket or the load balancer cannot reach the BackendBucket, a simple Not Found Error is returned to the client. The value must be from 1 to 1024 characters"]]