com.azure.cosmos

Class GlobalThroughputControlConfig

java.lang.Object

com.azure.cosmos.GlobalThroughputControlConfig

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public class GlobalThroughputControlConfig
extends Object

This configuration is used for throughput global control mode. It contains configuration about the extra container which will track all the clients throughput usage for a certain control group.

Method Summary

Modifier and Type	Method and Description
Duration	getControlItemExpireInterval() Get the control item expire interval.
Duration	getControlItemRenewInterval() Get the control item renew interval.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getControlItemRenewInterval

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public Duration getControlItemRenewInterval()

Get the control item renew interval. This controls how often the client is going to update the throughput usage of itself and adjust its own throughput share based on the throughput usage of other clients. In short words, it controls how quickly the shared throughput will reload balanced across different clients. The allowed min value is 5s. By default, it is 5s.

Returns:

The control item renew interval.

getControlItemExpireInterval

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public Duration getControlItemExpireInterval()

Get the control item expire interval. A client may be offline due to various reasons (being shutdown, network issue... ). This controls how quickly we will detect the client has been offline and hence allow its throughput share to be taken by other clients. The allowed min value is 2 * controlItemRenewInterval + 1. By default, it is 11s.

Returns:

The control item renew interval.