Offer Class

  • Reference
Package:
com.microsoft.azure.cosmosdb

public class Offer extends Resource

Represents an offer in the Azure Cosmos DB database service.

Constructor Summary

Constructor 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.

Inherited Members

JsonSerializable.get(String propertyName) JsonSerializable.getBoolean(String propertyName) JsonSerializable.getCollection(String propertyName) JsonSerializable.getDouble(String propertyName) Resource.getETag() JsonSerializable.getHashMap() Resource.getId() JsonSerializable.getInt(String propertyName) JsonSerializable.getLogger() JsonSerializable.getLong(String propertyName) JsonSerializable.getMapper() JsonSerializable.getObject(String propertyName) JsonSerializable.getObjectByPath(List<String> propertyNames) Resource.getResourceId() Resource.getSelfLink() JsonSerializable.getString(String propertyName) Resource.getTimestamp() JsonSerializable.has(String propertyName) JsonSerializable.JsonSerializable() JsonSerializable.JsonSerializable(String jsonString, ObjectMapper objectMapper) JsonSerializable.JsonSerializable(String jsonString) JsonSerializable.remove(String propertyName) Resource.Resource(Resource resource) Resource.Resource() Resource.Resource(String jsonString, ObjectMapper objectMapper) Resource.Resource(String jsonString) Resource.setId(String id) Resource.setResourceId(String resourceId) JsonSerializable.toJson() JsonSerializable.toJson(SerializationFormattingPolicy formattingPolicy) JsonSerializable.toString()

Constructor Details

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 Details

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.

getOfferVersion

public String getOfferVersion()

Gets the version of the current offer.

Returns:

the offer version.

getResourceLink

public String getResourceLink()

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

Returns:

the resource link.

getThroughput

public int getThroughput()

Gets the offer throughput for this offer.

Returns:

the offer throughput.

setOfferType

public void setOfferType(String offerType)

Sets the OfferType for the resource offer.

Parameters:

offerType - the offer type.

setOfferVersion

public void setOfferVersion(String offerVersion)

Sets the offer version.

Parameters:

offerVersion - the version of the offer.

setThroughput

public void setThroughput(int throughput)

Sets the offer throughput for this offer.

Parameters:

throughput - the throughput of this offer.

Applies to