target.apidocs.com.google.api.services.compute.model.HttpRouteAction.html Maven / Gradle / Ivy

Go to download







HttpRouteAction (Compute Engine API v1-rev20200104-1.30.8)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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

All Methods Instance Methods Concrete Methods 

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.



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, prior to 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
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, prior to 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. Please see W3C Recommendation
 for Cross Origin Resource Sharing

Returns:
value or null for none








setCorsPolicy
public HttpRouteAction setCorsPolicy(CorsPolicy corsPolicy)
The specification for allowing client side cross-origin requests. Please see W3C Recommendation
 for Cross Origin Resource Sharing

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 Loadbalancer on a percentage of requests before sending
 those request to the backend service. Similarly requests from clients can be aborted by the
 Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients
 that are configured with a fault_injection_policy.

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 Loadbalancer on a percentage of requests before sending
 those request to the backend service. Similarly requests from clients can be aborted by the
 Loadbalancer for a percentage of requests. timeout and retry_policy will be ignored by clients
 that are configured with a fault_injection_policy.

Parameters:
faultInjectionPolicy - faultInjectionPolicy 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. Loadbalancer does not wait for responses from the shadow
 service. Prior to sending traffic to the shadow service, the host / authority header is
 suffixed with -shadow.

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. Loadbalancer does not wait for responses from the shadow
 service. Prior to sending traffic to the shadow service, the host / authority header is
 suffixed with -shadow.

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 (i.e. end-of-stream) up until the response has been completely processed.
 Timeout includes all retries. If not specified, will use the largest timeout among all backend
 services associated with the route.

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 (i.e. end-of-stream) up until the response has been completely processed.
 Timeout includes all retries. If not specified, will use the largest timeout among all backend
 services associated with the route.

Parameters:
timeout - timeout or null for none








getUrlRewrite
public UrlRewrite getUrlRewrite()
The spec to modify the URL of the request, prior to forwarding the request to the matched
 service.

Returns:
value or null for none








setUrlRewrite
public HttpRouteAction setUrlRewrite(UrlRewrite urlRewrite)
The spec to modify the URL of the request, prior to forwarding the request to the matched
 service.

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 0 number. Once a backendService is identified and before forwarding the
 request to the backend service, advanced routing actions like 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 0 number. Once a backendService is identified and before forwarding the
 request to the backend service, advanced routing actions like 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














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2020 Google. All rights reserved.

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.
`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, prior to 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`	`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, prior to 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.