Package com.azure.cosmos.models

Class ThroughputProperties

java.lang.Object

com.azure.cosmos.models.ThroughputProperties

public class ThroughputProperties
extends Object

Represents throughput of the resources in the Azure Cosmos DB service.

Method Summary

Modifier and Type	Method	Description
static ThroughputProperties	createAutoscaledThroughput(int autoScaleMaxThroughput)	Create auto scaled provisioned throughput throughput properties.
static ThroughputProperties	createManualThroughput(int throughput)	Create fixed throughput properties.
int	getAutoscaleMaxThroughput()	Gets max auto-scale throughput.
String	getETag()	Get the entity tag associated with the resource.
String	getId()	Gets the name of the resource.
Integer	getManualThroughput()	Gets offer throughput.
Instant	getTimestamp()	Get the last modified timestamp associated with the resource.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

createManualThroughput

public static ThroughputProperties createManualThroughput(int throughput)

Create fixed throughput properties.

Parameters:

throughput - the throughput

Returns:

the throughput properties

createAutoscaledThroughput

public static ThroughputProperties createAutoscaledThroughput(int autoScaleMaxThroughput)

Create auto scaled provisioned throughput throughput properties.

Parameters:

autoScaleMaxThroughput - the max auto scale throughput

Returns:

the throughput properties

getManualThroughput

public Integer getManualThroughput()

Gets offer throughput.

Returns:

the offer throughput

getAutoscaleMaxThroughput

public int getAutoscaleMaxThroughput()

Gets max auto-scale throughput.

Returns:

the max auto-scale throughput

getId

public String getId()

Gets the name of the resource. This is only relevant when getting response from the server.

Returns:

the name of the resource.

getTimestamp

public Instant getTimestamp()

Get the last modified timestamp associated with the resource. This is only relevant when getting response from the server.

Returns:

the timestamp.

getETag

public String getETag()

Get the entity tag associated with the resource. This is only relevant when getting response from the server.

Returns:

the e tag.