Class ConsistentHashLoadBalancerSettings.Builder (1.18.0)

Version 1.18.0

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 1.62.0
• 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 static final class ConsistentHashLoadBalancerSettings.Builder extends GeneratedMessageV3.Builder<ConsistentHashLoadBalancerSettings.Builder> implements ConsistentHashLoadBalancerSettingsOrBuilder

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

Protobuf type google.cloud.compute.v1.ConsistentHashLoadBalancerSettings

Inheritance

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

Implements

ConsistentHashLoadBalancerSettingsOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ConsistentHashLoadBalancerSettings.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ConsistentHashLoadBalancerSettings build()

Returns

Type	Description
ConsistentHashLoadBalancerSettings

buildPartial()

public ConsistentHashLoadBalancerSettings buildPartial()

Returns

Type	Description
ConsistentHashLoadBalancerSettings

clear()

public ConsistentHashLoadBalancerSettings.Builder clear()

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ConsistentHashLoadBalancerSettings.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearHttpCookie()

public ConsistentHashLoadBalancerSettings.Builder clearHttpCookie()

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

clearHttpHeaderName()

public ConsistentHashLoadBalancerSettings.Builder clearHttpHeaderName()

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
ConsistentHashLoadBalancerSettings.Builder	This builder for chaining.

clearMinimumRingSize()

public ConsistentHashLoadBalancerSettings.Builder clearMinimumRingSize()

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
ConsistentHashLoadBalancerSettings.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ConsistentHashLoadBalancerSettings.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public ConsistentHashLoadBalancerSettings.Builder clone()

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ConsistentHashLoadBalancerSettings getDefaultInstanceForType()

Returns

Type	Description
ConsistentHashLoadBalancerSettings

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

getHttpCookieBuilder()

public ConsistentHashLoadBalancerSettingsHttpCookie.Builder getHttpCookieBuilder()

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

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ConsistentHashLoadBalancerSettings other)

public ConsistentHashLoadBalancerSettings.Builder mergeFrom(ConsistentHashLoadBalancerSettings other)

Parameter

Name	Description
other	ConsistentHashLoadBalancerSettings

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ConsistentHashLoadBalancerSettings.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public ConsistentHashLoadBalancerSettings.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeHttpCookie(ConsistentHashLoadBalancerSettingsHttpCookie value)

public ConsistentHashLoadBalancerSettings.Builder mergeHttpCookie(ConsistentHashLoadBalancerSettingsHttpCookie value)

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;

Parameter

Name	Description
value	ConsistentHashLoadBalancerSettingsHttpCookie

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ConsistentHashLoadBalancerSettings.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public ConsistentHashLoadBalancerSettings.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setHttpCookie(ConsistentHashLoadBalancerSettingsHttpCookie value)

public ConsistentHashLoadBalancerSettings.Builder setHttpCookie(ConsistentHashLoadBalancerSettingsHttpCookie value)

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;

Parameter

Name	Description
value	ConsistentHashLoadBalancerSettingsHttpCookie

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder

setHttpCookie(ConsistentHashLoadBalancerSettingsHttpCookie.Builder builderForValue)

public ConsistentHashLoadBalancerSettings.Builder setHttpCookie(ConsistentHashLoadBalancerSettingsHttpCookie.Builder builderForValue)

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;

Parameter

Name	Description
builderForValue	ConsistentHashLoadBalancerSettingsHttpCookie.Builder

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder

setHttpHeaderName(String value)

public ConsistentHashLoadBalancerSettings.Builder setHttpHeaderName(String value)

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;

Parameter

Name	Description
value	String The httpHeaderName to set.

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder	This builder for chaining.

setHttpHeaderNameBytes(ByteString value)

public ConsistentHashLoadBalancerSettings.Builder setHttpHeaderNameBytes(ByteString value)

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;

Parameter

Name	Description
value	ByteString The bytes for httpHeaderName to set.

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder	This builder for chaining.

setMinimumRingSize(long value)

public ConsistentHashLoadBalancerSettings.Builder setMinimumRingSize(long value)

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;

Parameter

Name	Description
value	long The minimumRingSize to set.

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ConsistentHashLoadBalancerSettings.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ConsistentHashLoadBalancerSettings.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
ConsistentHashLoadBalancerSettings.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)