Delen via

ThroughputControlGroupConfig Class

  • Reference
Package:
com.azure.cosmos
Maven Artifact:
com.azure:azure-cosmos:4.63.4
  • java.lang.Object
    • com.azure.cosmos.ThroughputControlGroupConfig

public final class ThroughputControlGroupConfig

Throughput control group configuration.

Method Summary

Modifier and Type Method and Description
boolean continueOnInitError()

Get whether request is allowed to continue on original request flow if throughput control controller failed on initialization.
String getGroupName()

Get the throughput control group name.
PriorityLevel getPriorityLevel()

Get the throughput control group priority level.
Integer getTargetThroughput()

Get throughput control group target throughput.
Double getTargetThroughputThreshold()

Get the throughput control group target throughput threshold.
boolean isDefault()

Get whether this throughput control group will be used by default.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Method Details

continueOnInitError

public boolean continueOnInitError()

Get whether request is allowed to continue on original request flow if throughput control controller failed on initialization. By default, it is false. If it is true, requests will continue on original request flow if throughput control controller failed on initialization.

Returns:

true request will continue on original request flow if throughput control controller failed on initialization. false otherwise.

getGroupName

public String getGroupName()

Get the throughput control group name.

Returns:

the group name.

getPriorityLevel

public PriorityLevel getPriorityLevel()

Get the throughput control group priority level. Priority level is used to determine which group will be throttled first when the total throughput of all groups exceeds the max throughput. Default PriorityLevel for each request is treated as High. It can be explicitly set to Low for some requests. Refer to https://aka.ms/CosmosDB/PriorityBasedExecution for more details.

Returns:

the priority level of the throughput control group.

getTargetThroughput

public Integer getTargetThroughput()

Get throughput control group target throughput. Since we allow either TargetThroughput or TargetThroughputThreshold, this value can be null. By default, it is null.

Returns:

the target throughput.

getTargetThroughputThreshold

public Double getTargetThroughputThreshold()

Get the throughput control group target throughput threshold. Since we allow either TargetThroughput or TargetThroughputThreshold, this value can be null. By default, this value is null.

Returns:

the target throughput threshold null or (0, 1].

isDefault

public boolean isDefault()

Get whether this throughput control group will be used by default. By default, it is false. If it is true, requests without explicit override of the throughput control group will be routed to this group.

Returns:

true this throughput control group will be used by default unless being override. false otherwise.

Applies to