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

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

There is a newer version: v1-rev20250320-2.0.0

Show newest version







WeightedBackendService (Compute Engine API v1-rev20250107-2.0.0)











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 WeightedBackendService



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













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class WeightedBackendService
extends com.google.api.client.json.GenericJson
In contrast to a single BackendService in HttpRouteAction to which all matching traffic is
 directed to, WeightedBackendService allows traffic to be split across multiple backend services.
 The volume of traffic for each backend service is proportional to the weight specified in each
 WeightedBackendService

  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


WeightedBackendService() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


WeightedBackendService
clone() 


String
getBackendService()
The full or partial URL to the default BackendService resource.



HttpHeaderAction
getHeaderAction()
Specifies changes to request and response headers that need to take effect for the selected
 backendService.



Long
getWeight()
Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all
 weightedBackendService weights in routeAction) .



WeightedBackendService
set(String fieldName,
   Object value) 


WeightedBackendService
setBackendService(String backendService)
The full or partial URL to the default BackendService resource.



WeightedBackendService
setHeaderAction(HttpHeaderAction headerAction)
Specifies changes to request and response headers that need to take effect for the selected
 backendService.



WeightedBackendService
setWeight(Long weight)
Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all
 weightedBackendService weights in routeAction) .







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





WeightedBackendService
public WeightedBackendService()









Method Detail





getBackendService
public String getBackendService()
The full or partial URL to the default BackendService resource. Before forwarding the request
 to backendService, the load balancer applies any relevant headerActions specified as part of
 this backendServiceWeight.

Returns:
value or null for none








setBackendService
public WeightedBackendService setBackendService(String backendService)
The full or partial URL to the default BackendService resource. Before forwarding the request
 to backendService, the load balancer applies any relevant headerActions specified as part of
 this backendServiceWeight.

Parameters:
backendService - backendService or null for none








getHeaderAction
public HttpHeaderAction getHeaderAction()
Specifies changes to request and response headers that need to take effect for the selected
 backendService. headerAction specified here take effect before headerAction in the enclosing
 HttpRouteRule, PathMatcher and UrlMap. headerAction is not supported for load balancers that
 have their loadBalancingScheme set to EXTERNAL. 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








setHeaderAction
public WeightedBackendService setHeaderAction(HttpHeaderAction headerAction)
Specifies changes to request and response headers that need to take effect for the selected
 backendService. headerAction specified here take effect before headerAction in the enclosing
 HttpRouteRule, PathMatcher and UrlMap. headerAction is not supported for load balancers that
 have their loadBalancingScheme set to EXTERNAL. Not supported when the URL map is bound to a
 target gRPC proxy that has validateForProxyless field set to true.

Parameters:
headerAction - headerAction or null for none








getWeight
public Long getWeight()
Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all
 weightedBackendService weights in routeAction) . The selection of a backend service is
 determined only for new traffic. Once a user's request has been directed to a backend service,
 subsequent requests are sent to the same backend service as determined by the backend service's
 session affinity policy. Don't configure session affinity if you're using weighted traffic
 splitting. If you do, the weighted traffic splitting configuration takes precedence. The value
 must be from 0 to 1000.

Returns:
value or null for none








setWeight
public WeightedBackendService setWeight(Long weight)
Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all
 weightedBackendService weights in routeAction) . The selection of a backend service is
 determined only for new traffic. Once a user's request has been directed to a backend service,
 subsequent requests are sent to the same backend service as determined by the backend service's
 session affinity policy. Don't configure session affinity if you're using weighted traffic
 splitting. If you do, the weighted traffic splitting configuration takes precedence. The value
 must be from 0 to 1000.

Parameters:
weight - weight or null for none








set
public WeightedBackendService set(String fieldName,
                                  Object value)

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








clone
public WeightedBackendService clone()

Overrides:
clone in class com.google.api.client.json.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–2025 Google. All rights reserved.

Modifier and Type	Method and Description
`WeightedBackendService`	`clone()`
`String`	`getBackendService()` The full or partial URL to the default BackendService resource.
`HttpHeaderAction`	`getHeaderAction()` Specifies changes to request and response headers that need to take effect for the selected backendService.
`Long`	`getWeight()` Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) .
`WeightedBackendService`	`set(String fieldName, Object value)`
`WeightedBackendService`	`setBackendService(String backendService)` The full or partial URL to the default BackendService resource.
`WeightedBackendService`	`setHeaderAction(HttpHeaderAction headerAction)` Specifies changes to request and response headers that need to take effect for the selected backendService.
`WeightedBackendService`	`setWeight(Long weight)` Specifies the fraction of traffic sent to a backend service, computed as weight / (sum of all weightedBackendService weights in routeAction) .