com.azure.cosmos

Class GlobalThroughputControlConfigBuilder

java.lang.Object

com.azure.cosmos.GlobalThroughputControlConfigBuilder

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

Throughput global control config builder.

Method Summary

Modifier and Type	Method and Description
GlobalThroughputControlConfig	build() Validate the throughput global control configuration and create a new throughput global control config item.
GlobalThroughputControlConfigBuilder	setControlItemExpireInterval(Duration controlItemExpireInterval) Set the control item expire interval.
GlobalThroughputControlConfigBuilder	setControlItemRenewInterval(Duration controlItemRenewInterval) Set 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

setControlItemRenewInterval

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

Set 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.

Parameters:

controlItemRenewInterval - The control item renewal interval.

Returns:

The GlobalThroughputControlConfigBuilder

setControlItemExpireInterval

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

Set 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.

Parameters:

controlItemExpireInterval - The control item expire interval.

Returns:

The GlobalThroughputControlConfigBuilder

build

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

Validate the throughput global control configuration and create a new throughput global control config item.

Returns:

A new GlobalThroughputControlConfig.