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

Class GatewayTemplate

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    Direct Known Subclasses:
    GatewayTemplateGatewayTypeConnectTemplate, GatewayTemplateGatewayTypeDedicatedTemplate
    public class GatewayTemplate
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    Create gateway template. Classes which extend this class: - GatewayTemplateGatewayTypeDedicatedTemplate - GatewayTemplateGatewayTypeConnectTemplate

    • Method Detail

      • asPrepends

        public List<AsPrependTemplate> asPrepends()
        Gets the asPrepends. array of AS Prepend configuration information.
        Returns:
        the asPrepends

      • authenticationKey

        public GatewayTemplateAuthenticationKey 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 GatewayBfdConfigTemplate bfdConfig()
        Gets the bfdConfig. BFD configuration information.
        Returns:
        the bfdConfig

      • bgpAsn

        public Long bgpAsn()
        Gets the bgpAsn. BGP ASN.
        Returns:
        the bgpAsn

      • bgpBaseCidr

        public String bgpBaseCidr()
        Gets the bgpBaseCidr. (DEPRECATED) BGP base CIDR. Field is deprecated. See bgp_ibm_cidr and bgp_cer_cidr for details on how to create a gateway using either automatic or explicit IP assignment. Any bgp_base_cidr value set will be ignored. Deprecated field bgp_base_cidr will be removed from the API specificiation after 15-MAR-2021.
        Returns:
        the bgpBaseCidr

      • bgpCerCidr

        public String bgpCerCidr()
        Gets the bgpCerCidr. BGP customer edge router CIDR. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr. For explicit IP assignment set 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. For auto IP assignment, omit bgp_cer_cidr and bgp_ibm_cidr. IBM will automatically select values for bgp_cer_cidr and bgp_ibm_cidr. For explicit IP assignment set 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

      • exportRouteFilters

        public List<GatewayTemplateRouteFilter> exportRouteFilters()
        Gets the exportRouteFilters. Array of directional route filters for a Direct Link gateway. When creating a gateway or replacing existing route filters, the order of the items in the array will set the ordering of the list of route filters.
        Returns:
        the exportRouteFilters

      • global

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

      • importRouteFilters

        public List<GatewayTemplateRouteFilter> importRouteFilters()
        Gets the importRouteFilters. Array of directional route filters for a Direct Link gateway. When creating a gateway or replacing existing route filters, the order of the items in the array will set the ordering of the list of route filters.
        Returns:
        the importRouteFilters

      • 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

      • patchPanelCompletionNotice

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

      • resourceGroup

        public ResourceGroupIdentity resourceGroup()
        Gets the resourceGroup. Resource group for this resource. If unspecified, the account's [default resource group](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used.
        Returns:
        the resourceGroup

      • speedMbps

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

      • type

        public String type()
        Gets the type. Offering type.
        Returns:
        the type

      • carrierName

        public String carrierName()
        Gets the carrierName. Carrier name.
        Returns:
        the carrierName

      • crossConnectRouter

        public String crossConnectRouter()
        Gets the crossConnectRouter. Cross connect router.
        Returns:
        the crossConnectRouter

      • customerName

        public String customerName()
        Gets the customerName. Customer name.
        Returns:
        the customerName

      • locationName

        public String locationName()
        Gets the locationName. Gateway location.
        Returns:
        the locationName

      • macsecConfig

        public GatewayMacsecConfigTemplate macsecConfig()
        Gets the macsecConfig. MACsec configuration information. Contact IBM support for access to MACsec.
        Returns:
        the macsecConfig

      • vlan

        public Long vlan()
        Gets the vlan. The VLAN to configure for this gateway.
        Returns:
        the vlan

      • port

        public GatewayPortIdentity port()
        Gets the port. Select Port Label for new type=connect gateway.
        Returns:
        the port