Package com.azure.cosmos

Class ThroughputControlGroupConfig

java.lang.Object
com.azure.cosmos.ThroughputControlGroupConfig
public final class ThroughputControlGroupConfig extends Object
Throughput control group configuration.

  • Method Details

    • getGroupName

      public String getGroupName()
      Get the throughput control group name.
      Returns:
      the group name.

    • 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].

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

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

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