Interface BackendServiceConnectionTrackingPolicyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
BackendServiceConnectionTrackingPolicy, BackendServiceConnectionTrackingPolicy.Builder

@Generated public interface BackendServiceConnectionTrackingPolicyOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Summary

    Modifier and Type
    Method
    Description
    Specifies connection persistence when backends are unhealthy.
    com.google.protobuf.ByteString
    Specifies connection persistence when backends are unhealthy.
    boolean
    Enable Strong Session Affinity for external passthrough Network Load Balancers.
    int
    Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds).
    Specifies the key used for connection tracking.
    com.google.protobuf.ByteString
    Specifies the key used for connection tracking.
    boolean
    Specifies connection persistence when backends are unhealthy.
    boolean
    Enable Strong Session Affinity for external passthrough Network Load Balancers.
    boolean
    Specifies how long to keep a Connection Tracking entry while there is no matching traffic (in seconds).
    boolean
    Specifies the key used for connection tracking.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Method Details

    • hasConnectionPersistenceOnUnhealthyBackends

      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 isPER_CONNECTION (default tracking mode) or the Session
       Affinity is configured for 5-tuple. They do not persist forUDP.
      
       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).
       Check the ConnectionPersistenceOnUnhealthyBackends enum for the list of possible values.
       
      optional string connection_persistence_on_unhealthy_backends = 152439033;
      Returns:
      Whether the connectionPersistenceOnUnhealthyBackends field is set.
    • getConnectionPersistenceOnUnhealthyBackends

      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 isPER_CONNECTION (default tracking mode) or the Session
       Affinity is configured for 5-tuple. They do not persist forUDP.
      
       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).
       Check the ConnectionPersistenceOnUnhealthyBackends enum for the list of possible values.
       
      optional string connection_persistence_on_unhealthy_backends = 152439033;
      Returns:
      The connectionPersistenceOnUnhealthyBackends.
    • getConnectionPersistenceOnUnhealthyBackendsBytes

      com.google.protobuf.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 isPER_CONNECTION (default tracking mode) or the Session
       Affinity is configured for 5-tuple. They do not persist forUDP.
      
       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).
       Check the ConnectionPersistenceOnUnhealthyBackends enum for the list of possible values.
       
      optional string connection_persistence_on_unhealthy_backends = 152439033;
      Returns:
      The bytes for connectionPersistenceOnUnhealthyBackends.
    • hasEnableStrongAffinity

      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:
      Whether the enableStrongAffinity field is set.
    • getEnableStrongAffinity

      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:
      The enableStrongAffinity.
    • hasIdleTimeoutSec

      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:
      Whether the idleTimeoutSec field is set.
    • getIdleTimeoutSec

      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:
      The idleTimeoutSec.
    • hasTrackingMode

      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](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).
       Check the TrackingMode enum for the list of possible values.
       
      optional string tracking_mode = 127757867;
      Returns:
      Whether the trackingMode field is set.
    • getTrackingMode

      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](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).
       Check the TrackingMode enum for the list of possible values.
       
      optional string tracking_mode = 127757867;
      Returns:
      The trackingMode.
    • getTrackingModeBytes

      com.google.protobuf.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](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).
       Check the TrackingMode enum for the list of possible values.
       
      optional string tracking_mode = 127757867;
      Returns:
      The bytes for trackingMode.