Package com.ibm.cloud.is.vpc.v1.model

Class VPNGateway

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    Direct Known Subclasses:
    VPNGatewayPolicyMode, VPNGatewayRouteMode
    public class VPNGateway
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    VPNGateway. Classes which extend this class: - VPNGatewayRouteMode - VPNGatewayPolicyMode

    • Method Detail

      • getCreatedAt

        public Date getCreatedAt()
        Gets the createdAt. The date and time that this VPN gateway was created.
        Returns:
        the createdAt

      • getCrn

        public String getCrn()
        Gets the crn. The VPN gateway's CRN.
        Returns:
        the crn

      • getHealthReasons

        public List<VPNGatewayHealthReason> getHealthReasons()
        Gets the healthReasons. The reasons for the current VPN gateway health_state (if any): - `cannot_create_vpc_route`: VPN cannot create route (check for conflict) - `cannot_reserve_ip_address`: IP address exhaustion (release addresses on the VPN's subnet) - `internal_error`: Internal error (contact IBM support) The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.
        Returns:
        the healthReasons

      • getHealthState

        public String getHealthState()
        Gets the healthState. The health of this resource. - `ok`: No abnormal behavior detected - `degraded`: Experiencing compromised performance, capacity, or connectivity - `faulted`: Completely unreachable, inoperative, or otherwise entirely incapacitated - `inapplicable`: The health state does not apply because of the current lifecycle state. A resource with a lifecycle state of `failed` or `deleting` will have a health state of `inapplicable`. A `pending` resource may also have this state.
        Returns:
        the healthState

      • getHref

        public String getHref()
        Gets the href. The VPN gateway's canonical URL.
        Returns:
        the href

      • getId

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

      • getLifecycleReasons

        public List<VPNGatewayLifecycleReason> getLifecycleReasons()
        Gets the lifecycleReasons. The reasons for the current VPN gateway lifecycle_state (if any): - `resource_suspended_by_provider`: The resource has been suspended (contact IBM support) The enumerated reason code values for this property will expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the resource on which the unexpected reason code was encountered.
        Returns:
        the lifecycleReasons

      • getLifecycleState

        public String getLifecycleState()
        Gets the lifecycleState. The lifecycle state of the VPN gateway.
        Returns:
        the lifecycleState

      • getMembers

        public List<VPNGatewayMember> getMembers()
        Gets the members. Collection of VPN gateway members.
        Returns:
        the members

      • getName

        public String getName()
        Gets the name. The name for this VPN gateway. The name is unique across all VPN gateways in the VPC.
        Returns:
        the name

      • getResourceGroup

        public ResourceGroupReference getResourceGroup()
        Gets the resourceGroup. The resource group for this VPN gateway.
        Returns:
        the resourceGroup

      • getResourceType

        public String getResourceType()
        Gets the resourceType. The resource type.
        Returns:
        the resourceType

      • getSubnet

        public SubnetReference getSubnet()
        Gets the subnet.
        Returns:
        the subnet

      • getVpc

        public VPCReference getVpc()
        Gets the vpc. The VPC this VPN gateway resides in.
        Returns:
        the vpc

      • getMode

        public String getMode()
        Gets the mode. Route mode VPN gateway.
        Returns:
        the mode