Class BackendServiceConnectionTrackingPolicy (1.6.0)

Version 1.6.0

• 1.18.0 (latest)
• 1.17.0
• 1.16.1
• 1.15.0
• 1.14.1
• 1.13.0
• 1.12.1
• 1.11.0
• 1.10.1
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.2
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.0
• 1.0.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.1
• 0.1.0

BackendServiceConnectionTrackingPolicy(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

Connection Tracking configuration for this BackendService.

Attributes

Name	Description
connection_persistence_on_unhealthy_backends	str 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
enable_strong_affinity	bool Enable Strong Session Affinity for Network Load Balancing. This option is not available publicly. This field is a member of `oneof`_ ``_enable_strong_affinity``.
idle_timeout_sec	int 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. This field is a member of `oneof`_ ``_idle_timeout_sec``.
tracking_mode	str 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

Inheritance

builtins.object > proto.message.Message > BackendServiceConnectionTrackingPolicy

Classes

ConnectionPersistenceOnUnhealthyBackends

ConnectionPersistenceOnUnhealthyBackends(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 <https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#connection-persistence> and Connection Persistence for Internal TCP/UDP Load Balancing <https://cloud.google.com/load-balancing/docs/internal#connection-persistence>.

TrackingMode

TrackingMode(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 <https://cloud.google.com/load-balancing/docs/network/networklb-backend-service#tracking-mode> and Tracking Mode for Internal TCP/UDP Load Balancing <https://cloud.google.com/load-balancing/docs/internal#tracking-mode>.