Interface TimeoutSettings.Builder

All Superinterfaces:
Buildable, CopyableBuilder<TimeoutSettings.Builder,TimeoutSettings>, SdkBuilder<TimeoutSettings.Builder,TimeoutSettings>, SdkPojo
Enclosing class:
TimeoutSettings
@Mutable @NotThreadSafe public static interface TimeoutSettings.Builder extends SdkPojo, CopyableBuilder<TimeoutSettings.Builder,TimeoutSettings>

  • Method Details

    • disconnectTimeoutInSeconds

      TimeoutSettings.Builder disconnectTimeoutInSeconds(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • idleDisconnectTimeoutInSeconds

      TimeoutSettings.Builder idleDisconnectTimeoutInSeconds(Integer idleDisconnectTimeoutInSeconds)

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

      Parameters:
      idleDisconnectTimeoutInSeconds - The amount of time in seconds a connection will stay active while idle.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • maxUserDurationInSeconds

      TimeoutSettings.Builder maxUserDurationInSeconds(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.