166 строки
13 KiB
YAML
166 строки
13 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource"
|
|
name: "ThroughputSettingsResource"
|
|
nameWithType: "ThroughputSettingsResource"
|
|
summary: "Cosmos DB resource throughput object."
|
|
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 **ThroughputSettingsResource**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource?alt=com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource&text=ThroughputSettingsResource\" data-throw-if-not-resolved=\"False\" />>"
|
|
constructors:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.ThroughputSettingsResource()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.ThroughputSettingsResource()"
|
|
name: "ThroughputSettingsResource()"
|
|
nameWithType: "ThroughputSettingsResource.ThroughputSettingsResource()"
|
|
summary: "Creates an instance of Throughput<wbr>Settings<wbr>Resource class."
|
|
syntax: "public ThroughputSettingsResource()"
|
|
desc: "Creates an instance of ThroughputSettingsResource class."
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.autoscaleSettings()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.autoscaleSettings()"
|
|
name: "autoscaleSettings()"
|
|
nameWithType: "ThroughputSettingsResource.autoscaleSettings()"
|
|
summary: "Get the autoscale<wbr>Settings property: Cosmos DB resource for autoscale settings."
|
|
syntax: "public AutoscaleSettingsResource autoscaleSettings()"
|
|
desc: "Get the autoscaleSettings property: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both."
|
|
returns:
|
|
description: "the autoscaleSettings value."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.AutoscaleSettingsResource?alt=com.azure.resourcemanager.cosmos.models.AutoscaleSettingsResource&text=AutoscaleSettingsResource\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.fromJson(com.azure.json.JsonReader)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.fromJson(JsonReader jsonReader)"
|
|
name: "fromJson(JsonReader jsonReader)"
|
|
nameWithType: "ThroughputSettingsResource.fromJson(JsonReader jsonReader)"
|
|
summary: "Reads an instance of Throughput<wbr>Settings<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 ThroughputSettingsResource fromJson(JsonReader jsonReader)"
|
|
exceptions:
|
|
- description: "If an error occurs while reading the ThroughputSettingsResource."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
|
|
desc: "Reads an instance of ThroughputSettingsResource from the JsonReader."
|
|
returns:
|
|
description: "An instance of ThroughputSettingsResource 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.ThroughputSettingsResource?alt=com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource&text=ThroughputSettingsResource\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.instantMaximumThroughput()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.instantMaximumThroughput()"
|
|
name: "instantMaximumThroughput()"
|
|
nameWithType: "ThroughputSettingsResource.instantMaximumThroughput()"
|
|
summary: "Get the instant<wbr>Maximum<wbr>Throughput property: The offer throughput value to instantly scale up without triggering splits."
|
|
syntax: "public String instantMaximumThroughput()"
|
|
desc: "Get the instantMaximumThroughput property: The offer throughput value to instantly scale up without triggering splits."
|
|
returns:
|
|
description: "the instantMaximumThroughput value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.minimumThroughput()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.minimumThroughput()"
|
|
name: "minimumThroughput()"
|
|
nameWithType: "ThroughputSettingsResource.minimumThroughput()"
|
|
summary: "Get the minimum<wbr>Throughput property: The minimum throughput of the resource."
|
|
syntax: "public String minimumThroughput()"
|
|
desc: "Get the minimumThroughput property: The minimum throughput of the resource."
|
|
returns:
|
|
description: "the minimumThroughput value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.offerReplacePending()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.offerReplacePending()"
|
|
name: "offerReplacePending()"
|
|
nameWithType: "ThroughputSettingsResource.offerReplacePending()"
|
|
summary: "Get the offer<wbr>Replace<wbr>Pending property: The throughput replace is pending."
|
|
syntax: "public String offerReplacePending()"
|
|
desc: "Get the offerReplacePending property: The throughput replace is pending."
|
|
returns:
|
|
description: "the offerReplacePending value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.softAllowedMaximumThroughput()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.softAllowedMaximumThroughput()"
|
|
name: "softAllowedMaximumThroughput()"
|
|
nameWithType: "ThroughputSettingsResource.softAllowedMaximumThroughput()"
|
|
summary: "Get the soft<wbr>Allowed<wbr>Maximum<wbr>Throughput property: The maximum throughput value or the maximum max<wbr>Throughput value (for autoscale) that can be specified."
|
|
syntax: "public String softAllowedMaximumThroughput()"
|
|
desc: "Get the softAllowedMaximumThroughput property: The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified."
|
|
returns:
|
|
description: "the softAllowedMaximumThroughput value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.throughput()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.throughput()"
|
|
name: "throughput()"
|
|
nameWithType: "ThroughputSettingsResource.throughput()"
|
|
summary: "Get the throughput property: Value of the Cosmos DB resource throughput."
|
|
syntax: "public Integer throughput()"
|
|
desc: "Get the throughput property: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both."
|
|
returns:
|
|
description: "the throughput value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.toJson(com.azure.json.JsonWriter)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.toJson(JsonWriter jsonWriter)"
|
|
name: "toJson(JsonWriter jsonWriter)"
|
|
nameWithType: "ThroughputSettingsResource.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.ThroughputSettingsResource.validate()"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.validate()"
|
|
name: "validate()"
|
|
nameWithType: "ThroughputSettingsResource.validate()"
|
|
summary: "Validates the instance."
|
|
syntax: "public void validate()"
|
|
desc: "Validates the instance."
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.withAutoscaleSettings(com.azure.resourcemanager.cosmos.models.AutoscaleSettingsResource)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.withAutoscaleSettings(AutoscaleSettingsResource autoscaleSettings)"
|
|
name: "withAutoscaleSettings(AutoscaleSettingsResource autoscaleSettings)"
|
|
nameWithType: "ThroughputSettingsResource.withAutoscaleSettings(AutoscaleSettingsResource autoscaleSettings)"
|
|
summary: "Set the autoscale<wbr>Settings property: Cosmos DB resource for autoscale settings."
|
|
parameters:
|
|
- description: "the autoscaleSettings value to set."
|
|
name: "autoscaleSettings"
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.AutoscaleSettingsResource?alt=com.azure.resourcemanager.cosmos.models.AutoscaleSettingsResource&text=AutoscaleSettingsResource\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ThroughputSettingsResource withAutoscaleSettings(AutoscaleSettingsResource autoscaleSettings)"
|
|
desc: "Set the autoscaleSettings property: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both."
|
|
returns:
|
|
description: "the ThroughputSettingsResource object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource?alt=com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource&text=ThroughputSettingsResource\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.withThroughput(java.lang.Integer)"
|
|
fullName: "com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource.withThroughput(Integer throughput)"
|
|
name: "withThroughput(Integer throughput)"
|
|
nameWithType: "ThroughputSettingsResource.withThroughput(Integer throughput)"
|
|
summary: "Set the throughput property: Value of the Cosmos DB resource throughput."
|
|
parameters:
|
|
- description: "the throughput value to set."
|
|
name: "throughput"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public ThroughputSettingsResource withThroughput(Integer throughput)"
|
|
desc: "Set the throughput property: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both."
|
|
returns:
|
|
description: "the ThroughputSettingsResource object itself."
|
|
type: "<xref href=\"com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource?alt=com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource&text=ThroughputSettingsResource\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both."
|
|
implements:
|
|
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource?alt=com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource&text=ThroughputSettingsResource\" data-throw-if-not-resolved=\"False\" />>"
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.cosmos.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.0
|