com.google.api.services.compute.model

Class ConsistentHashLoadBalancerSettings

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

This message defines settings for a consistent hash style load balancer.

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

Method Summary

Modifier and Type	Method and Description
ConsistentHashLoadBalancerSettings	clone()
ConsistentHashLoadBalancerSettingsHttpCookie	getHttpCookie() Hash is based on HTTP Cookie.
String	getHttpHeaderName() The hash based on the value of the specified header field.
Long	getMinimumRingSize() The minimum number of virtual nodes to use for the hash ring.
ConsistentHashLoadBalancerSettings	set(String fieldName, Object value)
ConsistentHashLoadBalancerSettings	setHttpCookie(ConsistentHashLoadBalancerSettingsHttpCookie httpCookie) Hash is based on HTTP Cookie.
ConsistentHashLoadBalancerSettings	setHttpHeaderName(String httpHeaderName) The hash based on the value of the specified header field.
ConsistentHashLoadBalancerSettings	setMinimumRingSize(Long minimumRingSize) The minimum number of virtual nodes to use for the hash ring.

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

ConsistentHashLoadBalancerSettings

public ConsistentHashLoadBalancerSettings()

Method Detail

getHttpCookie

public ConsistentHashLoadBalancerSettingsHttpCookie getHttpCookie()

Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Returns:

value or null for none

setHttpCookie

public ConsistentHashLoadBalancerSettings setHttpCookie(ConsistentHashLoadBalancerSettingsHttpCookie httpCookie)

Hash is based on HTTP Cookie. This field describes a HTTP cookie that will be used as the hash key for the consistent hash load balancer. If the cookie is not present, it will be generated. This field is applicable if the sessionAffinity is set to HTTP_COOKIE. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.

Parameters:

httpCookie - httpCookie or null for none

getHttpHeaderName

public String getHttpHeaderName()

The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

Returns:

value or null for none

setHttpHeaderName

public ConsistentHashLoadBalancerSettings setHttpHeaderName(String httpHeaderName)

The hash based on the value of the specified header field. This field is applicable if the sessionAffinity is set to HEADER_FIELD.

Parameters:

httpHeaderName - httpHeaderName or null for none

getMinimumRingSize

public Long getMinimumRingSize()

The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.

Returns:

value or null for none

setMinimumRingSize

public ConsistentHashLoadBalancerSettings setMinimumRingSize(Long minimumRingSize)

The minimum number of virtual nodes to use for the hash ring. Defaults to 1024. Larger ring sizes result in more granular load distributions. If the number of hosts in the load balancing pool is larger than the ring size, each host will be assigned a single virtual node.

Parameters:

minimumRingSize - minimumRingSize or null for none

set

public ConsistentHashLoadBalancerSettings set(String fieldName,
                                              Object value)

Overrides:

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

clone

public ConsistentHashLoadBalancerSettings clone()

Overrides:

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