Package software.amazon.awssdk.services.workspaces.model

Class TimeoutSettings

java.lang.Object

software.amazon.awssdk.services.workspaces.model.TimeoutSettings

All Implemented Interfaces:

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

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

Describes the timeout settings for a pool of WorkSpaces.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	TimeoutSettings.Builder

Method Summary

Modifier and Type	Method	Description
static TimeoutSettings.Builder	builder()
Integer	disconnectTimeoutInSeconds()	Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	idleDisconnectTimeoutInSeconds()	The amount of time in seconds a connection will stay active while idle.
Integer	maxUserDurationInSeconds()	Specifies the maximum amount of time, in seconds, that a streaming session can remain active.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends TimeoutSettings.Builder>	serializableBuilderClass()
TimeoutSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

disconnectTimeoutInSeconds

public final Integer disconnectTimeoutInSeconds()

Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

Returns:

Specifies the amount of time, in seconds, that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within the time set, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance.

idleDisconnectTimeoutInSeconds

public final Integer idleDisconnectTimeoutInSeconds()

The amount of time in seconds a connection will stay active while idle.

Returns:

The amount of time in seconds a connection will stay active while idle.

maxUserDurationInSeconds

public final Integer maxUserDurationInSeconds()

Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

Returns:

Specifies the maximum amount of time, in seconds, that a streaming session can remain active. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance.

toBuilder

public TimeoutSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<TimeoutSettings.Builder,TimeoutSettings>

builder

public static TimeoutSettings.Builder builder()

serializableBuilderClass

public static Class<? extends TimeoutSettings.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