Class ConsistentHashLoadBalancerSettings (1.55.0)

public final class ConsistentHashLoadBalancerSettings extends GeneratedMessageV3 implements ConsistentHashLoadBalancerSettingsOrBuilder

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

Protobuf type google.cloud.compute.v1.ConsistentHashLoadBalancerSettings

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ConsistentHashLoadBalancerSettings

Static Fields

public static final int HTTP_COOKIE_FIELD_NUMBER
Field Value
Type Description
int

HTTP_HEADER_NAME_FIELD_NUMBER

public static final int HTTP_HEADER_NAME_FIELD_NUMBER
Field Value
Type Description
int

MINIMUM_RING_SIZE_FIELD_NUMBER

public static final int MINIMUM_RING_SIZE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ConsistentHashLoadBalancerSettings getDefaultInstance()
Returns
Type Description
ConsistentHashLoadBalancerSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ConsistentHashLoadBalancerSettings.Builder newBuilder()
Returns
Type Description
ConsistentHashLoadBalancerSettings.Builder

newBuilder(ConsistentHashLoadBalancerSettings prototype)

public static ConsistentHashLoadBalancerSettings.Builder newBuilder(ConsistentHashLoadBalancerSettings prototype)
Parameter
Name Description
prototype ConsistentHashLoadBalancerSettings
Returns
Type Description
ConsistentHashLoadBalancerSettings.Builder

parseDelimitedFrom(InputStream input)

public static ConsistentHashLoadBalancerSettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConsistentHashLoadBalancerSettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConsistentHashLoadBalancerSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsistentHashLoadBalancerSettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ConsistentHashLoadBalancerSettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ConsistentHashLoadBalancerSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ConsistentHashLoadBalancerSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsistentHashLoadBalancerSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ConsistentHashLoadBalancerSettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ConsistentHashLoadBalancerSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ConsistentHashLoadBalancerSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsistentHashLoadBalancerSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ConsistentHashLoadBalancerSettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ConsistentHashLoadBalancerSettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ConsistentHashLoadBalancerSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsistentHashLoadBalancerSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ConsistentHashLoadBalancerSettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConsistentHashLoadBalancerSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConsistentHashLoadBalancerSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsistentHashLoadBalancerSettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ConsistentHashLoadBalancerSettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ConsistentHashLoadBalancerSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ConsistentHashLoadBalancerSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsistentHashLoadBalancerSettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ConsistentHashLoadBalancerSettings> parser()
Returns
Type Description
Parser<ConsistentHashLoadBalancerSettings>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ConsistentHashLoadBalancerSettings getDefaultInstanceForType()
Returns
Type Description
ConsistentHashLoadBalancerSettings

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.

optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettingsHttpCookie http_cookie = 6673915;

Returns
Type Description
ConsistentHashLoadBalancerSettingsHttpCookie

The httpCookie.

getHttpCookieOrBuilder()

public ConsistentHashLoadBalancerSettingsHttpCookieOrBuilder getHttpCookieOrBuilder()

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.

optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettingsHttpCookie http_cookie = 6673915;

Returns
Type Description
ConsistentHashLoadBalancerSettingsHttpCookieOrBuilder

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.

optional string http_header_name = 234798022;

Returns
Type Description
String

The httpHeaderName.

getHttpHeaderNameBytes()

public ByteString getHttpHeaderNameBytes()

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

optional string http_header_name = 234798022;

Returns
Type Description
ByteString

The bytes for httpHeaderName.

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.

optional int64 minimum_ring_size = 234380735;

Returns
Type Description
long

The minimumRingSize.

getParserForType()

public Parser<ConsistentHashLoadBalancerSettings> getParserForType()
Returns
Type Description
Parser<ConsistentHashLoadBalancerSettings>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasHttpCookie()

public boolean hasHttpCookie()

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.

optional .google.cloud.compute.v1.ConsistentHashLoadBalancerSettingsHttpCookie http_cookie = 6673915;

Returns
Type Description
boolean

Whether the httpCookie field is set.

hasHttpHeaderName()

public boolean hasHttpHeaderName()

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

optional string http_header_name = 234798022;

Returns
Type Description
boolean

Whether the httpHeaderName field is set.

hasMinimumRingSize()

public boolean hasMinimumRingSize()

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.

optional int64 minimum_ring_size = 234380735;

Returns
Type Description
boolean

Whether the minimumRingSize field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ConsistentHashLoadBalancerSettings.Builder newBuilderForType()
Returns
Type Description
ConsistentHashLoadBalancerSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ConsistentHashLoadBalancerSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ConsistentHashLoadBalancerSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ConsistentHashLoadBalancerSettings.Builder toBuilder()
Returns
Type Description
ConsistentHashLoadBalancerSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException