com.google.api.services.compute.model

Class HttpRouteAction

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class HttpRouteAction
extends GenericJson

Model definition for HttpRouteAction.

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

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

Method Summary

Modifier and Type	Method and Description
HttpRouteAction	clone()
CorsPolicy	getCorsPolicy() The specification for allowing client-side cross-origin requests.
HttpFaultInjection	getFaultInjectionPolicy() The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure.
Duration	getMaxStreamDuration() Specifies the maximum duration (timeout) for streams on the selected route.
RequestMirrorPolicy	getRequestMirrorPolicy() Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service.
HttpRetryPolicy	getRetryPolicy() Specifies the retry policy associated with this route.
Duration	getTimeout() Specifies the timeout for the selected route.
UrlRewrite	getUrlRewrite() The spec to modify the URL of the request, before forwarding the request to the matched service.
List<WeightedBackendService>	getWeightedBackendServices() A list of weighted backend services to send traffic to when a route match occurs.
HttpRouteAction	set(String fieldName, Object value)
HttpRouteAction	setCorsPolicy(CorsPolicy corsPolicy) The specification for allowing client-side cross-origin requests.
HttpRouteAction	setFaultInjectionPolicy(HttpFaultInjection faultInjectionPolicy) The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure.
HttpRouteAction	setMaxStreamDuration(Duration maxStreamDuration) Specifies the maximum duration (timeout) for streams on the selected route.
HttpRouteAction	setRequestMirrorPolicy(RequestMirrorPolicy requestMirrorPolicy) Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service.
HttpRouteAction	setRetryPolicy(HttpRetryPolicy retryPolicy) Specifies the retry policy associated with this route.
HttpRouteAction	setTimeout(Duration timeout) Specifies the timeout for the selected route.
HttpRouteAction	setUrlRewrite(UrlRewrite urlRewrite) The spec to modify the URL of the request, before forwarding the request to the matched service.
HttpRouteAction	setWeightedBackendServices(List<WeightedBackendService> weightedBackendServices) A list of weighted backend services to send traffic to when a route match occurs.

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

HttpRouteAction

public HttpRouteAction()

Method Detail

getCorsPolicy

public CorsPolicy getCorsPolicy()

The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy.

Returns:

value or null for none

setCorsPolicy

public HttpRouteAction setCorsPolicy(CorsPolicy corsPolicy)

The specification for allowing client-side cross-origin requests. For more information about the W3C recommendation for cross-origin resource sharing (CORS), see Fetch API Living Standard. Not supported when the URL map is bound to a target gRPC proxy.

Parameters:

corsPolicy - corsPolicy or null for none

getFaultInjectionPolicy

public HttpFaultInjection getFaultInjectionPolicy()

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by a load balancer on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. timeout and retry_policy is ignored by clients that are configured with a fault_injection_policy if: 1. The traffic is generated by fault injection AND 2. The fault injection is not a delay fault injection. Fault injection is not supported with the global external HTTP(S) load balancer (classic). To see which load balancers support fault injection, see Load balancing: Routing and traffic management features.

Returns:

value or null for none

setFaultInjectionPolicy

public HttpRouteAction setFaultInjectionPolicy(HttpFaultInjection faultInjectionPolicy)

The specification for fault injection introduced into traffic to test the resiliency of clients to backend service failure. As part of fault injection, when clients send requests to a backend service, delays can be introduced by a load balancer on a percentage of requests before sending those requests to the backend service. Similarly requests from clients can be aborted by the load balancer for a percentage of requests. timeout and retry_policy is ignored by clients that are configured with a fault_injection_policy if: 1. The traffic is generated by fault injection AND 2. The fault injection is not a delay fault injection. Fault injection is not supported with the global external HTTP(S) load balancer (classic). To see which load balancers support fault injection, see Load balancing: Routing and traffic management features.

Parameters:

faultInjectionPolicy - faultInjectionPolicy or null for none

getMaxStreamDuration

