Package software.amazon.awssdk.services.workspacesweb.model

Class Session

java.lang.Object

software.amazon.awssdk.services.workspacesweb.model.Session

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Session.Builder,Session>

@Generated("software.amazon.awssdk:codegen")
public final class Session
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Session.Builder,Session>

Information about a secure browser session.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Session.Builder

Method Summary

Modifier and Type	Method	Description
static Session.Builder	builder()
List<String>	clientIpAddresses()	The IP address of the client.
Instant	endTime()	The end time of the session.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasClientIpAddresses()	For responses, this returns true if the service returned a value for the ClientIpAddresses property.
int	hashCode()
String	portalArn()	The ARN of the web portal.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Session.Builder>	serializableBuilderClass()
String	sessionId()	The ID of the session.
Instant	startTime()	The start time of the session.
SessionStatus	status()	The status of the session.
String	statusAsString()	The status of the session.
Session.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	username()	The username of the session.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

hasClientIpAddresses

public final boolean hasClientIpAddresses()

For responses, this returns true if the service returned a value for the ClientIpAddresses 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.

clientIpAddresses

public final List<String> clientIpAddresses()

The IP address of the client.

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 hasClientIpAddresses() method.

Returns:

The IP address of the client.

endTime

public final Instant endTime()

The end time of the session.

Returns:

The end time of the session.

portalArn

public final String portalArn()

The ARN of the web portal.

Returns:

The ARN of the web portal.

sessionId

public final String sessionId()

The ID of the session.

Returns:

The ID of the session.

startTime

public final Instant startTime()

The start time of the session.

Returns:

The start time of the session.

status

public final SessionStatus status()

The status of the session.

If the service returns an enum value that is not available in the current SDK version, status will return SessionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the session.

See Also:

SessionStatus

statusAsString

public final String statusAsString()

The status of the session.

If the service returns an enum value that is not available in the current SDK version, status will return SessionStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

The status of the session.

See Also:

SessionStatus

username

public final String username()

The username of the session.

Returns:

The username of the session.

toBuilder

public Session.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Session.Builder,Session>

builder

public static Session.Builder builder()

serializableBuilderClass

public static Class<? extends Session.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo