Class VPNGatewayConnectionPatch

java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.cloud.is.vpc.v1.model.VPNGatewayConnectionPatch
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel
public class VPNGatewayConnectionPatch extends com.ibm.cloud.sdk.core.service.model.GenericModel
VPNGatewayConnectionPatch.

  • Method Details

    • newBuilder

      public VPNGatewayConnectionPatch.Builder newBuilder()
      New builder.
      Returns:
      a VPNGatewayConnectionPatch builder

    • adminStateUp

      public Boolean adminStateUp()
      Gets the adminStateUp. If set to false, the VPN gateway connection is shut down.
      Returns:
      the adminStateUp

    • deadPeerDetection

      public VPNGatewayConnectionDPDPatch deadPeerDetection()
      Gets the deadPeerDetection. The Dead Peer Detection settings.
      Returns:
      the deadPeerDetection

    • distributeTraffic

      public Boolean distributeTraffic()
      Gets the distributeTraffic. Indicates whether the traffic is distributed between the `up` tunnels of the VPN gateway connection when the VPC route's next hop is a VPN connection. If `false`, the traffic is only routed through the `up` tunnel with the lower `public_ip` address. Before enabling it on VPN connections to on-prem private networks, review [distributing traffic restrictions](https://cloud.ibm.com/docs/vpc?topic=vpc-vpn-limitations#distributing-traffic-restrictions). If specified, `mode` must be `route`.
      Returns:
      the distributeTraffic

    • establishMode

      public String establishMode()
      Gets the establishMode. The establish mode of the VPN gateway connection: - `bidirectional`: Either side of the VPN gateway can initiate IKE protocol negotiations or rekeying processes. - `peer_only`: Only the peer can initiate IKE protocol negotiations for this VPN gateway connection. Additionally, the peer is responsible for initiating the rekeying process after the connection is established. If rekeying does not occur, the VPN gateway connection will be brought down after its lifetime expires.
      Returns:
      the establishMode

    • ikePolicy

      public VPNGatewayConnectionIKEPolicyPatch ikePolicy()
      Gets the ikePolicy. The IKE policy to use. Specify `null` to remove any existing policy, [resulting in auto-negotiation](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ike-auto-negotiation-phase-1).
      Returns:
      the ikePolicy

    • ipsecPolicy

      public VPNGatewayConnectionIPsecPolicyPatch ipsecPolicy()
      Gets the ipsecPolicy. The IPsec policy to use. Specify `null` to remove any existing policy, [resulting in auto-negotiation](https://cloud.ibm.com/docs/vpc?topic=vpc-using-vpn&interface=ui#ipsec-auto-negotiation-phase-2).
      Returns:
      the ipsecPolicy

    • name

      public String name()
      Gets the name. The name for this VPN gateway connection. The name must not be used by another connection for the VPN gateway.
      Returns:
      the name

    • peer

      public VPNGatewayConnectionPeerPatch peer()
      Gets the peer.
      Returns:
      the peer

    • psk

      public String psk()
      Gets the psk. The pre-shared key.
      Returns:
      the psk

    • asPatch

      public Map<String,Object> asPatch()
      Construct a JSON merge-patch from the VPNGatewayConnectionPatch. Note that properties of the VPNGatewayConnectionPatch with null values are not represented in the constructed JSON merge-patch object, but can be explicitly set afterward to signify a property delete.
      Returns:
      a JSON merge-patch for the VPNGatewayConnectionPatch