com.google.api.services.compute.model

Class CustomErrorResponsePolicy

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.CustomErrorResponsePolicy

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Specifies the custom error response policy that must be applied when the backend service or backend bucket responds with an error.

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
CustomErrorResponsePolicy()

Method Summary

Modifier and Type	Method and Description
CustomErrorResponsePolicy	clone()
List<CustomErrorResponsePolicyCustomErrorResponseRule>	getErrorResponseRules() Specifies rules for returning error responses.
String	getErrorService() The full or partial URL to the BackendBucket resource that contains the custom error content.
CustomErrorResponsePolicy	set(String fieldName, Object value)
CustomErrorResponsePolicy	setErrorResponseRules(List<CustomErrorResponsePolicyCustomErrorResponseRule> errorResponseRules) Specifies rules for returning error responses.
CustomErrorResponsePolicy	setErrorService(String errorService) The full or partial URL to the BackendBucket resource that contains the custom error content.

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

CustomErrorResponsePolicy

public CustomErrorResponsePolicy()

Method Detail

getErrorResponseRules

public List<CustomErrorResponsePolicyCustomErrorResponseRule> getErrorResponseRules()

Specifies rules for returning error responses. In a given policy, if you specify rules for both a range of error codes as well as rules for specific error codes then rules with specific error codes have a higher priority. For example, assume that you configure a rule for 401 (Un- authorized) code, and another for all 4 series error codes (4XX). If the backend service returns a 401, then the rule for 401 will be applied. However if the backend service returns a 403, the rule for 4xx takes effect.

Returns:

value or null for none

setErrorResponseRules

public CustomErrorResponsePolicy setErrorResponseRules(List<CustomErrorResponsePolicyCustomErrorResponseRule> errorResponseRules)

Specifies rules for returning error responses. In a given policy, if you specify rules for both a range of error codes as well as rules for specific error codes then rules with specific error codes have a higher priority. For example, assume that you configure a rule for 401 (Un- authorized) code, and another for all 4 series error codes (4XX). If the backend service returns a 401, then the rule for 401 will be applied. However if the backend service returns a 403, the rule for 4xx takes effect.

Parameters:

errorResponseRules - errorResponseRules or null for none

getErrorService

public String getErrorService()

The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers.

Returns:

value or null for none

setErrorService

public CustomErrorResponsePolicy setErrorService(String errorService)

The full or partial URL to the BackendBucket resource that contains the custom error content. Examples are: - https://www.googleapis.com/compute/v1/projects/project/global/backendBuckets/myBackendBucket - compute/v1/projects/project/global/backendBuckets/myBackendBucket - global/backendBuckets/myBackendBucket If errorService is not specified at lower levels like pathMatcher, pathRule and routeRule, an errorService specified at a higher level in the UrlMap will be used. If UrlMap.defaultCustomErrorResponsePolicy contains one or more errorResponseRules[], it must specify errorService. If load balancer cannot reach the backendBucket, a simple Not Found Error will be returned, with the original response code (or overrideResponseCode if configured). errorService is not supported for internal or regional HTTP/HTTPS load balancers.

Parameters:

errorService - errorService or null for none

set

public CustomErrorResponsePolicy set(String fieldName,
                                     Object value)

Overrides:

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

clone

public CustomErrorResponsePolicy clone()

Overrides:

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