Class BackendSet.Builder

  • Enclosing class:
    BackendSet

    public static class BackendSet.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • name

        public BackendSet.Builder name​(String name)
        A user-friendly name for the backend set that must be unique and cannot be changed.

        Valid backend set names include only alphanumeric characters, dashes, and underscores. Backend set names cannot contain spaces. Avoid entering confidential information.

        Example: example_backend_set

        Parameters:
        name - the value to set
        Returns:
        this builder
      • isPreserveSource

        public BackendSet.Builder isPreserveSource​(Boolean isPreserveSource)
        If this parameter is enabled, then the network load balancer preserves the source IP of the packet when it is forwarded to backends.

        Backends see the original source IP. If the isPreserveSourceDestination parameter is enabled for the network load balancer resource, then this parameter cannot be disabled. The value is true by default.

        Parameters:
        isPreserveSource - the value to set
        Returns:
        this builder
      • isFailOpen

        public BackendSet.Builder isFailOpen​(Boolean isFailOpen)
        If enabled, the network load balancer will continue to distribute traffic in the configured distribution in the event all backends are unhealthy.

        The value is false by default.

        Parameters:
        isFailOpen - the value to set
        Returns:
        this builder
      • isInstantFailoverEnabled

        public BackendSet.Builder isInstantFailoverEnabled​(Boolean isInstantFailoverEnabled)
        If enabled existing connections will be forwarded to an alternative healthy backend as soon as current backend becomes unhealthy.
        Parameters:
        isInstantFailoverEnabled - the value to set
        Returns:
        this builder
      • isInstantFailoverTcpResetEnabled

        public BackendSet.Builder isInstantFailoverTcpResetEnabled​(Boolean isInstantFailoverTcpResetEnabled)
        This only applies when using instant failover.

        If enabled, the network load balancer will send TCP RST to clients when a backend becomes unhealthy and the traffic is moved to a healthy backend. If disabled, the network load balancer will not send TCP RST before moving traffic to a healthy backend. By default, TCP RST is enabled.

        Parameters:
        isInstantFailoverTcpResetEnabled - the value to set
        Returns:
        this builder
      • areOperationallyActiveBackendsPreferred

        public BackendSet.Builder areOperationallyActiveBackendsPreferred​(Boolean areOperationallyActiveBackendsPreferred)
        If enabled, NLB supports active-standby backends, with the initial standby being the configured backup backend.

        The standby backend becomes active and takes over serving traffic when the current active backend becomes unhealthy. The new active backend continues to serve the traffic while healthy even when the old active backend becomes healthy.

        Parameters:
        areOperationallyActiveBackendsPreferred - the value to set
        Returns:
        this builder
      • ipVersion

        public BackendSet.Builder ipVersion​(IpVersion ipVersion)
        IP version associated with the backend set.
        Parameters:
        ipVersion - the value to set
        Returns:
        this builder
      • backends

        public BackendSet.Builder backends​(List<Backend> backends)
        An array of backends.
        Parameters:
        backends - the value to set
        Returns:
        this builder