com.azure.cosmos.ThroughputControlGroupConfig.yml

### YamlMime:JavaType
uid: "com.azure.cosmos.ThroughputControlGroupConfig"
fullName: "com.azure.cosmos.ThroughputControlGroupConfig"
name: "ThroughputControlGroupConfig"
nameWithType: "ThroughputControlGroupConfig"
summary: "Throughput control group configuration."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **ThroughputControlGroupConfig**"
methods:
- uid: "com.azure.cosmos.ThroughputControlGroupConfig.continueOnInitError()"
  fullName: "com.azure.cosmos.ThroughputControlGroupConfig.continueOnInitError()"
  name: "continueOnInitError()"
  nameWithType: "ThroughputControlGroupConfig.continueOnInitError()"
  summary: "Get whether request is allowed to continue on original request flow if throughput control controller failed on initialization."
  syntax: "public boolean continueOnInitError()"
  desc: "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:
    description: "<code>true</code> request will continue on original request flow if throughput control controller failed on initialization. <code>false</code> otherwise."
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.ThroughputControlGroupConfig.getGroupName()"
  fullName: "com.azure.cosmos.ThroughputControlGroupConfig.getGroupName()"
  name: "getGroupName()"
  nameWithType: "ThroughputControlGroupConfig.getGroupName()"
  summary: "Get the throughput control group name."
  syntax: "public String getGroupName()"
  desc: "Get the throughput control group name."
  returns:
    description: "the group name."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.cosmos.ThroughputControlGroupConfig.getPriorityLevel()"
  fullName: "com.azure.cosmos.ThroughputControlGroupConfig.getPriorityLevel()"
  name: "getPriorityLevel()"
  nameWithType: "ThroughputControlGroupConfig.getPriorityLevel()"
  summary: "Get the throughput control group priority level."
  syntax: "public PriorityLevel getPriorityLevel()"
  desc: "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:
    description: "the priority level of the throughput control group."
    type: "<xref href=\"com.azure.cosmos.models.PriorityLevel?alt=com.azure.cosmos.models.PriorityLevel&text=PriorityLevel\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.cosmos.ThroughputControlGroupConfig.getTargetThroughput()"
  fullName: "com.azure.cosmos.ThroughputControlGroupConfig.getTargetThroughput()"
  name: "getTargetThroughput()"
  nameWithType: "ThroughputControlGroupConfig.getTargetThroughput()"
  summary: "Get throughput control group target throughput."
  syntax: "public Integer getTargetThroughput()"
  desc: "Get throughput control group target throughput. Since we allow either TargetThroughput or TargetThroughputThreshold, this value can be null. By default, it is null."
  returns:
    description: "the target throughput."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.cosmos.ThroughputControlGroupConfig.getTargetThroughputThreshold()"
  fullName: "com.azure.cosmos.ThroughputControlGroupConfig.getTargetThroughputThreshold()"
  name: "getTargetThroughputThreshold()"
  nameWithType: "ThroughputControlGroupConfig.getTargetThroughputThreshold()"
  summary: "Get the throughput control group target throughput threshold."
  syntax: "public Double getTargetThroughputThreshold()"
  desc: "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:
    description: "the target throughput threshold null or (0, 1]."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
- uid: "com.azure.cosmos.ThroughputControlGroupConfig.isDefault()"
  fullName: "com.azure.cosmos.ThroughputControlGroupConfig.isDefault()"
  name: "isDefault()"
  nameWithType: "ThroughputControlGroupConfig.isDefault()"
  summary: "Get whether this throughput control group will be used by default."
  syntax: "public boolean isDefault()"
  desc: "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:
    description: "<code>true</code> this throughput control group will be used by default unless being override. <code>false</code> otherwise."
    type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Throughput control group configuration."
metadata: {}
package: "com.azure.cosmos"
artifact: com.azure:azure-cosmos:4.62.0