Share via

Capacity Class

  • Reference
Package:
com.azure.resourcemanager.cosmos.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-cosmos:2.44.1
  • java.lang.Object
    • com.azure.resourcemanager.cosmos.models.Capacity

Implements

JsonSerializable<Capacity>

public final class Capacity
implements JsonSerializable<Capacity>

The object that represents all properties related to capacity enforcement on an account.

Constructor Summary

Constructor Description
Capacity()

Creates an instance of Capacity class.

Method Summary

Modifier and Type Method and Description
static Capacity fromJson(JsonReader jsonReader)

Reads an instance of Capacity from the JsonReader.
JsonWriter toJson(JsonWriter jsonWriter)
Integer totalThroughputLimit()

Get the totalThroughputLimit property: The total throughput limit imposed on the account.
void validate()

Validates the instance.
Capacity withTotalThroughputLimit(Integer totalThroughputLimit)

Set the totalThroughputLimit property: The total throughput limit imposed on the account.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

Capacity

public Capacity()

Creates an instance of Capacity class.

Method Details

fromJson

public static Capacity fromJson(JsonReader jsonReader)

Reads an instance of Capacity from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of Capacity 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 Capacity.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

totalThroughputLimit

public Integer totalThroughputLimit()

Get the totalThroughputLimit property: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.

Returns:

the totalThroughputLimit value.

validate

public void validate()

Validates the instance.

withTotalThroughputLimit

public Capacity withTotalThroughputLimit(Integer totalThroughputLimit)

Set the totalThroughputLimit property: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no limits on provisioning of throughput.

Parameters:

totalThroughputLimit - the totalThroughputLimit value to set.

Returns:

the Capacity object itself.

Applies to