Package com.ibm.cloud.networking.direct_link.v1.model

Class GatewayPatchTemplate

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class GatewayPatchTemplate
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    patch gateway template.

    • Method Detail

      • authenticationKey

        public GatewayPatchTemplateAuthenticationKey authenticationKey()
        Gets the authenticationKey. The identity of the standard key to use for BGP MD5 authentication key. The key material that you provide must be base64 encoded and original string must be maximum 126 ASCII characters in length. To clear the optional `authentication_key` field patch its crn to `""`.
        Returns:
        the authenticationKey

      • bfdConfig

        public GatewayBfdPatchTemplate bfdConfig()
        Gets the bfdConfig. BFD configuration information.
        Returns:
        the bfdConfig

      • bgpAsn

        public Long bgpAsn()
        Gets the bgpAsn. The autonomous system number (ASN) of Border Gateway Protocol (BGP) configuration for the IBM side of the DL 2.0 gateway.
        Returns:
        the bgpAsn

      • bgpCerCidr

        public String bgpCerCidr()
        Gets the bgpCerCidr. BGP customer edge router CIDR is the new CIDR (Classless Inter-Domain Routing) value to be updated on customer edge router for the DL 2.0 gateway. Customer edge IP and IBM IP should be in the same network. Updating customer edge router CIDR should be accompanied with IBM CIDR in the request. Update customer edge router IP to a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the value must reside in one of "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16", "169.254.0.0/16" or an owned public CIDR. bgp_cer_cidr and bgp_ibm_cidr must have matching network and subnet mask values.
        Returns:
        the bgpCerCidr

      • bgpIbmCidr

        public String bgpIbmCidr()
        Gets the bgpIbmCidr. BGP IBM CIDR is the new CIDR (Classless Inter-Domain Routing) value to be updated on IBM edge router for the DL 2.0 gateway. IBM IP and customer edge IP should be in the same network. Updating IBM CIDR should be accompanied with customer edge router CIDR in the request. Update IBM CIDR to a valid bgp_cer_cidr and bgp_ibm_cidr CIDR, the value must reside in one of "10.254.0.0/16", "172.16.0.0/12", "192.168.0.0/16", "169.254.0.0/16" or an owned public CIDR. bgp_cer_cidr and bgp_ibm_cidr must have matching network and subnet mask values.
        Returns:
        the bgpIbmCidr

      • connectionMode

        public String connectionMode()
        Gets the connectionMode. Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection. The list of enumerated values for this property may expand in the future. Code and processes using this field must tolerate unexpected values.
        Returns:
        the connectionMode

      • defaultExportRouteFilter

        public String defaultExportRouteFilter()
        Gets the defaultExportRouteFilter. The default directional route filter action that applies to routes that do not match any directional route filters.
        Returns:
        the defaultExportRouteFilter

      • defaultImportRouteFilter

        public String defaultImportRouteFilter()
        Gets the defaultImportRouteFilter. The default directional route filter action that applies to routes that do not match any directional route filters.
        Returns:
        the defaultImportRouteFilter

      • global

        public Boolean global()
        Gets the global. Gateways with global routing (`true`) can connect to networks outside of their associated region.
        Returns:
        the global

      • loaRejectReason

        public String loaRejectReason()
        Gets the loaRejectReason. Use this field during LOA rejection to provide the reason for the rejection. Only allowed for type=dedicated gateways.
        Returns:
        the loaRejectReason

      • macsecConfig

        public GatewayMacsecConfigPatchTemplate macsecConfig()
        Gets the macsecConfig. MACsec configuration information. When patching any macsec_config fields, no other fields may be specified in the patch request. Contact IBM support for access to MACsec. A MACsec config cannot be added to a gateway created without MACsec.
        Returns:
        the macsecConfig

      • metered

        public Boolean metered()
        Gets the metered. Metered billing option. When `true` gateway usage is billed per gigabyte. When `false` there is no per gigabyte usage charge, instead a flat rate is charged for the gateway.
        Returns:
        the metered

      • name

        public String name()
        Gets the name. The unique user-defined name for this gateway.
        Returns:
        the name

      • operationalStatus

        public String operationalStatus()
        Gets the operationalStatus. Gateway operational status. For gateways pending LOA approval, patch operational_status to the appropriate value to approve or reject its LOA. When rejecting an LOA, provide reject reasoning in `loa_reject_reason`. Only allowed for type=dedicated gateways.
        Returns:
        the operationalStatus

      • patchPanelCompletionNotice

        public String patchPanelCompletionNotice()
        Gets the patchPanelCompletionNotice. Gateway patch panel complete notification from implementation team.
        Returns:
        the patchPanelCompletionNotice

      • speedMbps

        public Long speedMbps()
        Gets the speedMbps. Gateway speed in megabits per second.
        Returns:
        the speedMbps

      • vlan

        public Long vlan()
        Gets the vlan. The VLAN to configure for this gateway. Specify `null` to remove an existing VLAN configuration. The gateway must have a `type` of `dedicated`.
        Returns:
        the vlan

      • asPatch

        public Map<String,​Object> asPatch()
        Construct a JSON merge-patch from the GatewayPatchTemplate. Note that properties of the GatewayPatchTemplate 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 GatewayPatchTemplate