com.microsoft.azure.cosmosdb

Class Offer

java.lang.Object

com.microsoft.azure.cosmosdb.JsonSerializable

com.microsoft.azure.cosmosdb.Resource

com.microsoft.azure.cosmosdb.Offer

public class Offer
extends Resource

Represents an offer in the Azure Cosmos DB database service.

Constructor Summary

Constructors

Constructor and Description
Offer(int offerThroughput) Initialize an new instance of the Offer object.
Offer(String jsonString) Initialize an offer object from json string.

Method Summary

Modifier and Type	Method and Description
String	getOfferResourceId() Sets the target resource id of a resource to which this offer applies.
String	getOfferType() Gets the OfferType for the resource offer.
String	getOfferVersion() Gets the version of the current offer.
String	getResourceLink() Gets the self-link of a resource to which the resource offer applies.
int	getThroughput() Gets the offer throughput for this offer.
void	setOfferType(String offerType) Sets the OfferType for the resource offer.
void	setOfferVersion(String offerVersion) Sets the offer version.
void	setThroughput(int throughput) Sets the offer throughput for this offer.

Methods inherited from class com.microsoft.azure.cosmosdb.Resource

getETag, getId, getResourceId, getSelfLink, getTimestamp, setId, setResourceId

Methods inherited from class com.microsoft.azure.cosmosdb.JsonSerializable

get, getBoolean, getCollection, getCollection, getDouble, getHashMap, getInt, getList, getLogger, getLong, getMapper, getObject, getObject, getObjectByPath, getString, has, remove, set, toJson, toJson, toObject, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Offer

public Offer(int offerThroughput)

Initialize an new instance of the Offer object.

Parameters:

offerThroughput - the throughput value for this offer.

Offer

public Offer(String jsonString)

Initialize an offer object from json string.

Parameters:

jsonString - the json string that represents the offer.

Method Detail

getResourceLink

public String getResourceLink()

Gets the self-link of a resource to which the resource offer applies.

Returns:

the resource link.

getOfferResourceId

public String getOfferResourceId()

Sets the target resource id of a resource to which this offer applies.

Returns:

the resource id.

getOfferType

public String getOfferType()

Gets the OfferType for the resource offer.

Returns:

the offer type.

setOfferType

public void setOfferType(String offerType)

Sets the OfferType for the resource offer.

Parameters:

offerType - the offer type.

getOfferVersion

public String getOfferVersion()

Gets the version of the current offer.

Returns:

the offer version.

setOfferVersion

public void setOfferVersion(String offerVersion)

Sets the offer version.

Parameters:

offerVersion - the version of the offer.

getThroughput

public int getThroughput()

Gets the offer throughput for this offer.

Returns:

the offer throughput.

setThroughput

public void setThroughput(int throughput)

Sets the offer throughput for this offer.

Parameters:

throughput - the throughput of this offer.