Package com.azure.cosmos

Class ThroughputControlGroupConfig

java.lang.Object
com.azure.cosmos.ThroughputControlGroupConfig
@Beta(value=V4_13_0, warningText="Preview API - subject to change in non-backwards compatible way") public final class ThroughputControlGroupConfig extends Object
Throughput control group configuration.

  • Method Details

    • getGroupName

      @Beta(value=V4_13_0, warningText="Preview API - subject to change in non-backwards compatible way") public String getGroupName()
      Get the throughput control group name.
      Returns:
      the group name.

    • getTargetThroughput

      @Beta(value=V4_13_0, warningText="Preview API - subject to change in non-backwards compatible way") 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

      @Beta(value=V4_13_0, warningText="Preview API - subject to change in non-backwards compatible way") 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.

    • isDefault

      @Beta(value=V4_13_0, warningText="Preview API - subject to change in non-backwards compatible way") 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

      @Beta(value=V4_28_0, warningText="Preview API - subject to change in non-backwards compatible way") 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.