ThroughputSettingsResource Class

Package:

com.azure.resourcemanager.cosmos.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cosmos:2.54.0

• java.lang.Object
• • com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource

Implements

JsonSerializable<ThroughputSettingsResource>

public class ThroughputSettingsResource
implements JsonSerializable<ThroughputSettingsResource>

Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.

Constructor Summary

Constructor	Description
ThroughputSettingsResource()	Creates an instance of ThroughputSettingsResource class.

Method Summary

Modifier and Type	Method and Description
AutoscaleSettingsResource	autoscaleSettings() Get the autoscaleSettings property: Cosmos DB resource for autoscale settings.
static ThroughputSettingsResource	fromJson(JsonReader jsonReader) Reads an instance of ThroughputSettingsResource from the JsonReader.
String	instantMaximumThroughput() Get the instantMaximumThroughput property: The offer throughput value to instantly scale up without triggering splits.
String	minimumThroughput() Get the minimumThroughput property: The minimum throughput of the resource.
String	offerReplacePending() Get the offerReplacePending property: The throughput replace is pending.
String	softAllowedMaximumThroughput() Get the softAllowedMaximumThroughput property: The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified.
Integer	throughput() Get the throughput property: Value of the Cosmos DB resource throughput.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
ThroughputSettingsResource	withAutoscaleSettings(AutoscaleSettingsResource autoscaleSettings) Set the autoscaleSettings property: Cosmos DB resource for autoscale settings.
ThroughputSettingsResource	withThroughput(Integer throughput) Set the throughput property: Value of the Cosmos DB resource throughput.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ThroughputSettingsResource

public ThroughputSettingsResource()

Creates an instance of ThroughputSettingsResource class.

Method Details

autoscaleSettings

public AutoscaleSettingsResource autoscaleSettings()

Get the autoscaleSettings property: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.

Returns:

the autoscaleSettings value.

fromJson

public static ThroughputSettingsResource fromJson(JsonReader jsonReader)

Reads an instance of ThroughputSettingsResource from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of ThroughputSettingsResource if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the ThroughputSettingsResource.

instantMaximumThroughput

public String instantMaximumThroughput()

Get the instantMaximumThroughput property: The offer throughput value to instantly scale up without triggering splits.

Returns:

the instantMaximumThroughput value.

minimumThroughput

public String minimumThroughput()

Get the minimumThroughput property: The minimum throughput of the resource.

Returns:

the minimumThroughput value.

offerReplacePending

public String offerReplacePending()

Get the offerReplacePending property: The throughput replace is pending.

Returns:

the offerReplacePending value.

softAllowedMaximumThroughput

public String softAllowedMaximumThroughput()

Get the softAllowedMaximumThroughput property: The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified.

Returns:

the softAllowedMaximumThroughput value.

throughput

public Integer throughput()

Get the throughput property: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both.

Returns:

the throughput value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withAutoscaleSettings

public ThroughputSettingsResource withAutoscaleSettings(AutoscaleSettingsResource autoscaleSettings)

Set the autoscaleSettings property: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.

Parameters:

autoscaleSettings - the autoscaleSettings value to set.

Returns:

the ThroughputSettingsResource object itself.

withThroughput

public ThroughputSettingsResource withThroughput(Integer throughput)

Set the throughput property: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both.

Parameters:

throughput - the throughput value to set.

Returns:

the ThroughputSettingsResource object itself.