Class ClientVpnConnection

    • Method Detail

      • clientVpnEndpointId

        public final String clientVpnEndpointId()

        The ID of the Client VPN endpoint to which the client is connected.

        Returns:
        The ID of the Client VPN endpoint to which the client is connected.
      • timestamp

        public final String timestamp()

        The current date and time.

        Returns:
        The current date and time.
      • connectionId

        public final String connectionId()

        The ID of the client connection.

        Returns:
        The ID of the client connection.
      • username

        public final String username()

        The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used.

        Returns:
        The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used.
      • connectionEstablishedTime

        public final String connectionEstablishedTime()

        The date and time the client connection was established.

        Returns:
        The date and time the client connection was established.
      • ingressBytes

        public final String ingressBytes()

        The number of bytes sent by the client.

        Returns:
        The number of bytes sent by the client.
      • egressBytes

        public final String egressBytes()

        The number of bytes received by the client.

        Returns:
        The number of bytes received by the client.
      • ingressPackets

        public final String ingressPackets()

        The number of packets sent by the client.

        Returns:
        The number of packets sent by the client.
      • egressPackets

        public final String egressPackets()

        The number of packets received by the client.

        Returns:
        The number of packets received by the client.
      • clientIp

        public final String clientIp()

        The IP address of the client.

        Returns:
        The IP address of the client.
      • commonName

        public final String commonName()

        The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name.

        Returns:
        The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name.
      • status

        public final ClientVpnConnectionStatus status()

        The current state of the client connection.

        Returns:
        The current state of the client connection.
      • connectionEndTime

        public final String connectionEndTime()

        The date and time the client connection was terminated.

        Returns:
        The date and time the client connection was terminated.
      • hasPostureComplianceStatuses

        public final boolean hasPostureComplianceStatuses()
        For responses, this returns true if the service returned a value for the PostureComplianceStatuses property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • postureComplianceStatuses

        public final List<String> postureComplianceStatuses()

        The statuses returned by the client connect handler for posture compliance, if applicable.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPostureComplianceStatuses() method.

        Returns:
        The statuses returned by the client connect handler for posture compliance, if applicable.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object
      • getValueForField

        public final <T> Optional<T> getValueForField​(String fieldName,
                                                      Class<T> clazz)