Package com.azure.resourcemanager.cosmos.models

Class ThroughputSettingsResource

java.lang.Object
com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource
All Implemented Interfaces:
com.azure.json.JsonSerializable<ThroughputSettingsResource>
Direct Known Subclasses:
ThroughputSettingsGetPropertiesResource
public class ThroughputSettingsResource extends Object implements com.azure.json.JsonSerializable<ThroughputSettingsResource>
Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.

  • Constructor Details

    • ThroughputSettingsResource

      public ThroughputSettingsResource()
      Creates an instance of ThroughputSettingsResource class.

  • Method Details

    • 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.

    • 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.

    • 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.

    • 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.

    • 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.

    • instantMaximumThroughput

      public String instantMaximumThroughput()
      Get the instantMaximumThroughput property: The offer throughput value to instantly scale up without triggering splits.
      Returns:
      the instantMaximumThroughput 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.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ThroughputSettingsResource>
      Throws:
      IOException

    • fromJson

      public static ThroughputSettingsResource fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      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.