186 строки
17 KiB
YAML
186 строки
17 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.cosmos.ThroughputControlGroupConfigBuilder"
|
|
fullName: "com.azure.cosmos.ThroughputControlGroupConfigBuilder"
|
|
name: "ThroughputControlGroupConfigBuilder"
|
|
nameWithType: "ThroughputControlGroupConfigBuilder"
|
|
summary: "The throughput control group config builder."
|
|
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 class **ThroughputControlGroupConfigBuilder**"
|
|
constructors:
|
|
- uid: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.ThroughputControlGroupConfigBuilder()"
|
|
fullName: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.ThroughputControlGroupConfigBuilder()"
|
|
name: "ThroughputControlGroupConfigBuilder()"
|
|
nameWithType: "ThroughputControlGroupConfigBuilder.ThroughputControlGroupConfigBuilder()"
|
|
syntax: "public ThroughputControlGroupConfigBuilder()"
|
|
methods:
|
|
- uid: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.build()"
|
|
fullName: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.build()"
|
|
name: "build()"
|
|
nameWithType: "ThroughputControlGroupConfigBuilder.build()"
|
|
summary: "Validate the throughput configuration and create a new throughput control group config item."
|
|
syntax: "public ThroughputControlGroupConfig build()"
|
|
desc: "Validate the throughput configuration and create a new throughput control group config item."
|
|
returns:
|
|
description: "A new <xref uid=\"com.azure.cosmos.ThroughputControlGroupConfig\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ThroughputControlGroupConfig\"></xref>."
|
|
type: "<xref href=\"com.azure.cosmos.ThroughputControlGroupConfig?alt=com.azure.cosmos.ThroughputControlGroupConfig&text=ThroughputControlGroupConfig\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.continueOnInitError(boolean)"
|
|
fullName: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.continueOnInitError(boolean continueOnInitError)"
|
|
name: "continueOnInitError(boolean continueOnInitError)"
|
|
nameWithType: "ThroughputControlGroupConfigBuilder.continueOnInitError(boolean continueOnInitError)"
|
|
summary: "Set whether allow request to continue on original request flow if throughput control controller failed on initialization."
|
|
parameters:
|
|
- description: "The flag to indicate whether request is allowed to fall back to original request flow."
|
|
name: "continueOnInitError"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ThroughputControlGroupConfigBuilder continueOnInitError(boolean continueOnInitError)"
|
|
desc: "Set whether allow request to continue on original request flow if throughput control controller failed on initialization. If set to true, requests will be able to fall back to original request flow if throughput control controller failed on initialization."
|
|
returns:
|
|
description: "The <xref uid=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ThroughputControlGroupConfigBuilder\"></xref>."
|
|
type: "<xref href=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder?alt=com.azure.cosmos.ThroughputControlGroupConfigBuilder&text=ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.defaultControlGroup(boolean)"
|
|
fullName: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.defaultControlGroup(boolean aDefault)"
|
|
name: "defaultControlGroup(boolean aDefault)"
|
|
nameWithType: "ThroughputControlGroupConfigBuilder.defaultControlGroup(boolean aDefault)"
|
|
summary: "Set whether this throughput control group will be used by default."
|
|
parameters:
|
|
- description: "The flag to indicate whether the throughput control group will be used by default."
|
|
name: "aDefault"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ThroughputControlGroupConfigBuilder defaultControlGroup(boolean aDefault)"
|
|
desc: "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."
|
|
returns:
|
|
description: "The <xref uid=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ThroughputControlGroupConfigBuilder\"></xref>."
|
|
type: "<xref href=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder?alt=com.azure.cosmos.ThroughputControlGroupConfigBuilder&text=ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.groupName(java.lang.String)"
|
|
fullName: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.groupName(String groupName)"
|
|
name: "groupName(String groupName)"
|
|
nameWithType: "ThroughputControlGroupConfigBuilder.groupName(String groupName)"
|
|
summary: "Set the throughput control group name."
|
|
parameters:
|
|
- description: "The throughput control group name."
|
|
name: "groupName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ThroughputControlGroupConfigBuilder groupName(String groupName)"
|
|
desc: "Set the throughput control group name."
|
|
returns:
|
|
description: "The <xref uid=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ThroughputControlGroupConfigBuilder\"></xref>."
|
|
type: "<xref href=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder?alt=com.azure.cosmos.ThroughputControlGroupConfigBuilder&text=ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.priorityLevel(com.azure.cosmos.models.PriorityLevel)"
|
|
fullName: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.priorityLevel(PriorityLevel priorityLevel)"
|
|
name: "priorityLevel(PriorityLevel priorityLevel)"
|
|
nameWithType: "ThroughputControlGroupConfigBuilder.priorityLevel(PriorityLevel priorityLevel)"
|
|
summary: "Set the throughput control group priority level."
|
|
parameters:
|
|
- description: "The priority level for the control group."
|
|
name: "priorityLevel"
|
|
type: "<xref href=\"com.azure.cosmos.models.PriorityLevel?alt=com.azure.cosmos.models.PriorityLevel&text=PriorityLevel\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ThroughputControlGroupConfigBuilder priorityLevel(PriorityLevel priorityLevel)"
|
|
desc: "Set the throughput control group priority level. The priority level is used to determine which requests will be throttled first when the total throughput of all control groups exceeds the max throughput. By Default PriorityLevel for each request is treated as High. It can be explicitly set to Low for some requests. Priority based execution is currently in preview. To enable the feature, please follow the instructions [here][]\n\n\n[here]: https://devblogs.microsoft.com/cosmosdb/introducing-priority-based-execution-in-azure-cosmos-db-preview/#next-steps"
|
|
returns:
|
|
description: "The <xref uid=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ThroughputControlGroupConfigBuilder\"></xref>."
|
|
type: "<xref href=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder?alt=com.azure.cosmos.ThroughputControlGroupConfigBuilder&text=ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.setDefault(boolean)"
|
|
fullName: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.setDefault(boolean aDefault)"
|
|
name: "setDefault(boolean aDefault)"
|
|
nameWithType: "ThroughputControlGroupConfigBuilder.setDefault(boolean aDefault)"
|
|
summary: "Set whether this throughput control group will be used by default."
|
|
parameters:
|
|
- description: "The flag to indicate whether the throughput control group will be used by default."
|
|
name: "aDefault"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ThroughputControlGroupConfigBuilder setDefault(boolean aDefault)"
|
|
desc: "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."
|
|
returns:
|
|
description: "The <xref uid=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ThroughputControlGroupConfigBuilder\"></xref>."
|
|
type: "<xref href=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder?alt=com.azure.cosmos.ThroughputControlGroupConfigBuilder&text=ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.setGroupName(java.lang.String)"
|
|
fullName: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.setGroupName(String groupName)"
|
|
name: "setGroupName(String groupName)"
|
|
nameWithType: "ThroughputControlGroupConfigBuilder.setGroupName(String groupName)"
|
|
summary: "Set the throughput control group name."
|
|
parameters:
|
|
- description: "The throughput control group name."
|
|
name: "groupName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ThroughputControlGroupConfigBuilder setGroupName(String groupName)"
|
|
desc: "Set the throughput control group name."
|
|
returns:
|
|
description: "The <xref uid=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ThroughputControlGroupConfigBuilder\"></xref>."
|
|
type: "<xref href=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder?alt=com.azure.cosmos.ThroughputControlGroupConfigBuilder&text=ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.setTargetThroughput(int)"
|
|
fullName: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.setTargetThroughput(int targetThroughput)"
|
|
name: "setTargetThroughput(int targetThroughput)"
|
|
nameWithType: "ThroughputControlGroupConfigBuilder.setTargetThroughput(int targetThroughput)"
|
|
summary: "Set the throughput control group target throughput."
|
|
parameters:
|
|
- description: "The target throughput for the control group."
|
|
name: "targetThroughput"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ThroughputControlGroupConfigBuilder setTargetThroughput(int targetThroughput)"
|
|
desc: "Set the throughput control group target throughput. The target throughput value should be greater than 0."
|
|
returns:
|
|
description: "The <xref uid=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ThroughputControlGroupConfigBuilder\"></xref>."
|
|
type: "<xref href=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder?alt=com.azure.cosmos.ThroughputControlGroupConfigBuilder&text=ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.setTargetThroughputThreshold(double)"
|
|
fullName: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.setTargetThroughputThreshold(double targetThroughputThreshold)"
|
|
name: "setTargetThroughputThreshold(double targetThroughputThreshold)"
|
|
nameWithType: "ThroughputControlGroupConfigBuilder.setTargetThroughputThreshold(double targetThroughputThreshold)"
|
|
summary: "Set the throughput control group target throughput threshold."
|
|
parameters:
|
|
- description: "The target throughput threshold for the control group."
|
|
name: "targetThroughputThreshold"
|
|
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ThroughputControlGroupConfigBuilder setTargetThroughputThreshold(double targetThroughputThreshold)"
|
|
desc: "Set the throughput control group target throughput threshold. The target throughput threshold value should be between (0, 1\\]."
|
|
returns:
|
|
description: "The <xref uid=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ThroughputControlGroupConfigBuilder\"></xref>."
|
|
type: "<xref href=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder?alt=com.azure.cosmos.ThroughputControlGroupConfigBuilder&text=ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.targetThroughput(int)"
|
|
fullName: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.targetThroughput(int targetThroughput)"
|
|
name: "targetThroughput(int targetThroughput)"
|
|
nameWithType: "ThroughputControlGroupConfigBuilder.targetThroughput(int targetThroughput)"
|
|
summary: "Set the throughput control group target throughput."
|
|
parameters:
|
|
- description: "The target throughput for the control group."
|
|
name: "targetThroughput"
|
|
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ThroughputControlGroupConfigBuilder targetThroughput(int targetThroughput)"
|
|
desc: "Set the throughput control group target throughput. The target throughput value should be greater than 0."
|
|
returns:
|
|
description: "The <xref uid=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ThroughputControlGroupConfigBuilder\"></xref>."
|
|
type: "<xref href=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder?alt=com.azure.cosmos.ThroughputControlGroupConfigBuilder&text=ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.targetThroughputThreshold(double)"
|
|
fullName: "com.azure.cosmos.ThroughputControlGroupConfigBuilder.targetThroughputThreshold(double targetThroughputThreshold)"
|
|
name: "targetThroughputThreshold(double targetThroughputThreshold)"
|
|
nameWithType: "ThroughputControlGroupConfigBuilder.targetThroughputThreshold(double targetThroughputThreshold)"
|
|
summary: "Set the throughput control group target throughput threshold."
|
|
parameters:
|
|
- description: "The target throughput threshold for the control group."
|
|
name: "targetThroughputThreshold"
|
|
type: "<xref href=\"double?alt=double&text=double\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ThroughputControlGroupConfigBuilder targetThroughputThreshold(double targetThroughputThreshold)"
|
|
desc: "Set the throughput control group target throughput threshold. The target throughput threshold value should be between (0, 1\\]."
|
|
returns:
|
|
description: "The <xref uid=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ThroughputControlGroupConfigBuilder\"></xref>."
|
|
type: "<xref href=\"com.azure.cosmos.ThroughputControlGroupConfigBuilder?alt=com.azure.cosmos.ThroughputControlGroupConfigBuilder&text=ThroughputControlGroupConfigBuilder\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The throughput control group config builder."
|
|
metadata: {}
|
|
package: "com.azure.cosmos"
|
|
artifact: com.azure:azure-cosmos:4.63.3
|