Package com.oracle.bmc.networkloadbalancer.model

Class Backend.Builder

  • Enclosing class:
    Backend
    public static class Backend.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • name

        public Backend.Builder name​(String name)
        A read-only field showing the IP address/IP OCID and port that uniquely identify this backend server in the backend set.

        Example: 10.0.0.3:8080, or ocid1.privateip..oc1.<unique_ID>:443 or 10.0.0.3:0

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

      • ipAddress

        public Backend.Builder ipAddress​(String ipAddress)
        The IP address of the backend server.

        Example: 10.0.0.3

        Parameters:
        ipAddress - the value to set
        Returns:
        this builder

      • targetId

        public Backend.Builder targetId​(String targetId)
        The IP OCID/Instance OCID associated with the backend server.

        Example: ocid1.privateip..oc1.<unique_ID>

        Parameters:
        targetId - the value to set
        Returns:
        this builder

      • port

        public Backend.Builder port​(Integer port)
        The communication port for the backend server.

        Example: 8080

        Parameters:
        port - the value to set
        Returns:
        this builder

      • weight

        public Backend.Builder weight​(Integer weight)
        The network load balancing policy weight assigned to the server.

        Backend servers with a higher weight receive a larger proportion of incoming traffic. For example, a server weighted ‘3’ receives three times the number of new connections as a server weighted ‘1’. For more information about network load balancing policies, see Network Load Balancer Policies.

        Example: 3

        Parameters:
        weight - the value to set
        Returns:
        this builder

      • isDrain

        public Backend.Builder isDrain​(Boolean isDrain)
        Whether the network load balancer should drain this server.

        Servers marked “isDrain” receive no incoming traffic.

        Example: false

        Parameters:
        isDrain - the value to set
        Returns:
        this builder

      • isBackup

        public Backend.Builder isBackup​(Boolean isBackup)
        Whether the network load balancer should treat this server as a backup unit.

        If true, then the network load balancer forwards no ingress traffic to this backend server unless all other backend servers not marked as “isBackup” fail the health check policy.

        Example: false

        Parameters:
        isBackup - the value to set
        Returns:
        this builder

      • isOffline

        public Backend.Builder isOffline​(Boolean isOffline)
        Whether the network load balancer should treat this server as offline.

        Offline servers receive no incoming traffic.

        Example: false

        Parameters:
        isOffline - the value to set
        Returns:
        this builder