OfferV2 Class

  • Reference
Package:
com.microsoft.azure.documentdb
Maven Artifact:
com.microsoft.azure:azure-documentdb:2.4.7

public class OfferV2
extends Offer

Represents an offer version 2 in the Azure Cosmos DB database service.

Constructor Summary

Constructor Description
OfferV2(Offer otherOffer)

Initialize an new instance of the OfferV2 object, copy the base properties from another Offer object and set the throughput value.
OfferV2(int offerThroughput)

Initialize an new instance of the OfferV2 object.
OfferV2(int offerThroughput, boolean offerEnableRUPerMinuteThroughput)

Initialize an new instance of the OfferV2 object.

Method Summary

Modifier and Type Method and Description
boolean getOfferEnableRUPerMinuteThroughput()

Gets Request Units(RU)/Minute throughput is enabled/disabled for collection in the Azure Cosmos DB database service.
int getOfferThroughput()

Gets the offer throughput for this offer.
void setOfferEnableRUPerMinuteThroughput(boolean offerEnableRUPerMinuteThroughput)

Sets Request Units(RU)/Minute throughput enabled/disabled for collection in the Azure Cosmos DB database service.
void setOfferThroughput(int throughput)

Sets the offer throughput for this offer.

Methods inherited from JsonSerializable

<T>getCollection <T>getObject <T>set <T>toObject get getBoolean getCollection getDouble getHashMap getInt getLogger getLong getMapper getObject getObjectByPath getString has remove toJson toJson toString toString

Methods inherited from Offer

getContent getOfferResourceId getOfferType getOfferVersion getResourceLink setContent setOfferType setOfferVersion

Methods inherited from Resource

getETag getId getResourceId getSelfLink getTimestamp setId setResourceId

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

OfferV2

public OfferV2(Offer otherOffer)

Initialize an new instance of the OfferV2 object, copy the base properties from another Offer object and set the throughput value.

Parameters:

otherOffer - the Offer object whose base properties are to be copied.

OfferV2

public OfferV2(int offerThroughput)

Initialize an new instance of the OfferV2 object.

Parameters:

offerThroughput - the throughput value for this offer.

OfferV2

public OfferV2(int offerThroughput, boolean offerEnableRUPerMinuteThroughput)

Initialize an new instance of the OfferV2 object.

Parameters:

offerThroughput - the throughput value for this offer.
offerEnableRUPerMinuteThroughput - if RU Per Minute throughput is enabled

Method Details

getOfferEnableRUPerMinuteThroughput

public boolean getOfferEnableRUPerMinuteThroughput()

Gets Request Units(RU)/Minute throughput is enabled/disabled for collection in the Azure Cosmos DB database service.

Returns:

true if RUPerMin is enabled; otherwise false.

getOfferThroughput

public int getOfferThroughput()

Gets the offer throughput for this offer.

Returns:

the offer throughput.

setOfferEnableRUPerMinuteThroughput

public void setOfferEnableRUPerMinuteThroughput(boolean offerEnableRUPerMinuteThroughput)

Sets Request Units(RU)/Minute throughput enabled/disabled for collection in the Azure Cosmos DB database service.

Parameters:

offerEnableRUPerMinuteThroughput - used for enabling or disabling option.

setOfferThroughput

public void setOfferThroughput(int throughput)

Sets the offer throughput for this offer.

Parameters:

throughput - the throughput of this offer.

Applies to