public Duration getMaxStreamDuration()

Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (known as *end-of-stream*), the duration in this field is computed from the beginning of the stream until the response has been processed, including all retries. A stream that does not complete in this duration is closed. If not specified, this field uses the maximum maxStreamDuration value among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Returns:

value or null for none

setMaxStreamDuration

public HttpRouteAction setMaxStreamDuration(Duration maxStreamDuration)

Specifies the maximum duration (timeout) for streams on the selected route. Unlike the timeout field where the timeout duration starts from the time the request has been fully processed (known as *end-of-stream*), the duration in this field is computed from the beginning of the stream until the response has been processed, including all retries. A stream that does not complete in this duration is closed. If not specified, this field uses the maximum maxStreamDuration value among all backend services associated with the route. This field is only allowed if the Url map is used with backend services with loadBalancingScheme set to INTERNAL_SELF_MANAGED.

Parameters:

maxStreamDuration - maxStreamDuration or null for none

getRequestMirrorPolicy

public RequestMirrorPolicy getRequestMirrorPolicy()

Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

Returns:

value or null for none

setRequestMirrorPolicy

public HttpRouteAction setRequestMirrorPolicy(RequestMirrorPolicy requestMirrorPolicy)

Specifies the policy on how requests intended for the route's backends are shadowed to a separate mirrored backend service. The load balancer does not wait for responses from the shadow service. Before sending traffic to the shadow service, the host / authority header is suffixed with -shadow. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

Parameters:

requestMirrorPolicy - requestMirrorPolicy or null for none

getRetryPolicy

public HttpRetryPolicy getRetryPolicy()

Specifies the retry policy associated with this route.

Returns:

value or null for none

setRetryPolicy

public HttpRouteAction setRetryPolicy(HttpRetryPolicy retryPolicy)

Specifies the retry policy associated with this route.

Parameters:

retryPolicy - retryPolicy or null for none

getTimeout

public Duration getTimeout()

Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (known as *end-of-stream*) up until the response has been processed. Timeout includes all retries. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

Returns:

value or null for none

setTimeout

public HttpRouteAction setTimeout(Duration timeout)

Specifies the timeout for the selected route. Timeout is computed from the time the request has been fully processed (known as *end-of-stream*) up until the response has been processed. Timeout includes all retries. If not specified, this field uses the largest timeout among all backend services associated with the route. Not supported when the URL map is bound to a target gRPC proxy that has validateForProxyless field set to true.

Parameters:

timeout - timeout or null for none

getUrlRewrite

public UrlRewrite getUrlRewrite()

The spec to modify the URL of the request, before forwarding the request to the matched service. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

Returns:

value or null for none

setUrlRewrite

public HttpRouteAction setUrlRewrite(UrlRewrite urlRewrite)

The spec to modify the URL of the request, before forwarding the request to the matched service. urlRewrite is the only action supported in UrlMaps for external HTTP(S) load balancers. Not supported when the URL map is bound to a target gRPC proxy that has the validateForProxyless field set to true.

Parameters:

urlRewrite - urlRewrite or null for none

getWeightedBackendServices

public List<WeightedBackendService> getWeightedBackendServices()

A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number. After a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Returns:

value or null for none

setWeightedBackendServices

public HttpRouteAction setWeightedBackendServices(List<WeightedBackendService> weightedBackendServices)

A list of weighted backend services to send traffic to when a route match occurs. The weights determine the fraction of traffic that flows to their corresponding backend service. If all traffic needs to go to a single backend service, there must be one weightedBackendService with weight set to a non-zero number. After a backend service is identified and before forwarding the request to the backend service, advanced routing actions such as URL rewrites and header transformations are applied depending on additional settings specified in this HttpRouteAction.

Parameters:

weightedBackendServices - weightedBackendServices or null for none

set

public HttpRouteAction set(String fieldName,
                           Object value)

Overrides:

set in class GenericJson

clone

public HttpRouteAction clone()

Overrides:

clone in class GenericJson