Compute V1 Client - Class ConsistentHashLoadBalancerSettings (1.16.2)

Reference documentation and code samples for the Compute V1 Client class ConsistentHashLoadBalancerSettings.

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

Generated from protobuf message google.cloud.compute.v1.ConsistentHashLoadBalancerSettings

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ http_cookie Google\Cloud\Compute\V1\ConsistentHashLoadBalancerSettingsHttpCookie

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.

↳ http_header_name string

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

↳ minimum_ring_size int|string

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.

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
Type Description
Google\Cloud\Compute\V1\ConsistentHashLoadBalancerSettingsHttpCookie|null

hasHttpCookie

clearHttpCookie

setHttpCookie

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.

Parameter
Name Description
var Google\Cloud\Compute\V1\ConsistentHashLoadBalancerSettingsHttpCookie
Returns
Type Description
$this

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
Type Description
string

hasHttpHeaderName

clearHttpHeaderName

setHttpHeaderName

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

Parameter
Name Description
var string
Returns
Type Description
$this

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
Type Description
int|string

hasMinimumRingSize

clearMinimumRingSize

setMinimumRingSize

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.

Parameter
Name Description
var int|string
Returns
Type Description
$this