ThroughputSettingsGetPropertiesResource Class

Package:

com.azure.resourcemanager.cosmos.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-cosmos:2.46.0

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

public final class ThroughputSettingsGetPropertiesResource
extends ThroughputSettingsResource

The ThroughputSettingsGetPropertiesResource model.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
String	etag() Get the etag property: A system generated property representing the resource etag required for optimistic concurrency control.
static ThroughputSettingsGetPropertiesResource	fromJson(JsonReader jsonReader) Reads an instance of ThroughputSettingsGetPropertiesResource 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	rid() Get the rid property: A system generated property.
String	softAllowedMaximumThroughput() Get the softAllowedMaximumThroughput property: The maximum throughput value or the maximum maxThroughput value (for autoscale) that can be specified.
JsonWriter	toJson(JsonWriter jsonWriter)
Float	ts() Get the ts property: A system generated property that denotes the last updated timestamp of the resource.
void	validate() Validates the instance.
ThroughputSettingsGetPropertiesResource	withAutoscaleSettings(AutoscaleSettingsResource autoscaleSettings) Set the autoscaleSettings property: Cosmos DB resource for autoscale settings.
ThroughputSettingsGetPropertiesResource	withThroughput(Integer throughput) Set the throughput property: Value of the Cosmos DB resource throughput.

Methods inherited from ThroughputSettingsResource

autoscaleSettings fromJson instantMaximumThroughput minimumThroughput offerReplacePending softAllowedMaximumThroughput throughput toJson validate withAutoscaleSettings withThroughput

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

ThroughputSettingsGetPropertiesResource

public ThroughputSettingsGetPropertiesResource()

Creates an instance of ThroughputSettingsGetPropertiesResource class.

Method Details

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.

fromJson

public static ThroughputSettingsGetPropertiesResource fromJson(JsonReader jsonReader)

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.

instantMaximumThroughput

public String instantMaximumThroughput()

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

Overrides:

ThroughputSettingsGetPropertiesResource.instantMaximumThroughput()

Returns:

the instantMaximumThroughput value.

minimumThroughput

public String minimumThroughput()

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

Overrides:

ThroughputSettingsGetPropertiesResource.minimumThroughput()

Returns:

the minimumThroughput value.

offerReplacePending

public String offerReplacePending()

Get the offerReplacePending property: The throughput replace is pending.

Overrides:

ThroughputSettingsGetPropertiesResource.offerReplacePending()

Returns:

the offerReplacePending value.

rid

public String rid()

Get the rid property: A system generated property. A unique identifier.

Returns:

the rid 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:

ThroughputSettingsGetPropertiesResource.softAllowedMaximumThroughput()

Returns:

the softAllowedMaximumThroughput value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

ThroughputSettingsGetPropertiesResource.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

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.

validate

public void validate()

Validates the instance.

Overrides:

ThroughputSettingsGetPropertiesResource.validate()

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:

ThroughputSettingsGetPropertiesResource.withAutoscaleSettings(AutoscaleSettingsResource autoscaleSettings)

Parameters:

autoscaleSettings

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:

ThroughputSettingsGetPropertiesResource.withThroughput(Integer throughput)

Parameters:

throughput