- 1.54.0 (latest)
- 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 BackendServiceConnectionTrackingPolicy.Builder extends GeneratedMessageV3.Builder<BackendServiceConnectionTrackingPolicy.Builder> implements BackendServiceConnectionTrackingPolicyOrBuilderConnection Tracking configuration for this BackendService.
Protobuf type google.cloud.compute.v1.BackendServiceConnectionTrackingPolicy
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > BackendServiceConnectionTrackingPolicy.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public BackendServiceConnectionTrackingPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
|
build()
public BackendServiceConnectionTrackingPolicy build()| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy |
|
buildPartial()
public BackendServiceConnectionTrackingPolicy buildPartial()| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy |
|
clear()
public BackendServiceConnectionTrackingPolicy.Builder clear()| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
|
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 | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
This builder for chaining. |
clearEnableStrongAffinity()
public BackendServiceConnectionTrackingPolicy.Builder clearEnableStrongAffinity()Enable Strong Session Affinity for external passthrough Network Load Balancers. This option is not available publicly.
optional bool enable_strong_affinity = 24539924;
| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public BackendServiceConnectionTrackingPolicy.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
|
clearIdleTimeoutSec()
public BackendServiceConnectionTrackingPolicy.Builder clearIdleTimeoutSec()Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds). For internal passthrough Network Load Balancers: - 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 external passthrough Network Load Balancers the default is 60 seconds. This option is not available publicly.
optional int32 idle_timeout_sec = 24977544;
| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public BackendServiceConnectionTrackingPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
|
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 | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
This builder for chaining. |
clone()
public BackendServiceConnectionTrackingPolicy.Builder clone()| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for connectionPersistenceOnUnhealthyBackends. |
getDefaultInstanceForType()
public BackendServiceConnectionTrackingPolicy getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getEnableStrongAffinity()
public boolean getEnableStrongAffinity()Enable Strong Session Affinity for external passthrough Network Load Balancers. This option is not available publicly.
optional bool enable_strong_affinity = 24539924;
| Returns | |
|---|---|
| Type | Description |
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 passthrough Network Load Balancers: - 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 external passthrough Network Load Balancers the default is 60 seconds. This option is not available publicly.
optional int32 idle_timeout_sec = 24977544;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
Whether the connectionPersistenceOnUnhealthyBackends field is set. |
hasEnableStrongAffinity()
public boolean hasEnableStrongAffinity()Enable Strong Session Affinity for external passthrough Network Load Balancers. This option is not available publicly.
optional bool enable_strong_affinity = 24539924;
| Returns | |
|---|---|
| Type | Description |
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 passthrough Network Load Balancers: - 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 external passthrough Network Load Balancers the default is 60 seconds. This option is not available publicly.
optional int32 idle_timeout_sec = 24977544;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
Whether the trackingMode field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(BackendServiceConnectionTrackingPolicy other)
public BackendServiceConnectionTrackingPolicy.Builder mergeFrom(BackendServiceConnectionTrackingPolicy other)| Parameter | |
|---|---|
| Name | Description |
other |
BackendServiceConnectionTrackingPolicy |
| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public BackendServiceConnectionTrackingPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public BackendServiceConnectionTrackingPolicy.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final BackendServiceConnectionTrackingPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
StringThe connectionPersistenceOnUnhealthyBackends to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for connectionPersistenceOnUnhealthyBackends to set. |
| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
This builder for chaining. |
setEnableStrongAffinity(boolean value)
public BackendServiceConnectionTrackingPolicy.Builder setEnableStrongAffinity(boolean value)Enable Strong Session Affinity for external passthrough Network Load Balancers. This option is not available publicly.
optional bool enable_strong_affinity = 24539924;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe enableStrongAffinity to set. |
| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public BackendServiceConnectionTrackingPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
|
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 passthrough Network Load Balancers: - 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 external passthrough Network Load Balancers the default is 60 seconds. This option is not available publicly.
optional int32 idle_timeout_sec = 24977544;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe idleTimeoutSec to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
|
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 | |
|---|---|
| Name | Description |
value |
StringThe trackingMode to set. |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for trackingMode to set. |
| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final BackendServiceConnectionTrackingPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
BackendServiceConnectionTrackingPolicy.Builder |
|