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

Class VPNServerClient

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

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

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class VPNServerClient
extends com.ibm.cloud.sdk.core.service.model.GenericModel

VPNServerClient.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	VPNServerClient.ResourceType	The resource type.
static interface	VPNServerClient.Status	The status of the VPN client: - `connected`: the VPN client is `connected` to this VPN server.

Method Summary

Modifier and Type	Method	Description
IP	getClientIp()	Gets the clientIp.
String	getCommonName()	Gets the commonName.
Date	getCreatedAt()	Gets the createdAt.
Date	getDisconnectedAt()	Gets the disconnectedAt.
String	getHref()	Gets the href.
String	getId()	Gets the id.
IP	getRemoteIp()	Gets the remoteIp.
Long	getRemotePort()	Gets the remotePort.
String	getResourceType()	Gets the resourceType.
String	getStatus()	Gets the status.
String	getUsername()	Gets the username.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getClientIp

public IP getClientIp()

Gets the clientIp. The IP address assigned to this VPN client from `client_ip_pool`.

Returns:

the clientIp

getCommonName

public String getCommonName()

Gets the commonName. The common name of client certificate that the VPN client provided when connecting to the server. This property will be present only when the `certificate` client authentication method is enabled on the VPN server.

Returns:

the commonName

getCreatedAt

public Date getCreatedAt()

Gets the createdAt. The date and time that the VPN client was created.

Returns:

the createdAt

getDisconnectedAt

public Date getDisconnectedAt()

Gets the disconnectedAt. The date and time that the VPN client was disconnected. This property will be present only when the client `status` is `disconnected`.

Returns:

the disconnectedAt

getHref

public String getHref()

Gets the href. The URL for this VPN client.

Returns:

the href

getId

public String getId()

Gets the id. The unique identifier for this VPN client.

Returns:

the id

getRemoteIp

public IP getRemoteIp()

Gets the remoteIp. The remote IP address of this VPN client.

Returns:

the remoteIp

getRemotePort

public Long getRemotePort()

Gets the remotePort. The remote port of this VPN client.

Returns:

the remotePort

getResourceType

public String getResourceType()

Gets the resourceType. The resource type.

Returns:

the resourceType

getStatus

public String getStatus()

Gets the status. The status of the VPN client: - `connected`: the VPN client is `connected` to this VPN server. - `disconnected`: the VPN client is `disconnected` from this VPN server. The enumerated values for this property are expected to expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the VPN client on which the unexpected property value was encountered.

Returns:

the status

getUsername

public String getUsername()

Gets the username. The username that this VPN client provided when connecting to the VPN server. This property will be present only when the `username` client authentication method is enabled on the VPN server.

Returns:

the username