com.azure.cosmos

Class ThroughputControlGroupConfigBuilder

java.lang.Object

com.azure.cosmos.ThroughputControlGroupConfigBuilder

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

The throughput control group config builder.

Constructor Summary

Constructors

Constructor and Description
ThroughputControlGroupConfigBuilder()

Method Summary

Modifier and Type	Method and Description
ThroughputControlGroupConfig	build() Validate the throughput configuration and create a new throughput control group config item.
ThroughputControlGroupConfigBuilder	setDefault(boolean aDefault) Set whether this throughput control group will be used by default.
ThroughputControlGroupConfigBuilder	setGroupName(String groupName) Set the throughput control group name.
ThroughputControlGroupConfigBuilder	setTargetThroughput(int targetThroughput) Set the throughput control group target throughput.
ThroughputControlGroupConfigBuilder	setTargetThroughputThreshold(double targetThroughputThreshold) Set the throughput control group target throughput threshold.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThroughputControlGroupConfigBuilder

public ThroughputControlGroupConfigBuilder()

Method Detail

setGroupName

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public ThroughputControlGroupConfigBuilder setGroupName(String groupName)

Set the throughput control group name.

Parameters:

groupName - The throughput control group name.

Returns:

The ThroughputControlGroupConfigBuilder.

setTargetThroughput

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public ThroughputControlGroupConfigBuilder setTargetThroughput(int targetThroughput)

Set the throughput control group target throughput. The target throughput value should be greater than 0.

Parameters:

targetThroughput - The target throughput for the control group.

Returns:

The ThroughputControlGroupConfigBuilder.

setTargetThroughputThreshold

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public ThroughputControlGroupConfigBuilder setTargetThroughputThreshold(double targetThroughputThreshold)

Set the throughput control group target throughput threshold. The target throughput threshold value should be between (0, 1].

Parameters:

targetThroughputThreshold - The target throughput threshold for the control group.

Returns:

The ThroughputControlGroupConfigBuilder.

setDefault

@Beta(value=V4_13_0,
      warningText="Preview API - subject to change in non-backwards compatible way")
public ThroughputControlGroupConfigBuilder setDefault(boolean aDefault)

Set whether this throughput control group will be used by default. If set to true, requests without explicit override of the throughput control group will be routed to this group.

Parameters:

aDefault - The flag to indicate whether the throughput control group will be used by default.

Returns:

The ThroughputControlGroupConfigBuilder.

build

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

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

Returns:

A new ThroughputControlGroupConfig.