Class ConsistentHashLoadBalancerSettings (1.21.0)

Version 1.21.0

• 1.62.0 (latest)
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

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

Implements

ConsistentHashLoadBalancerSettingsOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

HTTP_COOKIE_FIELD_NUMBER

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

AbstractMessage.equals(Object other)

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

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public ConsistentHashLoadBalancerSettings.Builder toBuilder()

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException