azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.yml

### 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:
- "<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 **ThroughputPolicyResource**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource?alt=com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource&text=ThroughputPolicyResource\" data-throw-if-not-resolved=\"False\" />&gt;"
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 Throughput<wbr>Policy<wbr>Resource 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 Throughput<wbr>Policy<wbr>Resource from the Json<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The JsonReader being read."
    name: "jsonReader"
    type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static ThroughputPolicyResource fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If an error occurs while reading the ThroughputPolicyResource."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  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: "<xref href=\"com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource?alt=com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource&text=ThroughputPolicyResource\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.incrementPercent()"
  fullName: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.incrementPercent()"
  name: "incrementPercent()"
  nameWithType: "ThroughputPolicyResource.incrementPercent()"
  summary: "Get the increment<wbr>Percent 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: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.isEnabled()"
  fullName: "com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource.isEnabled()"
  name: "isEnabled()"
  nameWithType: "ThroughputPolicyResource.isEnabled()"
  summary: "Get the is<wbr>Enabled property: Determines whether the Throughput<wbr>Policy 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: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- 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: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  returns:
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- 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 increment<wbr>Percent 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: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  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: "<xref href=\"com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource?alt=com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource&text=ThroughputPolicyResource\" data-throw-if-not-resolved=\"False\" />"
- 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 is<wbr>Enabled property: Determines whether the Throughput<wbr>Policy is active or not."
  parameters:
  - description: "the isEnabled value to set."
    name: "isEnabled"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
  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: "<xref href=\"com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource?alt=com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource&text=ThroughputPolicyResource\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Cosmos DB resource throughput policy."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource?alt=com.azure.resourcemanager.cosmos.models.ThroughputPolicyResource&text=ThroughputPolicyResource\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.cosmos.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.0