Class BackendServiceConnectionTrackingPolicy.Builder (1.26.0)

public static final class BackendServiceConnectionTrackingPolicy.Builder extends GeneratedMessageV3.Builder<BackendServiceConnectionTrackingPolicy.Builder> implements BackendServiceConnectionTrackingPolicyOrBuilder

Connection Tracking configuration for this BackendService.

Protobuf type google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BackendServiceConnectionTrackingPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder
Overrides

build()

public BackendServiceConnectionTrackingPolicy build()
Returns
TypeDescription
BackendServiceConnectionTrackingPolicy

buildPartial()

public BackendServiceConnectionTrackingPolicy buildPartial()
Returns
TypeDescription
BackendServiceConnectionTrackingPolicy

clear()

public BackendServiceConnectionTrackingPolicy.Builder clear()
Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder
Overrides

clearConnectionPersistenceOnUnhealthyBackends()

public BackendServiceConnectionTrackingPolicy.Builder clearConnectionPersistenceOnUnhealthyBackends()

Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing. Check the ConnectionPersistenceOnUnhealthyBackends enum for the list of possible values.

optional string connection_persistence_on_unhealthy_backends = 152439033;

Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder

This builder for chaining.

clearEnableStrongAffinity()

public BackendServiceConnectionTrackingPolicy.Builder clearEnableStrongAffinity()

Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.

optional bool enable_strong_affinity = 24539924;

Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BackendServiceConnectionTrackingPolicy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder
Overrides

clearIdleTimeoutSec()

public BackendServiceConnectionTrackingPolicy.Builder clearIdleTimeoutSec()

Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.

optional int32 idle_timeout_sec = 24977544;

Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BackendServiceConnectionTrackingPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder
Overrides

clearTrackingMode()

public BackendServiceConnectionTrackingPolicy.Builder clearTrackingMode()

Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing. Check the TrackingMode enum for the list of possible values.

optional string tracking_mode = 127757867;

Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder

This builder for chaining.

clone()

public BackendServiceConnectionTrackingPolicy.Builder clone()
Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder
Overrides

getConnectionPersistenceOnUnhealthyBackends()

public String getConnectionPersistenceOnUnhealthyBackends()

Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing. Check the ConnectionPersistenceOnUnhealthyBackends enum for the list of possible values.

optional string connection_persistence_on_unhealthy_backends = 152439033;

Returns
TypeDescription
String

The connectionPersistenceOnUnhealthyBackends.

getConnectionPersistenceOnUnhealthyBackendsBytes()

public ByteString getConnectionPersistenceOnUnhealthyBackendsBytes()

Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing. Check the ConnectionPersistenceOnUnhealthyBackends enum for the list of possible values.

optional string connection_persistence_on_unhealthy_backends = 152439033;

Returns
TypeDescription
ByteString

The bytes for connectionPersistenceOnUnhealthyBackends.

getDefaultInstanceForType()

public BackendServiceConnectionTrackingPolicy getDefaultInstanceForType()
Returns
TypeDescription
BackendServiceConnectionTrackingPolicy

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEnableStrongAffinity()

public boolean getEnableStrongAffinity()

Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.

optional bool enable_strong_affinity = 24539924;

Returns
TypeDescription
boolean

The enableStrongAffinity.

getIdleTimeoutSec()

public int getIdleTimeoutSec()

Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.

optional int32 idle_timeout_sec = 24977544;

Returns
TypeDescription
int

The idleTimeoutSec.

getTrackingMode()

public String getTrackingMode()

Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing. Check the TrackingMode enum for the list of possible values.

optional string tracking_mode = 127757867;

Returns
TypeDescription
String

The trackingMode.

getTrackingModeBytes()

public ByteString getTrackingModeBytes()

Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing. Check the TrackingMode enum for the list of possible values.

optional string tracking_mode = 127757867;

Returns
TypeDescription
ByteString

The bytes for trackingMode.

hasConnectionPersistenceOnUnhealthyBackends()

public boolean hasConnectionPersistenceOnUnhealthyBackends()

Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing. Check the ConnectionPersistenceOnUnhealthyBackends enum for the list of possible values.

optional string connection_persistence_on_unhealthy_backends = 152439033;

Returns
TypeDescription
boolean

Whether the connectionPersistenceOnUnhealthyBackends field is set.

hasEnableStrongAffinity()

public boolean hasEnableStrongAffinity()

Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.

optional bool enable_strong_affinity = 24539924;

Returns
TypeDescription
boolean

Whether the enableStrongAffinity field is set.

hasIdleTimeoutSec()

public boolean hasIdleTimeoutSec()

Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.

optional int32 idle_timeout_sec = 24977544;

Returns
TypeDescription
boolean

Whether the idleTimeoutSec field is set.

hasTrackingMode()

