Interface CustomErrorResponsePolicyCustomErrorResponseRuleOrBuilder (1.64.0)

Version 1.64.0

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public interface CustomErrorResponsePolicyCustomErrorResponseRuleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getMatchResponseCodes(int index)

public abstract String getMatchResponseCodes(int index)

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.

repeated string match_response_codes = 104973410;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The matchResponseCodes at the given index.

getMatchResponseCodesBytes(int index)

public abstract ByteString getMatchResponseCodesBytes(int index)

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.

repeated string match_response_codes = 104973410;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the matchResponseCodes at the given index.

getMatchResponseCodesCount()

public abstract int getMatchResponseCodesCount()

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.

repeated string match_response_codes = 104973410;

Returns
Type	Description
int	The count of matchResponseCodes.

getMatchResponseCodesList()

public abstract List<String> getMatchResponseCodesList()

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.

repeated string match_response_codes = 104973410;

Returns
Type	Description
List<String>	A list containing the matchResponseCodes.

getOverrideResponseCode()

public abstract int 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.

optional int32 override_response_code = 530328568;

Returns
Type	Description
int	The overrideResponseCode.

getPath()

public abstract String 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

optional string path = 3433509;

Returns
Type	Description
String	The path.

getPathBytes()

public abstract ByteString getPathBytes()

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

optional string path = 3433509;

Returns
Type	Description
ByteString	The bytes for path.

hasOverrideResponseCode()

public abstract boolean hasOverrideResponseCode()

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.

optional int32 override_response_code = 530328568;

Returns
Type	Description
boolean	Whether the overrideResponseCode field is set.

hasPath()

public abstract boolean hasPath()

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

optional string path = 3433509;

Returns
Type	Description
boolean	Whether the path field is set.