### YamlMime:JavaType
uid: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource"
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource"
name: "ThroughputPolicyResource"
nameWithType: "ThroughputPolicyResource"
summary: "Cosmos DB resource throughput policy."
inheritances:
- ""
inheritedClassMethods:
- classRef: "java.lang.Object"
methodsRef:
- "clone"
- "equals"
- "finalize"
- "getClass"
- "hashCode"
- "notify"
- "notifyAll"
- "toString"
- "wait"
- "wait"
- "wait"
syntax: "public final class **ThroughputPolicyResource** implements <>"
constructors:
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.ThroughputPolicyResource()"
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.ThroughputPolicyResource()"
name: "ThroughputPolicyResource()"
nameWithType: "ThroughputPolicyResource.ThroughputPolicyResource()"
summary: "Creates an instance of ThroughputPolicyResource class."
syntax: "public ThroughputPolicyResource()"
desc: "Creates an instance of ThroughputPolicyResource class."
methods:
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.fromJson(com.azure.json.JsonReader)"
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.fromJson(JsonReader jsonReader)"
name: "fromJson(JsonReader jsonReader)"
nameWithType: "ThroughputPolicyResource.fromJson(JsonReader jsonReader)"
summary: "Reads an instance of ThroughputPolicyResource from the JsonReader."
modifiers:
- "static"
parameters:
- description: "The JsonReader being read."
name: "jsonReader"
type: ""
syntax: "public static ThroughputPolicyResource fromJson(JsonReader jsonReader)"
exceptions:
- description: "If an error occurs while reading the ThroughputPolicyResource."
type: "IOException"
desc: "Reads an instance of ThroughputPolicyResource from the JsonReader."
returns:
description: "An instance of ThroughputPolicyResource if the JsonReader was pointing to an instance of it, or null if\n it was pointing to JSON null."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.incrementPercent()"
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.incrementPercent()"
name: "incrementPercent()"
nameWithType: "ThroughputPolicyResource.incrementPercent()"
summary: "Get the incrementPercent property: Represents the percentage by which throughput can increase every time throughput policy kicks in."
syntax: "public Integer incrementPercent()"
desc: "Get the incrementPercent property: Represents the percentage by which throughput can increase every time throughput policy kicks in."
returns:
description: "the incrementPercent value."
type: "Integer"
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.isEnabled()"
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.isEnabled()"
name: "isEnabled()"
nameWithType: "ThroughputPolicyResource.isEnabled()"
summary: "Get the isEnabled property: Determines whether the ThroughputPolicy is active or not."
syntax: "public Boolean isEnabled()"
desc: "Get the isEnabled property: Determines whether the ThroughputPolicy is active or not."
returns:
description: "the isEnabled value."
type: "Boolean"
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.toJson(com.azure.json.JsonWriter)"
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.toJson(JsonWriter jsonWriter)"
name: "toJson(JsonWriter jsonWriter)"
nameWithType: "ThroughputPolicyResource.toJson(JsonWriter jsonWriter)"
parameters:
- name: "jsonWriter"
type: ""
syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
exceptions:
- type: "IOException"
returns:
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.validate()"
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.validate()"
name: "validate()"
nameWithType: "ThroughputPolicyResource.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.withIncrementPercent(java.lang.Integer)"
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.withIncrementPercent(Integer incrementPercent)"
name: "withIncrementPercent(Integer incrementPercent)"
nameWithType: "ThroughputPolicyResource.withIncrementPercent(Integer incrementPercent)"
summary: "Set the incrementPercent property: Represents the percentage by which throughput can increase every time throughput policy kicks in."
parameters:
- description: "the incrementPercent value to set."
name: "incrementPercent"
type: "Integer"
syntax: "public ThroughputPolicyResource withIncrementPercent(Integer incrementPercent)"
desc: "Set the incrementPercent property: Represents the percentage by which throughput can increase every time throughput policy kicks in."
returns:
description: "the ThroughputPolicyResource object itself."
type: ""
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.withIsEnabled(java.lang.Boolean)"
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.withIsEnabled(Boolean isEnabled)"
name: "withIsEnabled(Boolean isEnabled)"
nameWithType: "ThroughputPolicyResource.withIsEnabled(Boolean isEnabled)"
summary: "Set the isEnabled property: Determines whether the ThroughputPolicy is active or not."
parameters:
- description: "the isEnabled value to set."
name: "isEnabled"
type: "Boolean"
syntax: "public ThroughputPolicyResource withIsEnabled(Boolean isEnabled)"
desc: "Set the isEnabled property: Determines whether the ThroughputPolicy is active or not."
returns:
description: "the ThroughputPolicyResource object itself."
type: ""
type: "class"
desc: "Cosmos DB resource throughput policy."
implements:
- "<>"
metadata: {}
package: "com.azure.resourcemanager.cosmos.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.0