Class ClientVpnConnection
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ClientVpnConnection.Builder,
ClientVpnConnection>
Describes a client connection.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic ClientVpnConnection.Builder
builder()
final String
clientIp()
The IP address of the client.final String
The ID of the Client VPN endpoint to which the client is connected.final String
The common name associated with the client.final String
The date and time the client connection was terminated.final String
The date and time the client connection was established.final String
The ID of the client connection.final String
The number of bytes received by the client.final String
The number of packets received by the client.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the PostureComplianceStatuses property.final String
The number of bytes sent by the client.final String
The number of packets sent by the client.The statuses returned by the client connect handler for posture compliance, if applicable.static Class
<? extends ClientVpnConnection.Builder> status()
The current state of the client connection.final String
The current date and time.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
username()
The username of the client who established the client connection.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The current date and time.
- Returns:
- The current date and time.
-
connectionId
The ID of the client connection.
- Returns:
- The ID of the client connection.
-
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
The date and time the client connection was established.
- Returns:
- The date and time the client connection was established.
-
ingressBytes
The number of bytes sent by the client.
- Returns:
- The number of bytes sent by the client.
-
egressBytes
The number of bytes received by the client.
- Returns:
- The number of bytes received by the client.
-
ingressPackets
The number of packets sent by the client.
- Returns:
- The number of packets sent by the client.
-
egressPackets
The number of packets received by the client.
- Returns:
- The number of packets received by the client.
-
clientIp
The IP address of the client.
- Returns:
- The IP address of the client.
-
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
The current state of the client connection.
- Returns:
- The current state of the client connection.
-
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 theisEmpty()
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
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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<ClientVpnConnection.Builder,
ClientVpnConnection> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-