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

Class Gateway

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

    • Method Detail

      • getAsPrepends

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

      • getAuthenticationKey

        public GatewayAuthenticationKey getAuthenticationKey()
        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

      • getBfdConfig

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

      • getBgpAsn

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

      • getBgpBaseCidr

        public String getBgpBaseCidr()
        Gets the bgpBaseCidr. (DEPRECATED) BGP base CIDR is deprecated and no longer recognized by the Direct Link APIs. See bgp_cer_cidr and bgp_ibm_cidr fields instead for IP related information. Deprecated field bgp_base_cidr will be removed from the API specificiation after 15-MAR-2021.
        Returns:
        the bgpBaseCidr

      • getBgpCerCidr

        public String getBgpCerCidr()
        Gets the bgpCerCidr. BGP customer edge router CIDR.
        Returns:
        the bgpCerCidr

      • getBgpIbmAsn

        public Long getBgpIbmAsn()
        Gets the bgpIbmAsn. IBM BGP ASN.
        Returns:
        the bgpIbmAsn

      • getBgpIbmCidr

        public String getBgpIbmCidr()
        Gets the bgpIbmCidr. BGP IBM CIDR.
        Returns:
        the bgpIbmCidr

      • getBgpStatus

        public String getBgpStatus()
        Gets the bgpStatus. Gateway BGP status. 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 bgpStatus

      • getBgpStatusUpdatedAt

        public Date getBgpStatusUpdatedAt()
        Gets the bgpStatusUpdatedAt. Date and time bgp status was updated.
        Returns:
        the bgpStatusUpdatedAt

      • getCarrierName

        public String getCarrierName()
        Gets the carrierName. Carrier name. Only set for type=dedicated gateways.
        Returns:
        the carrierName

      • getChangeRequest

        public GatewayChangeRequest getChangeRequest()
        Gets the changeRequest. Changes pending approval for provider managed Direct Link Connect gateways.
        Returns:
        the changeRequest

      • getCompletionNoticeRejectReason

        public String getCompletionNoticeRejectReason()
        Gets the completionNoticeRejectReason. Reason for completion notice rejection. Only included on type=dedicated gateways with a rejected completion notice.
        Returns:
        the completionNoticeRejectReason

      • getConnectionMode

        public String getConnectionMode()
        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

      • getCreatedAt

        public Date getCreatedAt()
        Gets the createdAt. The date and time resource was created.
        Returns:
        the createdAt

      • getCrn

        public String getCrn()
        Gets the crn. The CRN (Cloud Resource Name) of this gateway.
        Returns:
        the crn

      • isCrossAccount

        public Boolean isCrossAccount()
        Gets the crossAccount. Indicates whether this gateway is cross account gateway.
        Returns:
        the crossAccount

      • getCrossConnectRouter

        public String getCrossConnectRouter()
        Gets the crossConnectRouter. Cross connect router. Only included on type=dedicated gateways.
        Returns:
        the crossConnectRouter

      • getCustomerName

        public String getCustomerName()
        Gets the customerName. Customer name. Only set for type=dedicated gateways.
        Returns:
        the customerName

      • getDefaultExportRouteFilter

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

      • getDefaultImportRouteFilter

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

      • isGlobal

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

      • getId

        public String getId()
        Gets the id. The unique identifier of this gateway.
        Returns:
        the id

      • getLinkStatus

        public String getLinkStatus()
        Gets the linkStatus. Gateway link status. Only included on type=dedicated gateways. 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 linkStatus

      • getLinkStatusUpdatedAt

        public Date getLinkStatusUpdatedAt()
        Gets the linkStatusUpdatedAt. Date and time link status was updated.
        Returns:
        the linkStatusUpdatedAt

      • getLocationDisplayName

        public String getLocationDisplayName()
        Gets the locationDisplayName. Gateway location long name.
        Returns:
        the locationDisplayName

      • getLocationName

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

      • getMacsecConfig

        public GatewayMacsecConfig getMacsecConfig()
        Gets the macsecConfig. MACsec configuration information. For Dedicated Gateways with MACsec configured, return configuration information. Contact IBM support for access to MACsec.
        Returns:
        the macsecConfig

      • isMetered

        public Boolean isMetered()
        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

      • getName

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

      • getOperationalStatus

        public String getOperationalStatus()
        Gets the operationalStatus. Gateway operational status. 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 operationalStatus

      • getPort

        public GatewayPort getPort()
        Gets the port. gateway port for type=connect gateways.
        Returns:
        the port

      • isProviderApiManaged

        public Boolean isProviderApiManaged()
        Gets the providerApiManaged. Indicates whether gateway changes must be made via a provider portal.
        Returns:
        the providerApiManaged

      • getResourceGroup

        public ResourceGroupReference getResourceGroup()
        Gets the resourceGroup. Resource group reference.
        Returns:
        the resourceGroup

      • getSpeedMbps

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

      • getPatchPanelCompletionNotice

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

      • getType

        public String getType()
        Gets the type. Offering type. 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 type

      • getVlan

        public Long getVlan()
        Gets the vlan. VLAN configured for this gateway. If there is no vlan configured for the gateway, the vlan will be absent. This property will also be absent if this gateway's `crn` is in another account.
        Returns:
        the vlan