com.google.api.services.compute.model

Class CustomErrorResponsePolicyCustomErrorResponseRule

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.CustomErrorResponsePolicyCustomErrorResponseRule

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class CustomErrorResponsePolicyCustomErrorResponseRule
extends com.google.api.client.json.GenericJson

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.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
CustomErrorResponsePolicyCustomErrorResponseRule()

Method Summary

Modifier and Type	Method and Description
CustomErrorResponsePolicyCustomErrorResponseRule	clone()
List<String>	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.
Integer	getOverrideResponseCode() The HTTP status code returned with the response containing the custom error content.
String	getPath() The full path to a file within backendBucket .
CustomErrorResponsePolicyCustomErrorResponseRule	set(String fieldName, Object value)
CustomErrorResponsePolicyCustomErrorResponseRule	setMatchResponseCodes(List<String> matchResponseCodes) 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.
CustomErrorResponsePolicyCustomErrorResponseRule	setOverrideResponseCode(Integer overrideResponseCode) The HTTP status code returned with the response containing the custom error content.
CustomErrorResponsePolicyCustomErrorResponseRule	setPath(String path) The full path to a file within backendBucket .

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

CustomErrorResponsePolicyCustomErrorResponseRule

public CustomErrorResponsePolicyCustomErrorResponseRule()

Method Detail

getMatchResponseCodes

public List<String> 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.

Returns:

value or null for none

setMatchResponseCodes

public CustomErrorResponsePolicyCustomErrorResponseRule setMatchResponseCodes(List<String> matchResponseCodes)

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.

Parameters:

matchResponseCodes - matchResponseCodes or null for none

getOverrideResponseCode

public Integer 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:

value or null for none

setOverrideResponseCode

public CustomErrorResponsePolicyCustomErrorResponseRule setOverrideResponseCode(Integer overrideResponseCode)

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.

Parameters:

overrideResponseCode - overrideResponseCode or null for none

getPath

public 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

Returns:

value or null for none

setPath

public CustomErrorResponsePolicyCustomErrorResponseRule setPath(String path)

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

Parameters:

path - path or null for none

set

public CustomErrorResponsePolicyCustomErrorResponseRule set(String fieldName,
                                                            Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public CustomErrorResponsePolicyCustomErrorResponseRule clone()

Overrides:

clone in class com.google.api.client.json.GenericJson