Enum Class ConnectionPurpose

java.lang.Object
java.lang.Enum<ConnectionPurpose>
com.eqixiac.equinix.design.optimizer.wizard.enums.ConnectionPurpose
All Implemented Interfaces:
Serializable, Comparable<ConnectionPurpose>, Constable

public enum ConnectionPurpose extends Enum<ConnectionPurpose>
Classifies the purpose of a planned connection within a deployment plan. The purpose decides which endpoint fields of a PlannedConnection are meaningful, how the connection body is assembled, and its provisioning phase (provider connections before backbone links).
  • Enum Constant Details

    • PROVIDER

      public static final ConnectionPurpose PROVIDER
      A connection from a Cloud Router to a cloud/service provider's service profile (Cloud Router A-side, service-profile Z-side). Requires the customer's cloud authorization key and VLAN tag at provisioning.
    • BACKBONE

      public static final ConnectionPurpose BACKBONE
      An inter-metro connection between two Cloud Routers (Cloud Router on both sides), generated from the plan's BackboneTopology. Needs no cloud authorization key.
    • DEVICE

      public static final ConnectionPurpose DEVICE
      A connection from a Cloud Router to an on-premises or Network Edge device. Reserved for device-side planning; the wizard does not currently generate these.
  • Method Details

    • values

      public static ConnectionPurpose[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static ConnectionPurpose valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null