public boolean hasTrackingMode()

Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing. Check the TrackingMode enum for the list of possible values.

optional string tracking_mode = 127757867;

Returns
TypeDescription
boolean

Whether the trackingMode field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(BackendServiceConnectionTrackingPolicy other)

public BackendServiceConnectionTrackingPolicy.Builder mergeFrom(BackendServiceConnectionTrackingPolicy other)
Parameter
NameDescription
otherBackendServiceConnectionTrackingPolicy
Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BackendServiceConnectionTrackingPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public BackendServiceConnectionTrackingPolicy.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BackendServiceConnectionTrackingPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder
Overrides

setConnectionPersistenceOnUnhealthyBackends(String value)

public BackendServiceConnectionTrackingPolicy.Builder setConnectionPersistenceOnUnhealthyBackends(String value)

Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing. Check the ConnectionPersistenceOnUnhealthyBackends enum for the list of possible values.

optional string connection_persistence_on_unhealthy_backends = 152439033;

Parameter
NameDescription
valueString

The connectionPersistenceOnUnhealthyBackends to set.

Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder

This builder for chaining.

setConnectionPersistenceOnUnhealthyBackendsBytes(ByteString value)

public BackendServiceConnectionTrackingPolicy.Builder setConnectionPersistenceOnUnhealthyBackendsBytes(ByteString value)

Specifies connection persistence when backends are unhealthy. The default value is DEFAULT_FOR_PROTOCOL. If set to DEFAULT_FOR_PROTOCOL, the existing connections persist on unhealthy backends only for connection-oriented protocols (TCP and SCTP) and only if the Tracking Mode is PER_CONNECTION (default tracking mode) or the Session Affinity is configured for 5-tuple. They do not persist for UDP. If set to NEVER_PERSIST, after a backend becomes unhealthy, the existing connections on the unhealthy backend are never persisted on the unhealthy backend. They are always diverted to newly selected healthy backends (unless all backends are unhealthy). If set to ALWAYS_PERSIST, existing connections always persist on unhealthy backends regardless of protocol and session affinity. It is generally not recommended to use this mode overriding the default. For more details, see Connection Persistence for Network Load Balancing and Connection Persistence for Internal TCP/UDP Load Balancing. Check the ConnectionPersistenceOnUnhealthyBackends enum for the list of possible values.

optional string connection_persistence_on_unhealthy_backends = 152439033;

Parameter
NameDescription
valueByteString

The bytes for connectionPersistenceOnUnhealthyBackends to set.

Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder

This builder for chaining.

setEnableStrongAffinity(boolean value)

public BackendServiceConnectionTrackingPolicy.Builder setEnableStrongAffinity(boolean value)

Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly.

optional bool enable_strong_affinity = 24539924;

Parameter
NameDescription
valueboolean

The enableStrongAffinity to set.

Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BackendServiceConnectionTrackingPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder
Overrides

setIdleTimeoutSec(int value)

public BackendServiceConnectionTrackingPolicy.Builder setIdleTimeoutSec(int value)

Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For Internal TCP/UDP Load Balancing: - The minimum (default) is 10 minutes and the maximum is 16 hours. - It can be set only if Connection Tracking is less than 5-tuple (i.e. Session Affinity is CLIENT_IP_NO_DESTINATION, CLIENT_IP or CLIENT_IP_PROTO, and Tracking Mode is PER_SESSION). For Network Load Balancer the default is 60 seconds. This option is not available publicly.

optional int32 idle_timeout_sec = 24977544;

Parameter
NameDescription
valueint

The idleTimeoutSec to set.

Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder

This builder for chaining.

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

public BackendServiceConnectionTrackingPolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder
Overrides

setTrackingMode(String value)

public BackendServiceConnectionTrackingPolicy.Builder setTrackingMode(String value)

Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing. Check the TrackingMode enum for the list of possible values.

optional string tracking_mode = 127757867;

Parameter
NameDescription
valueString

The trackingMode to set.

Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder

This builder for chaining.

setTrackingModeBytes(ByteString value)

public BackendServiceConnectionTrackingPolicy.Builder setTrackingModeBytes(ByteString value)

Specifies the key used for connection tracking. There are two options: - PER_CONNECTION: This is the default mode. The Connection Tracking is performed as per the Connection Key (default Hash Method) for the specific protocol. - PER_SESSION: The Connection Tracking is performed as per the configured Session Affinity. It matches the configured Session Affinity. For more details, see Tracking Mode for Network Load Balancing and Tracking Mode for Internal TCP/UDP Load Balancing. Check the TrackingMode enum for the list of possible values.

optional string tracking_mode = 127757867;

Parameter
NameDescription
valueByteString

The bytes for trackingMode to set.

Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BackendServiceConnectionTrackingPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BackendServiceConnectionTrackingPolicy.Builder
Overrides