Class ThroughputSettingsGetPropertiesResource

java.lang.Object
com.azure.resourcemanager.cosmos.models.ThroughputSettingsResource
com.azure.resourcemanager.cosmos.models.ThroughputSettingsGetPropertiesResource
All Implemented Interfaces:
com.azure.json.JsonSerializable<ThroughputSettingsResource>
public final class ThroughputSettingsGetPropertiesResource extends ThroughputSettingsResource
The ThroughputSettingsGetPropertiesResource model.

  • Constructor Details

    • ThroughputSettingsGetPropertiesResource

      public ThroughputSettingsGetPropertiesResource()
      Creates an instance of ThroughputSettingsGetPropertiesResource class.

  • Method Details

    • rid

      public String rid()
      Get the rid property: A system generated property. A unique identifier.
      Returns:
      the rid value.

    • ts

      public Float ts()
      Get the ts property: A system generated property that denotes the last updated timestamp of the resource.
      Returns:
      the ts value.

    • etag

      public String etag()
      Get the etag property: A system generated property representing the resource etag required for optimistic concurrency control.
      Returns:
      the etag value.

    • softAllowedMaximumThroughput

      public String softAllowedMaximumThroughput()
      Get the softAllowedMaximumThroughput property: The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified.
      Overrides:
      softAllowedMaximumThroughput in class ThroughputSettingsResource
      Returns:
      the softAllowedMaximumThroughput value.

    • instantMaximumThroughput

      public String instantMaximumThroughput()
      Get the instantMaximumThroughput property: The offer throughput value to instantly scale up without triggering splits.
      Overrides:
      instantMaximumThroughput in class ThroughputSettingsResource
      Returns:
      the instantMaximumThroughput value.

    • offerReplacePending

      public String offerReplacePending()
      Get the offerReplacePending property: The throughput replace is pending.
      Overrides:
      offerReplacePending in class ThroughputSettingsResource
      Returns:
      the offerReplacePending value.

    • minimumThroughput

      public String minimumThroughput()
      Get the minimumThroughput property: The minimum throughput of the resource.
      Overrides:
      minimumThroughput in class ThroughputSettingsResource
      Returns:
      the minimumThroughput value.

    • withThroughput

      public ThroughputSettingsGetPropertiesResource 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.
      Overrides:
      withThroughput in class ThroughputSettingsResource
      Parameters:
      throughput - the throughput value to set.
      Returns:
      the ThroughputSettingsResource object itself.

    • withAutoscaleSettings

      public ThroughputSettingsGetPropertiesResource withAutoscaleSettings(AutoscaleSettingsResource autoscaleSettings)
      Set the autoscaleSettings property: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.
      Overrides:
      withAutoscaleSettings in class ThroughputSettingsResource
      Parameters:
      autoscaleSettings - the autoscaleSettings value to set.
      Returns:
      the ThroughputSettingsResource object itself.

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class ThroughputSettingsResource
      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>
      Overrides:
      toJson in class ThroughputSettingsResource
      Throws:
      IOException

    • fromJson

      public static ThroughputSettingsGetPropertiesResource fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ThroughputSettingsGetPropertiesResource from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ThroughputSettingsGetPropertiesResource 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 ThroughputSettingsGetPropertiesResource.